MLKitBarcodeScanning Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Classes
The following classes are available globally.
-
Declaration
Objective-C
@interface MLKBarcodeAddress : NSObject
-
A calendar event extracted from a QR code.
Declaration
Objective-C
@interface MLKBarcodeCalendarEvent : 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
Objective-C
@interface MLKBarcodeDriverLicense : NSObject
-
An email message from a ‘MAILTO:’ or similar QR Code type.
Declaration
Objective-C
@interface MLKBarcodeEmail : NSObject
-
GPS coordinates from a GEO: or similar QR Code type data.
Declaration
Objective-C
@interface MLKBarcodeGeoPoint : NSObject
-
A person’s name, both formatted as individual name components.
Declaration
Objective-C
@interface MLKBarcodePersonName : NSObject
-
A phone number from a TEL: or similar QR Code type.
Declaration
Objective-C
@interface MLKBarcodePhone : NSObject
-
An SMS message from an SMS: or similar QR Code type.
Declaration
Objective-C
@interface MLKBarcodeSMS : NSObject
-
A URL and title from a ‘MEBKM:’ or similar QR Code type.
Declaration
Objective-C
@interface MLKBarcodeURLBookmark : NSObject
-
Wi-Fi network parameters from a WIFI: or similar QR Code type.
Declaration
Objective-C
@interface MLKBarcodeWiFi : 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
Objective-C
@interface MLKBarcodeContactInfo : NSObject
-
Declaration
Objective-C
@interface MLKBarcode : NSObject
-
A barcode scanner that scans barcodes in an image.
Declaration
Objective-C
@interface MLKBarcodeScanner : NSObject
-
Options for specifying a barcode scanner.
Declaration
Objective-C
@interface MLKBarcodeScannerOptions : NSObject
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[null,null,["Last updated 2024-07-10 UTC."],[[["\u003cp\u003eThis documentation details classes for barcode scanning functionalities within ML Kit.\u003c/p\u003e\n"],["\u003cp\u003eThe classes provide representations for various barcode data types like addresses, calendar events, contact information, driver's licenses, emails, geographic locations, and more.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eMLKBarcodeScanner\u003c/code\u003e and \u003ccode\u003eMLKBarcodeScannerOptions\u003c/code\u003e are used for the barcode scanning process itself, while other classes represent the extracted data.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can access both a simplified view of the barcode information and the raw barcode data using these classes.\u003c/p\u003e\n"],["\u003cp\u003eThese classes are part of the ML Kit Barcode Scanning API for iOS, offering tools for developers to integrate barcode scanning features into their applications.\u003c/p\u003e\n"]]],["The provided content outlines various classes for barcode-related data in Objective-C. These classes include: `MLKBarcodeAddress`, `MLKBarcodeCalendarEvent`, `MLKBarcodeDriverLicense`, `MLKBarcodeEmail`, `MLKBarcodeGeoPoint`, `MLKBarcodePersonName`, `MLKBarcodePhone`, `MLKBarcodeSMS`, `MLKBarcodeURLBookmark`, `MLKBarcodeWiFi`, and `MLKBarcodeContactInfo` and each of those represents specific data types such as addresses, calendar events, licenses, emails, GPS coordinates, names, phone numbers, SMS messages, URLs, Wi-Fi details, or contact info. There are also classes for a general barcode: `MLKBarcode`, for a scanner: `MLKBarcodeScanner` and `MLKBarcodeScannerOptions`.\n"],null,["# MLKitBarcodeScanning Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeAddress](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeAddress)\n\n `\n ` \n An address. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeAddress : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeCalendarEvent](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeCalendarEvent)\n\n `\n ` \n A calendar event extracted from a QR code. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeCalendarEvent : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeDriverLicense](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeDriverLicense)\n\n `\n ` \n A driver's license or ID card data representation.\n\n An ANSI driver's license contains more fields than are represented by this class. The `Barcode`'s\n `rawValue` property can be used to access the other fields. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeDriverLicense : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeEmail](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeEmail)\n\n `\n ` \n An email message from a 'MAILTO:' or similar QR Code type. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeEmail : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeGeoPoint](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeGeoPoint)\n\n `\n ` \n GPS coordinates from a `GEO:` or similar QR Code type data. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeGeoPoint : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodePersonName](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodePersonName)\n\n `\n ` \n A person's name, both formatted as individual name components. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodePersonName : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodePhone](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodePhone)\n\n `\n ` \n A phone number from a `TEL:` or similar QR Code type. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodePhone : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeSMS](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeSMS)\n\n `\n ` \n An SMS message from an `SMS:` or similar QR Code type. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeSMS : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeURLBookmark](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeURLBookmark)\n\n `\n ` \n A URL and title from a 'MEBKM:' or similar QR Code type. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeURLBookmark : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeWiFi](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeWiFi)\n\n `\n ` \n Wi-Fi network parameters from a `WIFI:` or similar QR Code type. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeWiFi : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeContactInfo](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeContactInfo)\n\n `\n ` \n A person's or organization's business card. This may come from different underlying formats\n including `VCARD` and `MECARD`.\n\n This object represents a simplified view of possible business cards. If you require lossless\n access to the information in the barcode, you should parse the raw data yourself. To access the\n raw data, use the `Barcode`'s `rawValue` property. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeContactInfo : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcode](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcode)\n\n `\n ` \n A barcode in an image. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcode : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeScanner](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeScanner)\n\n `\n ` \n A barcode scanner that scans barcodes in an image. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeScanner : NSObject\n\n- `\n ``\n ``\n `\n\n ### [MLKBarcodeScannerOptions](/ml-kit/reference/ios/mlkitbarcodescanning/api/reference/Classes/MLKBarcodeScannerOptions)\n\n `\n ` \n Options for specifying a barcode scanner. \n\n #### Declaration\n\n Objective-C \n\n\n @interface MLKBarcodeScannerOptions : NSObject"]]
