MLKitBarcodeScanning Framework Reference

  • This documentation outlines the globally available classes for barcode scanning using ML Kit.

  • These classes provide structured representations of various barcode data types, such as addresses, calendar events, and contact information.

  • The BarcodeScanner class facilitates the scanning process, while BarcodeScannerOptions allows for customization.

  • Each class offers properties and methods for accessing and manipulating the extracted barcode data.

  • Developers can utilize these classes to seamlessly integrate barcode scanning functionalities into their applications.

Classes

The following classes are available globally.

  • An address.

    Declaration

    Swift

    class BarcodeAddress : NSObject
  • A calendar event extracted from a QR code.

    Declaration

    Swift

    class BarcodeCalendarEvent : NSObject
  • A driver’s license or ID card data representation.

    An ANSI driver’s license contains more fields than are represented by this class. The Barcode‘s rawValue property can be used to access the other fields.

    Declaration

    Swift

    class BarcodeDriverLicense : NSObject
  • An email message from a ‘MAILTO:’ or similar QR Code type.

    Declaration

    Swift

    class BarcodeEmail : NSObject
  • GPS coordinates from a GEO: or similar QR Code type data.

    Declaration

    Swift

    class BarcodeGeoPoint : NSObject
  • A person’s name, both formatted as individual name components.

    Declaration

    Swift

    class BarcodePersonName : NSObject
  • A phone number from a TEL: or similar QR Code type.

    Declaration

    Swift

    class BarcodePhone : NSObject
  • An SMS message from an SMS: or similar QR Code type.

    Declaration

    Swift

    class BarcodeSMS : NSObject
  • A URL and title from a ‘MEBKM:’ or similar QR Code type.

    Declaration

    Swift

    class BarcodeURLBookmark : NSObject
  • Wi-Fi network parameters from a WIFI: or similar QR Code type.

    Declaration

    Swift

    class BarcodeWifi : NSObject
  • A person’s or organization’s business card. This may come from different underlying formats including VCARD and MECARD.

    This object represents a simplified view of possible business cards. If you require lossless access to the information in the barcode, you should parse the raw data yourself. To access the raw data, use the Barcode‘s rawValue property.

    Declaration

    Swift

    class BarcodeContactInfo : NSObject
  • A barcode in an image.

    Declaration

    Swift

    class Barcode : NSObject
  • A barcode scanner that scans barcodes in an image.

    Declaration

    Swift

    class BarcodeScanner : NSObject
  • Options for specifying a barcode scanner.

    Declaration

    Swift

    class BarcodeScannerOptions : NSObject