MLKitBarcodeScanning Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Classes
The following classes are available globally.
-
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
-
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003eThis documentation outlines the globally available classes for barcode scanning using ML Kit.\u003c/p\u003e\n"],["\u003cp\u003eThese classes provide structured representations of various barcode data types, such as addresses, calendar events, and contact information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eBarcodeScanner\u003c/code\u003e class facilitates the scanning process, while \u003ccode\u003eBarcodeScannerOptions\u003c/code\u003e allows for customization.\u003c/p\u003e\n"],["\u003cp\u003eEach class offers properties and methods for accessing and manipulating the extracted barcode data.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize these classes to seamlessly integrate barcode scanning functionalities into their applications.\u003c/p\u003e\n"]]],[],null,["# MLKitBarcodeScanning Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [BarcodeAddress](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeAddress)\n\n `\n ` \n An address. \n\n #### Declaration\n\n Swift \n\n class BarcodeAddress : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeCalendarEvent](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeCalendarEvent)\n\n `\n ` \n A calendar event extracted from a QR code. \n\n #### Declaration\n\n Swift \n\n class BarcodeCalendarEvent : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeDriverLicense](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeDriverLicense)\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](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/Barcode)'s\n `rawValue` property can be used to access the other fields. \n\n #### Declaration\n\n Swift \n\n class BarcodeDriverLicense : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeEmail](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeEmail)\n\n `\n ` \n An email message from a 'MAILTO:' or similar QR Code type. \n\n #### Declaration\n\n Swift \n\n class BarcodeEmail : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeGeoPoint](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeGeoPoint)\n\n `\n ` \n GPS coordinates from a `GEO:` or similar QR Code type data. \n\n #### Declaration\n\n Swift \n\n class BarcodeGeoPoint : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodePersonName](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodePersonName)\n\n `\n ` \n A person's name, both formatted as individual name components. \n\n #### Declaration\n\n Swift \n\n class BarcodePersonName : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodePhone](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodePhone)\n\n `\n ` \n A phone number from a `TEL:` or similar QR Code type. \n\n #### Declaration\n\n Swift \n\n class BarcodePhone : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeSMS](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeSMS)\n\n `\n ` \n An SMS message from an `SMS:` or similar QR Code type. \n\n #### Declaration\n\n Swift \n\n class BarcodeSMS : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeURLBookmark](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeURLBookmark)\n\n `\n ` \n A URL and title from a 'MEBKM:' or similar QR Code type. \n\n #### Declaration\n\n Swift \n\n class BarcodeURLBookmark : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeWifi](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeWifi)\n\n `\n ` \n Wi-Fi network parameters from a `WIFI:` or similar QR Code type. \n\n #### Declaration\n\n Swift \n\n class BarcodeWifi : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeContactInfo](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeContactInfo)\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](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/Barcode)'s `rawValue` property. \n\n #### Declaration\n\n Swift \n\n class BarcodeContactInfo : NSObject\n\n- `\n ``\n ``\n `\n\n ### [Barcode](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/Barcode)\n\n `\n ` \n A barcode in an image. \n\n #### Declaration\n\n Swift \n\n class Barcode : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeScanner](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeScanner)\n\n `\n ` \n A barcode scanner that scans barcodes in an image. \n\n #### Declaration\n\n Swift \n\n class BarcodeScanner : NSObject\n\n- `\n ``\n ``\n `\n\n ### [BarcodeScannerOptions](/ml-kit/reference/swift/mlkitbarcodescanning/api/reference/Classes/BarcodeScannerOptions)\n\n `\n ` \n Options for specifying a barcode scanner. \n\n #### Declaration\n\n Swift \n\n class BarcodeScannerOptions : NSObject"]]
