scanbot_barcode_sdk library

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.
AndroidShutterButton
ArcPainter
AspectRatio
Finder aspect ratio
BarcodeAdditionalParameters
A class that contains additional parameters for barcodes detection and filtering.
BarcodeCameraConfiguration
BarcodeClassicScannerConfiguration
BarcodeFormattedData
BarcodeItem
BarcodeScannerCamera
BarcodeScannerConfiguration
BarcodeScannerJsonConfiguration
BarcodeScanningResult
BatchBarcodeScannerConfiguration
BatchBarcodeScannerJsonConfiguration
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.
CameraConfiguration
ConfirmationDialogConfiguration
Confirmation Dialog configuration
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.
DetectBarcodeFromImageParams
DialogButtonStyle
Configuration for the dialogs/alerts OK button style.
DialogStyle
Configuration for the dialog/alert style
FadeOutView
Field
Document field
FieldType
Field type
FieldWrapper
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)
FinderView
FlutterLicense
Font
The font name and size. iOS only.
GenericDocument
A generic document. Contains fields and sub-documents.
GenericDocumentNormalizedType
Field 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.
IDCardPDF417
ID Card
IDCardPDF417FieldNames
Constants for the field type names of IDCardPDF417.
Insets
IosShutterButton
MedicalCertificate
Medical Certificate
MedicalCertificateFieldNames
Constants for the field type names of MedicalCertificate.
MultiImageBarcodeScanningResult
Class created for handling the multiple images barcodes detection
OcrResult
Result of OCR text recognition.
Page
The Scanbot SDK provides a ready-to-use UI for document scanning and cropping. Both components use the notion of a 'page' as a data model for the scanning and cropping activities.
PolygonPoint
PredefinedBarcodes
Rect
Result
Parent result class for ready-to-use UI components return data
ResultWrapper<T>
ScanbotBarcodeSdk
ScanbotCamera
ScanbotCameraWidgetState
ScanbotColor
ScanbotEncryptionHandler
ScanbotSdkConfig
Scanbot SDK initialization config parameters.
SdkLicenseException
SdkLicenseStatus
Scanbot SDK license status.
SelectionOverlayConfiguration
Barcode Selection Overlay configuration
SelectionOverlayScannerConfiguration
Barcode Selection Overlay configuration
SEPA
SEPA
SEPAFieldNames
Constants for the field type names of SEPA.
SharedCalls
ShutterAnimation
ShutterButton
Size
Standard size object
SwissQR
SwissQR
SwissQRFieldNames
Constants for the field type names of SwissQR.
TextFieldWrapper
Text field wrapper
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
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
ZoomRange
Defines a range for zooming

Enums

AustraliaPostCustomerFormat
The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62.
BarcodeDialogFormat
The barcode text format dialog.
BarcodeDocumentFormat
Barcode document format
BarcodeFormat
Barcode document format
BarcodeImageGenerationType
Defines the possible barcode image sources.
BarcodeOverlayTextFormat
Barcode scanner engine mode
BarcodesExtensionFilter
A filter for extended EAN and UPC barcodes.
BlurEffect
The blur effect style. iOS only.
CameraModule
Camera module to use
CameraPreviewMode
Represents camera preview modes
CapturePhotoQualityPrioritization
The prioritization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0. iOS only.
CommonFieldType
Common field types
DetectionStatus
Document detection status
DetectorType
DocumentDetectorMode
Mode for document detection.
EngineMode
Barcode scanner engine mode
FileEncryptionMode
Gs1HandlingMode
GS1 handling mode
ImageFilterType
The image filter types.
ImageFormat
MSIPlesseyChecksumAlgorithm
MSI plessey checksum algorithm
OcrEngine
The page orientation of the pdf document.
OperationResult
Standard result status
OperationStatus
OrientationLockMode
Applied interface orientation
PageDirection
The page orientation of the pdf document.
PageSize
The page size of the pdf document.
SdkFeature
Status
ValidationStatus
Barcode document format

Extensions

GenericDocumentExtension on GenericDocument
Extension function to GenericDocument to make it easier to access fields.
ImageFilterTypeExtension on ImageFilterType
The ImageFilterTypeExtension extension for the ImageFilterType enumeration adds the typeIndex property, which returns a numerical index for each image filter type, corresponding to the values defined in the native code.
KotlinFunctionsForObject on T
OperationStatusExtension on OperationStatus

Typedefs

BarcodeDataFormatter = Future<BarcodeFormattedData> Function(BarcodeItem barcodeItem)
DocumentSnapTrigger = dynamic Function()
Handler = Future Function(MethodCall call)
OnFinderRectChange = dynamic Function(double left, double top, double right, double bottom)