# 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.
AccumulatedResultsVerifierConfiguration
  Configure the frame accumulation process.
AddPageParams
AndroidShutterButton
ArcPainter
AspectRatio
  Aspect ratio is the ratio of the width to the height of an image or screen.
AUSCheck
  A check compatible with the Australian Paper Clearing System cheque standard
AUSCheckFieldNames
  Constants for the field type names of AUSCheck.
AutoReleasable
AutoReleasePool
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.
BarcodeItem
  A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
BarcodeScannerCamera
BarcodeScannerConfiguration
  Configuration for the barcode scanner.
BarcodeScannerResult
  The result of barcode scanning.
BaseCameraConfiguration
BasicImageLoadOptions
  Basic options for loading image.
Block
  Represents a single block, e.g. a paragraph. A block is made up of lines.
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.
BufferImageLoadOptions
  Options for loading image from buffer.
CANCheck
  A check format commonly used in Canada
CANCheckFieldNames
  Constants for the field type names of CANCheck.
CBufferImageLoadOptions
CEncodeImageOptions
Check
  Check Document
CheckFieldNames
  Constants for the field type names of Check.
CheckScannerConfiguration
  Configuration of the check scanner.
CheckScanningResult
  The result of check scanning.
CImageInfo
ColorDocumentFilter
  Color document filter. This filter is a good starting point for most use cases.
ContentValidator
  Base class for content validators.
ContourConfiguration
ContrastFilter
  Contrast adjustment filter.
CPathImageLoadOptions
CreateDocumentParams
CreatePDFArguments
CreatePDFResult
CreateTIFFResult
CRectangleInt
CreditCard
  Credit Card Document
CreditCardFieldNames
  Constants for the field type names of CreditCard.
CreditCardIntroCustomImage
  A custom image for the introduction screen.
CreditCardIntroOneSideImage
  The image for the introduction screen with one side of a credit card.
CreditCardIntroTwoSidesImage
  The image for the introduction screen with two sides of a credit card.
CreditCardNoImage
  No image for the introduction screen.
CreditCardScanGuidanceConfiguration
  Configuration of the hints guiding users through the credit card scanning process.
CreditCardScannerConfiguration
  Configuration for the credit card scanner.
CreditCardScannerGuidanceStates
  Configure the captions of the user guidance hints for different scanning states.
CreditCardScannerIntroImage
  The image for the introduction screen of a credit card scanner screen.
CreditCardScannerIntroScreenConfiguration
  Configuration of the introduction screen for the credit card scanner.
CreditCardScannerScreenConfiguration
  Configuration of the screen for detecting credit card data.
CreditCardScannerScreenTextLocalization
  Configuration of the all strings for credit card scanner screen.
CreditCardScannerUiResult
  Configuration of the credit card scanner RTU UI result.
CreditCardScanningProgressConfiguration
  Configuration of visualization of the scanning progress - indeterminate progress.
CreditCardScanningResult
  Contains the result of running the credit card scanner.
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.
CSaveImageOptions
CustomBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
DateValidationConfiguration
  Date validation configuration. This configuration element does not enable the scanning of any document types by itself. Add to recognizer configuration to require date validation checks for specific document types.
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
DeDriverLicenseBackCategoriesAM
  DeDriverLicenseBack.Categories.AM
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
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.
DefaultContentValidator
  Default content validator. Accepts only non-empty strings.
DeHealthInsuranceCardFront
  Front side of the German health insurance card (elektronische Gesundheitskarte). For the backside, see EuropeanHealthInsuranceCard.
DeHealthInsuranceCardFrontFieldNames
  Constants for the field type names of DeHealthInsuranceCardFront.
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 (Aufenthaltstitel), Back side
DeResidencePermitBackFieldNames
  Constants for the field type names of DeResidencePermitBack.
DeResidencePermitFront
  German Residence Permit (Aufenthaltstitel), Front side
DeResidencePermitFrontFieldNames
  Constants for the field type names of DeResidencePermitFront.
DetectDocumentResult
DialogButtonStyle
  Configuration for the dialogs/alerts OK button style.
DialogStyle
  Configuration for the dialog/alert style
DocumentCameraConfiguration
DocumentClassicScannerConfiguration
DocumentContourScanningResult
DocumentData
  Document Data.
DocumentDataExtractionResult
  Contains the result of running the generic document extractor.
DocumentDataExtractorCommonConfiguration
  Convenience configuration element for enabling the scanning of multiple document types with a common configuration. Add to extractor configuration to enable the scanning of multiple document types.
DocumentDataExtractorConfiguration
  Configuration for the document data extractor.
DocumentDataExtractorConfigurationElement
  Base class for all generic document configuration elements.
DocumentDataFrameExtractionParameters
  Parameters for the extraction process.
DocumentDetectionResult
  Result of the document contour detection.
DocumentDetectionScores
  The total and partial scores for the detected document contour.
DocumentExistsResult
DocumentFromLegacyPagesParams
DocumentQualityAnalyzerConfiguration
  Document Quality Analyzer configuration.
DocumentQualityAnalyzerResult
  Result of document quality analysis. It can be used to determine, e.g., if a document is good enough to be used for OCR processing.
DocumentQualityThreshold
  Point in the quality-number of symbols space to separate quality levels.
DocumentScannerAccessibilityConfiguration
  Document scanner accessibility configuration
DocumentScannerCamera
DocumentScannerConfiguration
  Configuration for the document scanner.
DocumentScannerParameters
  Parameters for the document scanner.
DocumentScannerScreenConfiguration
DocumentScanningResult
  Scanned document return class from document scanner rtu-ui component
EncodeImageOptions
  Options for encoding image.
EuropeanHealthInsuranceCard
  European Health Insurance Card (EHIC). Supports formats with both four and five lines of data.
EuropeanHealthInsuranceCardConfiguration
  European Health Insurance Card (EHIC) configuration element. Add to extractor configuration to scan EHICs.
EuropeanHealthInsuranceCardFieldNames
  Constants for the field type names of EuropeanHealthInsuranceCard.
EuropeanHealthInsuranceCardRecognitionResult
  The result of the health insurance card recognition.
EuropeanHealthInsuranceCardRecognitionResultField
  Health insurance card field.
EuropeanHealthInsuranceCardRecognizerConfiguration
  Configuration for the European health insurance card (EHIC) recognizer.
ExtractedImagesFromPdfResult
  Represents the result of extracting images from a PDF document. Contains a list of URLs pointing to the extracted image files.
ExtractImagesFromPdfParams
FadeOutView
Field
  Generic document field.
FieldParsedData
  Parsed data.
FieldType
  Generic Document 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.
FRACheck
  A check format commonly used in France
FRACheckFieldNames
  Constants for the field type names of FRACheck.
GenericDocument
  Generic document.
GenericDocumentType
  Generic Document Type.
GenericDocumentWrapper
Glyph
  Represents a single glyph, i.e. a character.
GrayscaleFilter
  Converts color images to grayscale and applies autocontrast.
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.
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.
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
  Configuration for the license plate scanner.
LicensePlateScannerResult
  The result of the license plate scanning.
Line
  Represents a single line. A line is made up of words.
LineSegmentFloat
  Represents a line segment in 2D space.
LineSegmentInt
  Represents a line segment in 2D space.
MedicalCertificate
  Medical Certificate
MedicalCertificateCameraConfiguration
MedicalCertificateCheckBox
  Structure to contain full information about found box.
MedicalCertificateClassicScannerConfiguration
MedicalCertificateDateRecord
  Structure to contain date record information.
MedicalCertificateFieldNames
  Constants for the field type names of MedicalCertificate.
MedicalCertificatePatientInfoBox
  Patient information box.
MedicalCertificatePatientInfoField
  Patient information field.
MedicalCertificateScannerCamera
MedicalCertificateScanningParameters
  Parameters for the medical certificate scanning. The scanner supports Form 1 (Arbeitsunfähigkeitsbescheinigung) and Form 21a (Ärztliche Bescheinigung für den Bezug von Krankengeld bei Erkrankung eines Kindes) from the KBV (Kassenärztliche Bundesvereinigung) list of forms.
MedicalCertificateScanningResult
  The result of the medical certificate scanning.
ModifyPageParams
MovePageParams
MRZ
  MRZ part of the document
MrzFallbackConfiguration
  MRZ fallback configuration element. This configuration element does not enable the scanning of any document types by itself. Add to extractor configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported. Note that this may enable scanning of documents that were not enabled through the accepted document types.
MRZFieldNames
  Constants for the field type names of MRZ.
MrzFinderLayoutPreset
  Source of the text for the MRZ finder example overlay.
MrzIntroCustomImage
  A custom image for the introduction screen.
MrzIntroDefaultImage
  No image for the introduction screen.
MrzIntroNoImage
  No image for the introduction screen.
MrzScannerConfiguration
  Configuration for MRZ scanner.
MrzScannerIntroImage
  Determines the image for the introduction screen.
MrzScannerIntroScreenConfiguration
  Configuration of the introduction screen for the MRZ scanner.
MrzScannerResult
  Container for result of MRZ scanning attempt.
MrzScannerScreenConfiguration
  Configuration of the screen for detecting MRZ (Machine-readable zones) of various documents.
MrzScannerScreenTextLocalization
  Configuration of the all strings for MRZ scanner screen.
MrzScannerUiResult
  Configuration of the MRZ RTU UI result.
NoLayoutPreset
  No layout preset.
OcrElement
  Base class for units of text, e.g. glyphs, words, lines, blocks, pages.
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
PageData
  The result of the health insurance card recognition.
PagesOcrResult
  OCR action result
ParametricFilter
  Base class for all parametric filters.
PathImageLoadOptions
  Options for loading image from path.
PatternContentValidator
  Pattern content validator.
PdfAttributes
  PDF attributes.
PdfConfiguration
  The parameters `pageSize`, `pageFit`, `dpi` and `resamplingMethod` interact in a complex way when adding bitmap images (JPEG, PNG, or raw) to the PDF. There are three cases to consider:
PDFFromDocumentParams
PerformOCRArguments
PerformOCRResult
PolygonPoint
RawImageLoadOptions
  Options for loading images that come from sensor.
Rect
RefCountedObjectProfile
  Profile info of a reference-counted stored object.
RemovePageParams
RemovePagesByIdsParams
Result
  Parent result class for ready-to-use UI components return data
ResultAccumulationConfiguration
  Configuration for how to accumulate results.
ResultWrapper<T>
SaveImageOptions
  Options for saving image to a path.
SBDImageResult
ScanbotBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
ScanbotCamera
ScanbotCameraWidgetState
ScanbotColor
ScanbotCroppingWidget
ScanbotDocument
ScanbotEncryptionHandler
ScanbotImageOperations
  Provides methods for working with images.
ScanbotImageRecognitionOperations
  Provides image recognition functionalities like MRZ scanning, health card recognition, etc.
ScanbotSdk
  Main class to access the Scanbot SDK functionalities.
ScanbotSdkConfig
  Scanbot SDK initialization config parameters.
SdkLicenseStatus
  Scanbot SDK license status.
SdkOcrConfig
  SDK OCR configs
SelectionOverlayScannerConfiguration
  Barcode Selection Overlay configuration
SEPA
  SEPA
SEPAFieldNames
  Constants for the field type names of SEPA.
ShutterAnimation
ShutterButton
Size
  Standard size object
StoredDocumentIDsResult
SwissQR
  SwissQR
SwissQRFieldNames
  Constants for the field type names of SwissQR.
SymbolBox
  Structure containing recognized symbol text and bounds.
TextFieldWrapper
  Text field wrapper
TextPatternIntroAlphabeticField
  The image for the introduction screen featuring an alphabetic text field.
TextPatternIntroCustomImage
  A custom image for the introduction screen.
TextPatternIntroGeneralField
  The image for the introduction screen featuring a general text field.
TextPatternIntroMeterDevice
  The image for the introduction screen featuring an electricity meter.
TextPatternIntroNoImage
  No image for the introduction screen.
TextPatternIntroShippingContainer
  The image for the introduction screen showing a text on a shipping container.
TextPatternScannerConfiguration
  Configuration for the text pattern scanner.
TextPatternScannerIntroImage
  The image for the introduction screen of a generic text scanner screen.
TextPatternScannerIntroScreenConfiguration
  Configuration of the introduction screen for the generic text scanner.
TextPatternScannerResult
  The result of the text line recognition.
TextPatternScannerScreenConfiguration
  Configuration of the screen for detecting generic text data.
TextPatternScannerScreenTextLocalization
  Configuration of the all strings for generic text scanner screen.
TextPatternScannerUiResult
  Configuration of the generic text scanner RTU UI result.
ThreeLineMrzFinderLayoutPreset
  A ready-to-use preset 3-line text to be displayed.
TIFFFromDocumentParams
TiffGeneratorParameters
  TIFF generator parameters.
ToJsonConfiguration
  Configuration used to serialize an object to json.
TwoLineMrzFinderLayoutPreset
  A ready-to-use preset 2-line text to be displayed.
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.
UserField
  User-defined TIFF field.
UserFieldDoubleValue
  Double value (TIFF_DOUBLE).
UserFieldIntValue
  32-bit int value (TIFF_LONG).
UserFieldStringValue
  ASCII string value (TIFF_ASCII).
UserFieldValue
  User-defined TIFF field value.
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
VinBarcodeResult
  Result of the barcode scanner.
VinScannerResult
  Result of the VIN scanner.
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.
Word
  Represents a single word. A word is made up of glyphs.
WordBox
  Structure containing recognized word text and bounds.
WriteTIFFArguments
WriteTIFFResult
ZoomRange
  Defines a range for zooming

## 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.
BarcodeDocumentModelRootType
BarcodeFormat
  Enumerates barcode formats.
BarcodeOverlayTextFormat
  Barcode scanner engine mode
BarcodeScannerEngineMode
  The engine mode for barcode scanning.
Binarization
  Binarization behavior to apply when adding pages to a TIFF.
BinarizationFilterPreset
  Preset of parameters for custom binarization filter.
BlurEffect
  The blur effect style. iOS only.
BufferLoadMode
  Image Ref Buffer Load Mode.
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.
CheckDocumentDetectionMode
  Check document detection and extraction mode.
CheckDocumentModelRootType
CheckMagneticInkStripScanningStatus
  Check magnetic ink (MICR) strip scanning status.
CommonFieldType
  Common field types.
CompressionMode
  TIFF compression type.
ConfirmationMethod
  Method used to confirm a result.
CreditCardDocumentModelRootType
CreditCardScanningMode
  The scanning mode.
CreditCardScanningStatus
  The status of the scanning process.
DetectorType
DocumentDataExtractionMode
  The extraction mode.
DocumentDataExtractionStatus
  The status of the extraction process.
DocumentDetectionStatus
  Status of the document detection.
DocumentQuality
  Result of document quality analysis.
DocumentScannerEngineMode
  Engines for document scanning.
DocumentsModelRootType
EncodingFormat
  Image Encoding Format.
EncryptionMode
  Encryption/Decryption mode to be used when an image is loaded/saved.
EuropeanHealthInsuranceCardIssuingCountry
  European Health Insurance Card (EHIC) issuing country.
EuropeanHealthInsuranceCardRecognitionResultFieldType
  Health insurance card field type.
EuropeanHealthInsuranceCardRecognitionResultFieldValidationStatus
  Health insurance card field validation status.
EuropeanHealthInsuranceCardRecognitionResultRecognitionStatus
  Card recognition status.
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/
ImageFilterType
  The image filter types.
ImageFormat
ImageRotation
  Image rotation.
ImageSourceType
  The type of source which originated the underlying image.
LicensePlateScannerStrategy
  Type of the scanner internally to scan the license plate.
LicenseStatus
MedicalCertificateCheckBoxType
  Type of the checkbox.
MedicalCertificateDateRecordType
  Type of a date record.
MedicalCertificateFormType
  Type of the medical certificate form.
MedicalCertificatePatientInfoFieldType
  Type of a field in the patient info box.
MrzDocumentType
  Type of document containing the MRZ.
MrzIncompleteResultHandling
  Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
MrzScanningMode
  The scanning mode.
MsiPlesseyChecksumAlgorithm
  Checksum algorithm for MSI_PLESSEY.
OcrEngine
  The modes of the optical character recognition engine.
OperationStatus
OrientationLockMode
  Applied interface orientation
OutputMode
  Output mode of binarization filter.
PageDirection
  Page direction.
PageFit
  Page fit.
PageImageSource
  The source of an image.
PageRotation
PageSize
  Page size.
PathLoadMode
  Image Ref Path Load Mode.
PatternGrammar
  Grammar of pattern matching.
ResamplingMethod
  Resampling method.
UpcEanExtensionBehavior
  Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
VinBarcodeExtractionStatus
  Status of the barcode extraction.

## 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

## Constants

contourDetectorTypeMap → const Map<DocumentScannerEngineMode, String>
imageFormatMap → const Map<ImageFormat, String>

## Functions

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

## Typedefs

AcquireSerializedReference = bool Function(Pointer<Utf8> uuid)
AcquireSerializedReferenceNative = Bool Function(Pointer<Utf8> uuid)
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)
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)