# scanbot_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
AUSCheck
  A check compatible with the Australian Paper Clearing System cheque standard
AUSCheckFieldNames
  Constants for the field type names of AUSCheck.
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.
BrightnessFilter
  Brightness adjustment filter.
CameraConfiguration
CANCheck
  A check format commonly used in Canada
CANCheckFieldNames
  Constants for the field type names of CANCheck.
Check
  Check Document
CheckFieldNames
  Constants for the field type names of Check.
CheckRecognizerJsonConfiguration
CheckScannerConfiguration
  Vin rtu-ui scanner configuration class
CheckScanResult
  Result of license plate scanning
CheckUserGuidanceStrings
  Configuration that helps to override default hint values.
ColorDocumentFilter
  Color document filter. This filter is a good starting point for most use cases.
ConfirmationDialogConfiguration
  Confirmation Dialog configuration
ContourConfiguration
ContrastFilter
  Contrast adjustment filter.
CroppingController
CroppingPolygon
  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.
CroppingResult
  Result class that return cropped page from crop rtu-ui component
CroppingScreenConfiguration
  Cropping rtu-ui component configuration class
CustomBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
DateRecord
  Structure to contain date record information
DeDriverLicenseBack
  German driver license (Führerschein), back side
DeDriverLicenseBackCategories
  Categories table row container
DeDriverLicenseBackCategoriesA
  DeDriverLicenseBack.Categories.A
DeDriverLicenseBackCategoriesA1
  DeDriverLicenseBack.Categories.A1
DeDriverLicenseBackCategoriesA2
  DeDriverLicenseBack.Categories.A2
DeDriverLicenseBackCategoriesB
  DeDriverLicenseBack.Categories.B
DeDriverLicenseBackCategoriesB1
  DeDriverLicenseBack.Categories.B1
DeDriverLicenseBackCategoriesBE
  DeDriverLicenseBack.Categories.BE
DeDriverLicenseBackCategoriesC
  DeDriverLicenseBack.Categories.C
DeDriverLicenseBackCategoriesC1
  DeDriverLicenseBack.Categories.C1
DeDriverLicenseBackCategoriesC1E
  DeDriverLicenseBack.Categories.C1E
DeDriverLicenseBackCategoriesCE
  DeDriverLicenseBack.Categories.CE
DeDriverLicenseBackCategoriesD
  DeDriverLicenseBack.Categories.D
DeDriverLicenseBackCategoriesD1
  DeDriverLicenseBack.Categories.D1
DeDriverLicenseBackCategoriesD1E
  DeDriverLicenseBack.Categories.D1E
DeDriverLicenseBackCategoriesDE
  DeDriverLicenseBack.Categories.DE
DeDriverLicenseBackCategoriesL
  DeDriverLicenseBack.Categories.L
DeDriverLicenseBackCategoriesM
  DeDriverLicenseBack.Categories.M
DeDriverLicenseBackCategoriesT
  DeDriverLicenseBack.Categories.T
DeDriverLicenseBackCategory
  A category row from the categories table
DeDriverLicenseBackCategoryFieldNames
  Constants for the field type names of DeDriverLicenseBack.Category.
DeDriverLicenseBackFieldNames
  Constants for the field type names of DeDriverLicenseBack.
DeDriverLicenseFront
  German driver license (Führerschein), front side
DeDriverLicenseFrontFieldNames
  Constants for the field type names of DeDriverLicenseFront.
DeIdCardBack
  German ID card, back side
DeIdCardBackFieldNames
  Constants for the field type names of DeIdCardBack.
DeIdCardFront
  German ID card, front side
DeIdCardFrontFieldNames
  Constants for the field type names of DeIdCardFront.
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.
DePassport
  German travel passport (Reisepass)
DePassportFieldNames
  Constants for the field type names of DePassport.
DeResidencePermitBack
  German Residence Permit, Back side
DeResidencePermitBackFieldNames
  Constants for the field type names of DeResidencePermitBack.
DeResidencePermitFront
  German Residence Permit, Front side
DeResidencePermitFrontFieldNames
  Constants for the field type names of DeResidencePermitFront.
DetectBarcodeFromImageParams
DialogButtonStyle
  Configuration for the dialogs/alerts OK button style.
DialogStyle
  Configuration for the dialog/alert style
DocumentCameraConfiguration
DocumentClassicScannerConfiguration
DocumentContourScanningResult
DocumentQualityResult
  A class that contains result for document quality analyze
DocumentScannerAccessibilityConfiguration
  Document scanner accessibility configuration
DocumentScannerCamera
DocumentScannerConfiguration
  Document scanner configuration class. All UI configuration options are optional.
DocumentScannerJsonConfiguration
DocumentScanningResult
  Scanned document return class from document scanner rtu-ui component
DocumentsDisplayConfiguration
  The field display configuration object.
EncryptionParameters
FadeOutView
Field
  Document field
FieldsDisplayConfiguration
  Field display configuration object.
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)
FinderDocumentScannerConfiguration
  Finder Document scanner configuration class. All UI configuration options are optional.
FinderDocumentScanningResult
  Representing the result of a document scanning operation using the rtu-ui component.
FinderView
FlutterLicense
Font
  The font name and size. iOS only.
FRACheck
  A check format commonly used in France
FRACheckFieldNames
  Constants for the field type names of FRACheck.
GenericDocument
  A generic document. Contains fields and sub-documents.
GenericDocumentNormalizedType
  Field type
GenericDocumentRecognizerConfiguration
  Generic Document Recognizer class. All UI configuration options are optional.
GenericDocumentRecognizerJsonConfiguration
GenericDocumentRecognizerResult
GenericDocumentResults
GenericDocumentWrapper
GrayscaleFilter
  Converts color images to grayscale and applies autocontrast.
GS1
  GS1
GS1Element
  GS1 Element
GS1ElementFieldNames
  Constants for the field type names of GS1.Element.
HealthInsuranceCardField
  Class that describes health insurance one scanned field
HealthInsuranceCardRecognitionResult
  This class describes health insurance rtu-ui component scanned result
HealthInsuranceCardScannerJsonConfiguration
HealthInsuranceScannerConfiguration
  Health insurance rtu-ui scanner configuration class
IDCardPDF417
  ID Card
IDCardPDF417FieldNames
  Constants for the field type names of IDCardPDF417.
INDCheck
  A check compatible with the CTS-2010 standard issued by the Reserve Bank of India in 2012
INDCheckFieldNames
  Constants for the field type names of INDCheck.
Insets
IosShutterButton
ISRCheck
  A check format commonly used in Israel
ISRCheckFieldNames
  Constants for the field type names of ISRCheck.
KWTCheck
  A check format commonly used in Kuwait
KWTCheckFieldNames
  Constants for the field type names of KWTCheck.
LegacyFilter
  Deprecated image filters.
LicensePlateScannerConfiguration
  License plate rtu-ui scanner configuration class
LicensePlateScannerJsonConfiguration
LicensePlateScanResult
  Result of license plate scanning
MedicalCertificate
  Medical Certificate
MedicalCertificateCameraConfiguration
MedicalCertificateCheckBox
  Structure to contain full information about found box
MedicalCertificateClassicScannerConfiguration
MedicalCertificateFieldNames
  Constants for the field type names of MedicalCertificate.
MedicalCertificatePatientInfoBox
  Structure to contain full information about found box
MedicalCertificatePatientInfoField
  Represents an item of the patient info
MedicalCertificateRecognizerJsonConfiguration
MedicalCertificateResult
MedicalCertificateScannerCamera
MedicalCertificateScannerConfiguration
  Vin rtu-ui scanner configuration class
MedicalCertificateUserGuidanceStrings
  Configuration for the hint values
MRZ
  MRZ part of the document
MRZFieldNames
  Constants for the field type names of MRZ.
MrzGenericScanningResult
MrzScannerConfiguration
  This class describes machine readable zone rtu-ui component configuration
MrzScanningResult
  This class describes machine readable zone rtu-ui component scanned result
MultiImageBarcodeScanningResult
  Class created for handling the multiple images barcodes detection
OcrOptions
  OCR options
OcrPage
  Represents OCR result of a scanned Page document image.
OcrResult
  Result of OCR text recognition.
OcrResultBlock
  An OCR result block represents a recognized paragraph, a line or a word. It contains the recognized plain text, the bounding box and a confidence value.
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.
PageAspectRatio
PagesOcrResult
  OCR action result
ParametricFilter
  Base class for all parametric filters.
PdfAttributes
  The PDF file attributes.
PdfRenderingOptions
PolygonPoint
PredefinedBarcodes
PredefinedCompressionTypes
Rect
Result
  Parent result class for ready-to-use UI components return data
ResultWrapper<T>
  Parent result class for ready-to-use UI components return data
ScanbotBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
ScanbotCamera
ScanbotColor
ScanbotCroppingWidget
ScanbotEncryptionHandler
ScanbotSdk
ScanbotSdkConfig
  Scanbot SDK initialization config parameters.
ScanbotSdkRecognizeOperations
ScanbotSdkUi
SdkLicenseException
SdkLicenseStatus
  Scanbot SDK license status.
SdkOcrConfig
  SDK OCR configs
SelectionOverlayConfiguration
  Barcode Selection Overlay configuration
SelectionOverlayScannerConfiguration
  Barcode Selection Overlay configuration
SEPA
  SEPA
SEPAFieldNames
  Constants for the field type names of SEPA.
ShutterAnimation
ShutterButton
Size
  Standard size object
SwissQR
  SwissQR
SwissQRFieldNames
  Constants for the field type names of SwissQR.
TextDataScannerConfiguration
  Vin rtu-ui scanner configuration class
TextDataScannerJsonConfiguration
TextDataScannerStep
  Configuration for the scanned item
TextDataScanResult
  Result of license plate scanning
TextDataScanResultField
  Class that describes health insurance one scanned field
TextFieldWrapper
  Text field wrapper
TiffCreationOptions
  TIFF creation options
UAECheck
  A check format commonly used in the United Arab Emirates
UAECheckFieldNames
  Constants for the field type names of UAECheck.
UnknownCheck
  A check that doesn't conform to any supported standard
USACheck
  A check compatible with the ASC X9 standard used in the USA
USACheckFieldNames
  Constants for the field type names of USACheck.
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
VinScannerConfiguration
  Vin rtu-ui scanner configuration class
VinScannerJsonConfiguration
VinScanResult
  Result of license plate scanning
WhiteBlackPointFilter
  Maps image value channel so that all the pixels darker than the black point are set to 0, all the pixels brighter than the white point are set to 255, and the pixels in between are linearly scaled.
ZoomRange
  Defines a range for zooming

## Enums

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.
BinarizationFilterPreset
  Preset of parameters for custom binarization filter.
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.
CheckRecognitionResultStatus
CheckStandard
  Supported check standards.
CodeDensity
  The expected density of QR codes in an image.
CommonFieldType
  Common field types
DateRecordType
  Type of a date record
DetectionStatus
  Document detection status
DetectorType
DocumentDetectorMode
  Mode for document detection.
DocumentQuality
  The document quality status that comes from DocumentQualityAnalyzer
EngineMode
  Barcode scanner engine mode
FieldDisplayState
  Field display state in the RTU UI.
FileEncryptionMode
GenericDocumentRecognitionStatus
GenericDocumentType
  Supported document types.
Gs1HandlingMode
  GS1 handling mode
HealthInsuranceCardDetectionStatus
HealthInsuranceCardFieldType
ImageFilterType
  The image filter types.
ImageFormat
LegacyBinarizationFilter
LicensePlateScanStrategy
  Detector mode, classic (OCR based) or ML (machine learning based) approach.
McFormType
  Form type of the Medical certificate
MedicalCertificateCheckBoxType
  Box detailed subtype
MedicalCertificatePatientInfoFieldType
  Type of the item of the patient info field
MrzDocumentType
MSIPlesseyChecksumAlgorithm
  MSI plessey checksum algorithm
OcrEngine
  The page orientation of the pdf document.
OperationResult
  Standard result status
OrientationLockMode
  Applied interface orientation
OutputMode
  Output mode of binarization filter.
PageDirection
  The page orientation of the pdf document.
PageFitMode
PageSize
  The page size of the pdf document.
SdkFeature
Status
TiffCompression
ValidationStatus
  Barcode document format

## Extensions

BinarizationFilterExtension on LegacyBinarizationFilter
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

## Constants

allBarcodeTypes → const List<BarcodeFormat>
allDocumentFormatTypes → const List<BarcodeDocumentFormat>
contourDetectorTypeMap → const Map<DocumentDetectorMode, String>
imageFormatMap → const Map<ImageFormat, String>
oneDimensionalBarcodes → const List<BarcodeFormat>
twoDimensionalBarcodes → const List<BarcodeFormat>
  Return list of two dimensional barcode formats

## Functions

colorFromString(String? color) → Color?
dateFromString(String? string) → DateTime?
encodeByteListToBase64(List byteList) → String
fileUriToString(Uri? uri) → String?
imageFilterJsonValue(ImageFilterType filter) → 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

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