# scanbot_sdk_ui_v2 library

## Classes

AccumulatedResultsVerifierConfiguration
  Configure the frame accumulation process.
AcknowledgementBottomBar
  Configuration of the bottom bar for the acknowledgement screen.
AcknowledgementScreenConfiguration
  Configuration of the acknowledgement screen.
ActionBarConfiguration
  Configuration of the buttons available in the action bar.
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.
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.
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.
BaseViewFinderConfiguration
  Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.
BasicImageLoadOptions
  Basic options for loading image.
Block
  Represents a single block, e.g. a paragraph. A block is made up of lines.
BrightnessFilter
  Brightness adjustment filter.
BufferImageLoadOptions
  Options for loading image from buffer.
ButtonConfiguration
  Configuration of the button.
CameraBottomBar
  Configuration of the bottom bar for the camera screen.
CameraConfiguration
  Configuration of the camera settings to be used while scanning.
CameraPermissionScreen
  Configuration of the camera permission request view.
CameraScreenConfiguration
  Configuration of the screen for scanning the pages with the camera.
CaptureFeedback
  Configuration of the feedback shown after snapping a page.
CBufferImageLoadOptions
CEncodeImageOptions
CheckIntroImage
  The image for the introduction screen with a check template.
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.
CommonBarcodeScannerConfiguration
  Configuration of the scanning behavior.
ContentValidator
  Base class for content validators.
ContrastFilter
  Contrast adjustment filter.
CPathImageLoadOptions
CRectangleInt
CreditCardIntroCustomImage
  A custom image for the introduction screen.
CreditCardIntroImage
  The image for the introduction screen with a credit card template.
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.
CroppingAppearanceConfiguration
  Configuration of the general appearance for the cropping screen.
CroppingBottomBar
  Configuration of the bottom bar for the cropping screen.
CroppingConfiguration
  Configuration of the standalone cropping screen.
CroppingResult
  Configuration of the cropping result.
CroppingScreenConfiguration
  Configuration of the screen for cropping the scanned pages.
CroppingTextLocalization
  Configuration of all the strings for the standalone cropping screen.
CSaveImageOptions
CustomBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
CustomImage
  A custom image for the introduction screen.
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.
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.
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.
DocumentFlowAppearanceConfiguration
  Configuration of the general appearance.
DocumentIntroImage
  The image for the introduction screen with a document template.
DocumentPolygonConfiguration
  Configuration of the document contour detection polygon.
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.
DocumentScannerCameraConfiguration
  Configuration of the camera behavior.
DocumentScannerConfiguration
  Configuration for the document scanner.
DocumentScannerOutputSettings
  Configuration of the output settings.
DocumentScannerParameters
  Parameters for the document scanner.
DocumentScannerScreens
  Configuration of the document scanner sub-screens.
DocumentScannerTextLocalization
  Configuration of all the strings for the standalone cropping screen.
DocumentScannerUserGuidance
  Configuration of the hints guiding users through the scanning process.
DocumentScanningFlow
  Configuration of the document scanner screen.
EdgeInsets
  Represents the insets of a rectangle.
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.
ExpectedBarcode
  Configuration of the barcode to find and scan.
Field
  Generic document field.
FieldParsedData
  Parsed data.
FieldType
  Generic Document Type.
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.
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.
ForegroundStyle
  Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).
GenericDocument
  Generic document.
GenericDocumentType
  Generic Document Type.
Glyph
  Represents a single glyph, i.e. a character.
GrayscaleFilter
  Converts color images to grayscale and applies autocontrast.
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.
IdCardIntroImage
  The image for the introduction screen with an ID card template.
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.
IntroductionScreenConfiguration
  Configuration of the introduction screen for the document scanner.
IntroImage
  Determines the image for the introduction screen.
IntroListEntry
  An entry in the list of scanning steps of the introduction screen.
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.
ManualCountEditDialog
  Configuration of the dialog to manually edit the barcode count.
MedicalCertificateCheckBox
  Structure to contain full information about found box.
MedicalCertificateDateRecord
  Structure to contain date record information.
MedicalCertificateIntroImage
  The image for the introduction screen with a medical certificate template.
MedicalCertificatePatientInfoBox
  Patient information box.
MedicalCertificatePatientInfoField
  Patient information field.
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.
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.
MultipleScanningMode
  Configuration of the mode for scanning multiple barcodes.
NoButtonMode
  Configuration of the 'preview' button in 'no button mode'.
NoIntroImage
  No image for the introduction screen.
NoLayoutPreset
  No layout preset.
OcrElement
  Base class for units of text, e.g. glyphs, words, lines, blocks, pages.
OcrResult
  Result of OCR text recognition.
Page
  Represents result of performing OCR on an image. A page is made up of blocks.
PagePreviewMode
  Configuration of the 'preview' button in 'page preview mode'.
PageSnapCheckMarkAnimation
  Configuration of the check mark animation.
PageSnapFeedbackMode
  The type of animation to display after snapping a page.
PageSnapFeedbackNone
  To not use a snap animation.
PageSnapFunnelAnimation
  Configuration of the funnel animation.
Palette
  Value palette describing the colors of the scanner screens.
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:
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.
PreviewButton
  Configuration of the 'preview' button.
RawImageLoadOptions
  Options for loading images that come from sensor.
ReceiptsIntroImage
  The image for the introduction screen with a receipt template.
RefCountedObjectProfile
  Profile info of a reference-counted stored object.
ReorderPagesScreenConfiguration
  Configuration of the screen for reordering the scanned pages.
ResultAccumulationConfiguration
  Configuration for how to accumulate results.
ResultWrapper<T>
ReviewBottomBarConfiguration
  Configuration of the bottom bar for the review screen.
ReviewMorePopupMenu
  Configuration of the 'more' popup menu for the review screen.
ReviewScreenConfiguration
  Configuration of the screen for reviewing the scanned pages.
RoundButton
  Configuration of the round button.
SaveImageOptions
  Options for saving image to a path.
ScanAssistanceOverlay
  Configuration of the scan assistance overlay.
ScanbotAlertDialog
  Configuration of the standard alert dialog.
ScanbotBinarizationFilter
  Automatic binarization filter. This filter is a good starting point for most use cases.
ScanbotColor
ScanbotSdkUiV2
  A utility class providing methods to launch Ready-to-Use V2 UI components of the Scanbot SDK.
ScanCompletionOverlay
  Configuration of the overlay to be shown after the successful scan.
Sheet
  Configuration of the preview mode for scanning multiple barcodes.
SheetContent
  Configuration of the list containing the barcodes that have already been scanned.
ShutterButton
  Configuration of the 'shutter' button.
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.
SymbolBox
  Structure containing recognized symbol text and bounds.
TextButtonMode
  Configuration of the 'preview' button in 'text button mode'.
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.
TiffGeneratorParameters
  TIFF generator parameters.
Timeouts
  Configuration of timeouts.
ToJsonConfiguration
  Configuration used to serialize an object to json.
TopBarConfiguration
  Configuration of the top bar's appearance.
TwoLineMrzFinderLayoutPreset
  A ready-to-use preset 2-line text to be displayed.
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.
UserGuidanceConfiguration
  Configuration of the hint guiding users through the scanning process.
UserGuidanceStates
  Configure the titles of the user guidance hints for different states.
Vibration
  Configure the vibration.
ViewFinderConfiguration
  Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.
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.
ZoomOverlay
  Configuration of the zoom overlay for the review screen.

## Enums

AcknowledgementMode
  Determines, after each page is snapped, whether the acknowledgment screen should be displayed or not.
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.
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.
BufferLoadMode
  Image Ref Buffer Load Mode.
CameraModule
  Determines which camera module to use on start-up.
CameraPreviewMode
  Configuration of the camera preview mode.
CapturePhotoQualityPrioritization
  Determines the prioritization of still image quality and capturing speed.
CheckDocumentDetectionMode
  Check document detection and extraction mode.
CheckMagneticInkStripScanningStatus
  Check magnetic ink (MICR) strip scanning status.
CollapsedVisibleHeight
  Configuration of the barcodes result sheet's height while collapsed.
CommonFieldType
  Common field types.
CompressionMode
  TIFF compression type.
ConfirmationMethod
  Method used to confirm a result.
CreditCardScanningMode
  The scanning mode.
CreditCardScanningStatus
  The status of the scanning process.
DocumentAnalysisMode
  Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
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.
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/
ImageRotation
  Image rotation.
ImageSourceType
  The type of source which originated the underlying image.
LicensePlateScannerStrategy
  Type of the scanner internally to scan the license plate.
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.
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.
OutputMode
  Output mode of binarization filter.
PageDirection
  Page direction.
PageFit
  Page fit.
PageSize
  Page size.
PathLoadMode
  Image Ref Path Load Mode.
PatternGrammar
  Grammar of pattern matching.
ResamplingMethod
  Resampling method.
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.
UserGuidanceVisibility
  Determines the visibility mode for the document capturing user guidance labels.
VinBarcodeExtractionStatus
  Status of the barcode extraction.

## Extensions

OperationStatusExtension on OperationStatus

## Functions

autorelease<R>(R computation()) → R

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