scanbot_barcode_sdk library Scanbot Barcode SDK

A comprehensive library for accessing Scanbot Barcode SDK functionalities.

This library provides high-level APIs for initializing the Scanbot SDK, starting the barcode scanner UI, detecting barcodes from images, and managing license and storage operations.

It aggregates functionality from multiple internal components, including barcode scanner configurations, UI customization, and result processing.

Classes

AAMVA: AAMVA
AAMVADLID: Driver License Or ID Document
AAMVADLIDFieldNames: Constants for the field type names of AAMVA.DLID.
AAMVADriverLicense: Driver License. File type "DL".
AAMVAEnhancedDriverLicense: Enhanced Driver License. File type "EN".
AAMVAFieldNames: Constants for the field type names of AAMVA.
AAMVAIDCard: ID Card. File type "ID".
AAMVAMotorCarrierData: Motor Carrier Data. File type "MC".
AAMVAMotorCarrierDataFieldNames: Constants for the field type names of AAMVA.MotorCarrierData.
AAMVARawDocument: The raw document as was parsed from the barcode. The original field key names and field values as they appear in the barcode are left as-is. The mnemonic field keys from the AAMVA specification are not replaced with human-readable names. No field value normalization, like ISO 8601 date reformatting, etc., is done.
AAMVARegistrantAndVehicleData: Registrant And Vehicle Data. File type "IR".
AAMVARegistrantAndVehicleDataFieldNames: Constants for the field type names of AAMVA.RegistrantAndVehicleData.
AAMVARegistrationData: Registration Data. File type "RG".
AAMVARegistrationDataFieldNames: Constants for the field type names of AAMVA.RegistrationData.
AAMVATitleData: Title Data. File type "TD".
AAMVATitleDataFieldNames: Constants for the field type names of AAMVA.TitleData.
AAMVAVehicleData: Vehicle Data. File type "VH".
AAMVAVehicleDataFieldNames: Constants for the field type names of AAMVA.VehicleData.
AAMVAVehicleOwnerData: Vehicle Owner Data. File type "OW".
AAMVAVehicleOwnerDataFieldNames: Constants for the field type names of AAMVA.VehicleOwnerData.
AAMVAVehicleSafetyInspectionData: Vehicle Safety Inspection Data. File type "VS".
AAMVAVehicleSafetyInspectionDataFieldNames: Constants for the field type names of AAMVA.VehicleSafetyInspectionData.
ActionBarConfiguration: Configuration of the buttons available in the action bar.
AndroidShutterButton
ArcPainter
ArOverlayFindAndPickConfiguration: Configuration of the AR overlay.
ArOverlayGeneralConfiguration: Configuration of the AR overlay displayed on top of barcodes in the camera preview.
ArOverlayPolygonConfiguration: Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
AspectRatio: Aspect ratio is the ratio of the width to the height of an image or screen.
AutoReleasable
AutoReleasePool
BackgroundStyle: Configuration of the background appearance for buttons and hints.
BadgedButton: Configuration of the button with a badge.
BadgeStyle: Configuration of the badge.
BarButtonConfiguration: Configuration of the button located on a bar.
BarcodeCameraConfiguration
BarcodeClassicScannerConfiguration
BarcodeDocumentFormats: Barcode document formats.
BarcodeFormatAustraliaPostConfiguration: Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.
BarcodeFormatAztecConfiguration: Aztec configuration. Add to scanner configuration to scan Aztec codes.
BarcodeFormatCodabarConfiguration: Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.
BarcodeFormatCode11Configuration: Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.
BarcodeFormatCode128Configuration: Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.
BarcodeFormatCode2Of5Configuration: Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.
BarcodeFormatCode39Configuration: Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.
BarcodeFormatCode93Configuration: Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.
BarcodeFormatCommonConfiguration: Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.
BarcodeFormatCommonFourStateConfiguration: Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state codes.
BarcodeFormatCommonOneDConfiguration: Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.
BarcodeFormatCommonTwoDConfiguration: Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.
BarcodeFormatConfigurationBase: Base class for all barcode configurations.
BarcodeFormatDataBarConfiguration: GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.
BarcodeFormatDataBarExpandedConfiguration: GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.
BarcodeFormatDataBarLimitedConfiguration: GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.
BarcodeFormatDataMatrixConfiguration: DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.
BarcodeFormatFourStateConfigurationBase: Base class for all four-state barcode configurations.
BarcodeFormatGs1CompositeConfiguration: GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes.
BarcodeFormatItfConfiguration: ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.
BarcodeFormatJapanPostConfiguration: Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.
BarcodeFormatMaxiCodeConfiguration: MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.
BarcodeFormatMicroPdf417Configuration: MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.
BarcodeFormatMsiPlesseyConfiguration: MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.
BarcodeFormatOneDConfigurationBase: Base class for all linear (1D) barcode configurations.
BarcodeFormatPdf417Configuration: PDF417 configuration. Add to scanner configuration to scan PDF417 codes.
BarcodeFormatPharmaCodeConfiguration: PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.
BarcodeFormatPharmaCodeTwoTrackConfiguration: PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.
BarcodeFormatQrCodeConfiguration: QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.
BarcodeFormatRoyalMailConfiguration: Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.
BarcodeFormatRoyalTntPostConfiguration: Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.
BarcodeFormats: Lists of barcode formats to decode.
BarcodeFormatTwoDConfigurationBase: Base class for all 2D barcode configurations.
BarcodeFormatUpcEanConfiguration: UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.
BarcodeFormatUspsIntelligentMailConfiguration: USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.
BarcodeInfoMapping: Configuration of the barcode data mapping.
BarcodeItem: A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
BarcodeItemConfiguration: Configuration of the barcode info box displayed in the camera preview.
BarcodeItemErrorState: Configuration of the mapper's error dialog.
BarcodeMappedData: Format of the mapped barcode data.
BarcodeScannerCamera
BarcodeScannerConfiguration: Configuration for the barcode scanner.
BarcodeScannerResult: The result of barcode scanning.
BarcodeScannerScreenConfiguration: Configuration of the barcode scanner screen.
BarcodeScannerUiItem: Data about the scanned barcode.
BarcodeScannerUiResult: Results of the barcode scan.
BarcodeTextLocalization: Configuration of the all strings for barcode scanner.
BarcodeUseCase: Configuration of the barcode scanner screen's behavior.
BaseCameraConfiguration
BaseViewFinderConfiguration: Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.
BasicImageLoadOptions: Basic options for loading image.
BoardingPass: Boarding Pass
BoardingPassFieldNames: Constants for the field type names of BoardingPass.
BoardingPassLeg: Leg of the journey
BoardingPassLegFieldNames: Constants for the field type names of BoardingPass.Leg.
BufferImageLoadOptions: Options for loading image from buffer.
ButtonConfiguration: Configuration of the button.
CameraConfiguration: Configuration of the camera settings to be used while scanning.
CameraPermissionScreen: Configuration of the camera permission request view.
CBufferImageLoadOptions
CEncodeImageOptions
CImageInfo
CommonBarcodeScannerConfiguration: Configuration of the scanning behavior.
CPathImageLoadOptions
CRectangleInt
CSaveImageOptions
DEMedicalPlan: Medical Plan
DEMedicalPlanDoctor: Doctor
DEMedicalPlanDoctorFieldNames: Constants for the field type names of DEMedicalPlan.Doctor.
DEMedicalPlanFieldNames: Constants for the field type names of DEMedicalPlan.
DEMedicalPlanPatient: Patient
DEMedicalPlanPatientFieldNames: Constants for the field type names of DEMedicalPlan.Patient.
DEMedicalPlanSubheading: Subheading
DEMedicalPlanSubheadingFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.
DEMedicalPlanSubheadingMedicine: Medicine
DEMedicalPlanSubheadingMedicineFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Medicine.
DEMedicalPlanSubheadingMedicineSubstance: Substance
DEMedicalPlanSubheadingMedicineSubstanceFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Medicine.Substance.
DEMedicalPlanSubheadingPrescription: Prescription
DEMedicalPlanSubheadingPrescriptionFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Prescription.
EdgeInsets: Represents the insets of a rectangle.
EncodeImageOptions: Options for encoding image.
ExpectedBarcode: Configuration of the barcode to find and scan.
ExtractImagesFromPdfParams
FadeOutView
Field: Generic document field.
FieldParsedData: Parsed data.
FieldType: Generic Document Type.
FieldWrapper
FindAndPickArOverlayPolygonConfiguration: Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
FindAndPickBadgeConfiguration: Configuration of the round badge on find and pick ar layer.
FindAndPickScanningMode: Configuration of the Find and Pick barcode scanning mode.
FinderConfiguration: The finder view is a rectangular overlay view that clips the camera view, so that the detection will focus just a specific area. You can specify the size and positioning, as well as other UI properties. Set this property to true if you want to use the Finder View, false otherwise (default: false)
FinderCorneredStyle: A variant of the viewfinder displaying only the four corners of the scanning area.
FinderStrokedStyle: A variant of the viewfinder displaying a full outline of the scanning area.
FinderStyle: The visual appearance of the viewfinder.
FinderView
FlutterLicense
ForegroundStyle: Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).
GenericDocument: Generic document.
GenericDocumentType: Generic Document Type.
GenericDocumentWrapper
GS1: GS1
GS1Element: GS1 Element
GS1ElementFieldNames: Constants for the field type names of GS1.Element.
GS1ElementValidationError: Validation Errors
GS1ElementValidationErrorFieldNames: Constants for the field type names of GS1.Element.ValidationError.
HIBC: HIBC
HIBCFieldNames: Constants for the field type names of HIBC.
IconButton: Configuration of the icon appearance on a button.
IconStyle: Configuration of the icon appearance.
IconUserGuidanceConfiguration: Configuration of the hint (containing an icon) guiding users through the scanning process.
IDCardPDF417: ID Card
IDCardPDF417FieldNames: Constants for the field type names of IDCardPDF417.
ImageInfo: Image Info.
ImageProfile: ImageRef profile part specific to image information.
ImageRef
ImageRefPoolSnapshot: Snapshot of all alive ImageRefs.
ImageRefPoolSnapshotsDiff: difference between two snapshots.
ImageRefProfile: ImageRef profile which provides detailed information about stored object.
ImageSource: Description of source from which the ImageRef was created.
Insets
IosShutterButton
LineSegmentFloat: Represents a line segment in 2D space.
LineSegmentInt: Represents a line segment in 2D space.
ManualCountEditDialog: Configuration of the dialog to manually edit the barcode count.
MedicalCertificate: Medical Certificate
MedicalCertificateFieldNames: Constants for the field type names of MedicalCertificate.
MultipleScanningMode: Configuration of the mode for scanning multiple barcodes.
OcrResult: Result of OCR text recognition.
Palette: Value palette describing the colors of the scanner screens.
PathImageLoadOptions: Options for loading image from path.
PermanentViewFinderConfiguration: Configuration of the scanning interface’s viewfinder, which is always visible to guide the user.
PolygonStyle: Configuration of the polygon appearance.
PopupMenuItem: Configuration for the popup menu items.
RawImageLoadOptions: Options for loading images that come from sensor.
RefCountedObjectProfile: Profile info of a reference-counted stored object.
ResultWrapper<T>
RoundButton: Configuration of the round button.
SaveImageOptions: Options for saving image to a path.
ScanbotAlertDialog: Configuration of the standard alert dialog.
ScanbotBarcodeSdk: Entry point for interacting with the Scanbot Barcode SDK.
ScanbotCamera
ScanbotCameraWidgetState
ScanbotColor
ScanbotSdkConfig: Scanbot SDK initialization config parameters.
ScanCompletionOverlay: Configuration of the overlay to be shown after the successful scan.
SdkLicenseStatus
SelectionOverlayScannerConfiguration: Barcode Selection Overlay configuration
SEPA: SEPA
SEPAFieldNames: Constants for the field type names of SEPA.
SharedCalls
Sheet: Configuration of the preview mode for scanning multiple barcodes.
SheetContent: Configuration of the list containing the barcodes that have already been scanned.
ShutterAnimation
ShutterButton
SingleScanningMode: Configuration of the single barcode scanning mode.
Sound: Configuration for the sound.
StyledText: Configuration of the text field appearance.
SwipeToDelete: Configuration of the swipe-to-delete button.
SwissQR: SwissQR
SwissQRFieldNames: Constants for the field type names of SwissQR.
TextFieldWrapper: Text field wrapper
Timeouts: Configuration of timeouts.
ToJsonConfiguration: Configuration used to serialize an object to json.
TopBarConfiguration: Configuration of the top bar's appearance.
UserGuidanceConfiguration: Configuration of the hint guiding users through the scanning process.
ValidatedTextFieldWrapper: Text field wrapper
VCard: VCard
VCardAnniversary: Anniversary
VCardBirthday: Birthday
VCardBusyTimeURL: Busy Time URL
VCardCalendarURI: Calendar URI
VCardCalendarURIForRequests: Calendar URI For Requests
VCardCategories: Categories
VCardClientPIDMap: Client PID Map
VCardCustom: Custom
VCardDeliveryAddress: Delivery Address
VCardEmail: Email
VCardEntry: VCard Entry
VCardEntryFieldNames: Constants for the field type names of VCard.Entry.
VCardFirstName: First Name
VCardGender: Gender
VCardGeoLocation: Geo Location
VCardIMPP: IMPP
VCardKind: Kind
VCardLanguages: Languages
VCardLogo: Logo
VCardMember: Member
VCardName: Name
VCardNickname: Nickname
VCardNote: Note
VCardOrganisation: Organisation
VCardPhoto: Photo
VCardProductId: ProductId
VCardPublicKey: Public Key
VCardRelated: Related
VCardRevision: Revision
VCardRole: Role
VCardSound: Sound
VCardSource: Source
VCardTelephoneNumber: Telephone Number
VCardTimeZone: Time Zone
VCardTitle: Title
VCardUID: UID
VCardURL: URL
VCardVersion: Version
VCardXML: XML
Vibration: Configure the vibration.
ViewFinderConfiguration: Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.
ZoomRange

Enums

AustraliaPostCustomerFormat: Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
BarcodeDocumentFormat: Type of barcode document format used.
BarcodeFormat: Enumerates barcode formats.
BarcodeItemInfoPosition: Where to display the barcode info box in the camera preview.
BarcodeOverlayTextFormat
BarcodeScannerEngineMode: The engine mode for barcode scanning.
BufferLoadMode: Image Ref Buffer Load Mode.
CameraModule: Determines which camera module to use on start-up.
CameraPreviewMode: Configuration of the camera preview mode.
CollapsedVisibleHeight: Configuration of the barcodes result sheet's height while collapsed.
CommonFieldType: Common field types.
DetectorType
EncodingFormat: Image Encoding Format.
EncryptionMode: Encryption/Decryption mode to be used when an image is loaded/saved.
FieldDataFormat: Type of parsing applied to field.
FieldValidationStatus: Field validation status.
FileEncryptionMode
Gs1Handling: GS1 message handling options. The GS1 standard defines a key-value format for business-centric data that can be encoded into many 1D and 2D barcode types. https://ref.gs1.org/standards/genspecs/
ImageFormat
ImageRotation: Image rotation.
ImageSourceType: The type of source which originated the underlying image.
LicenseStatus
MsiPlesseyChecksumAlgorithm: Checksum algorithm for MSI_PLESSEY.
MultipleBarcodesScanningMode: Configuration of the mode used for scanning multiple barcodes.
NavigationBarMode: The visual mode used for the navigation bar icons. Android only.
OperationStatus
OrientationLockMode: Configure the orientation of the interface.
PathLoadMode: Image Ref Path Load Mode.
SheetMode: Configuration of the barcode result sheet's default visibility state.
SoundType: Determines the successful detection sound.
StatusBarMode: The visual mode used for the status bar icons.
TopBarMode: The visual mode used for the top bar.
UpcEanExtensionBehavior: Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.

Extensions

GenericDocumentExtension on GenericDocument: Extension function to GenericDocument to make it easier to access fields.
KotlinFunctionsForObject on T
OperationStatusExtension on OperationStatus

Constants

contourDetectorTypeMap → const Map<BarcodeScannerEngineMode, String>
scanbot_library_name → const String

Functions

autorelease<R>(R computation()) → R
colorFromString(String? color) → Color?
dateFromInt(int? millis) → DateTime?
dateFromString(String? string) → DateTime?
encodeByteListToBase64(List byteList) → String
fileUriToString(Uri? uri) → String?
licenses() → Stream<LicenseEntry>
stringToFileUri(String? string) → Uri?
toArgbString(Color? color) → String?
toColorString(Color? color) → String?
toRgbaString(Color? color) → String?
uintListFromString(String string) → Uint8List

Typedefs

AcquireSerializedReference = bool Function(Pointer<Utf8> uuid)
AcquireSerializedReferenceNative = Bool Function(Pointer<Utf8> uuid)
BarcodeItemMapper = dynamic Function(BarcodeItem barcodeItem, dynamic onResult(BarcodeMappedData), dynamic onError())
BufferData = Pointer<Uint8> Function(Pointer<Opaque> buffer)
BufferDataNative = Pointer<Uint8> Function(Pointer<Opaque> buffer)
BufferSize = int Function(Pointer<Opaque> buffer)
BufferSizeNative = Int Function(Pointer<Opaque> buffer)
Clear = void Function(Pointer<Utf8> uuid)
ClearNative = Void Function(Pointer<Utf8> uuid)
Clone = Pointer<Utf8> Function(Pointer<Utf8> uuid)
CloneNative = Pointer<Utf8> Function(Pointer<Utf8> uuid)
CreateFromEncodedBuffer = Pointer<Utf8> Function(Pointer<Uint8> data, int size, Pointer<CBufferImageLoadOptions> options)
CreateFromEncodedBufferNative = Pointer<Utf8> Function(Pointer<Uint8> data, Int size, Pointer<CBufferImageLoadOptions> options)
CreateFromPath = Pointer<Utf8> Function(Pointer<Utf8> path, Pointer<CPathImageLoadOptions> options)
CreateFromPathNative = Pointer<Utf8> Function(Pointer<Utf8> path, Pointer<CPathImageLoadOptions> options)
DocumentSnapTrigger = dynamic Function()
EncodeImage = Pointer<Opaque> Function(Pointer<Utf8> uuid, Pointer<CEncodeImageOptions> options)
EncodeImageNative = Pointer<Opaque> Function(Pointer<Utf8> uuid, Pointer<CEncodeImageOptions> options)
FreeBuffer = void Function(Pointer<Opaque> buffer)
FreeBufferNative = Void Function(Pointer<Opaque> buffer)
FreeString = void Function(Pointer<Utf8> str)
FreeStringNative = Void Function(Pointer<Utf8> str)
Handler = Future Function(MethodCall call)
Hibernate = void Function(Pointer<Utf8> uuid)
HibernateNative = Void Function(Pointer<Utf8> uuid)
Info = CImageInfo Function(Pointer<Utf8> uuid)
InfoNative = CImageInfo Function(Pointer<Utf8> uuid)
OnFinderRectChange = dynamic Function(double left, double top, double right, double bottom)
ReleaseAllImages = void Function()
ReleaseAllImagesNative = Void Function()
ReleaseStrongReference = bool Function(Pointer<Utf8> uuid)
ReleaseStrongReferenceNative = Bool Function(Pointer<Utf8> uuid)
SaveImage = bool Function(Pointer<Utf8> uuid, Pointer<Utf8> path, Pointer<CSaveImageOptions> options)
SaveImageNative = Bool Function(Pointer<Utf8> uuid, Pointer<Utf8> path, Pointer<CSaveImageOptions> options)
UpgradeSerializedReference = bool Function(Pointer<Utf8> uuid)
UpgradeSerializedReferenceNative = Bool Function(Pointer<Utf8> uuid)