scanbot_sdk library

Classes

AAMVA: AAMVA
AAMVADLID: Driver License Or ID Document
AAMVADLIDFieldNames: Constants for the field type names of AAMVA.DLID.
AAMVADLIDNormalizedFieldNames: 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.
AAMVAMotorCarrierDataNormalizedFieldNames: Constants for the field type names of AAMVA.MotorCarrierData.
AAMVANormalizedFieldNames: Constants for the field type names of AAMVA.
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.
AAMVARegistrantAndVehicleDataNormalizedFieldNames: 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.
AAMVARegistrationDataNormalizedFieldNames: 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.
AAMVATitleDataNormalizedFieldNames: 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.
AAMVAVehicleDataNormalizedFieldNames: 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.
AAMVAVehicleOwnerDataNormalizedFieldNames: 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.
AAMVAVehicleSafetyInspectionDataNormalizedFieldNames: Constants for the field type names of AAMVA.VehicleSafetyInspectionData.
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.
AddPageOptions: Options for creating a document from images.
AnalyticsCategory: The category that is being tracked.
AnalyticsEvent: The event that is being tracked.
AnalyticsEventFactory: A predefined analytics event.
AnalyticsEventName: The name of the event.
AnalyticsFeature: The feature that is being tracked.
AndroidShutterButton
ArcPainter
ArOverlayFindAndPickConfiguration: Configuration of the AR overlay.
ArOverlayGeneralConfiguration: Configuration of the AR overlay displayed on top of barcodes in the camera preview.
ArOverlayPolygonConfiguration: Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
AspectRatio: Aspect ratio is the ratio of the width to the height of an image or screen.
AUSCheck: A check compatible with the Australian Paper Clearing System cheque standard
AUSCheckFieldNames: Constants for the field type names of AUSCheck.
AUSCheckNormalizedFieldNames: Constants for the field type names of AUSCheck.
AutoFocusConfiguration: Auto-focus configuration. The recognizer will ignore frames that are not focused. This option is enabled by default. This configuration has no effect in SINGLE_SHOT mode.
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.
BarcodeAccumulationConfiguration: Configuration for how to accumulate results.
BarcodeCameraConfiguration
BarcodeClassicScannerConfiguration
BarcodeDocumentFormats: Barcode document formats.
BarcodeDocumentParserResult: The result of barcode document parsing.
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.
BarcodeItemOverlayViewConfig
BarcodeMappedData: Format of the mapped barcode data.
BarcodeScannerCamera
BarcodeScannerCameraController
BarcodeScannerConfiguration: Configuration for the barcode scanner.
BarcodeScannerResult: The result of barcode scanning.
BarcodeScannerScreenConfiguration: Configuration of the barcode scanner screen.
BarcodeScannerUiItem: Data about the scanned barcode.
BarcodeScannerUiResult: Results of the barcode scan.
BarcodeTextLocalization: Configuration of the all strings for barcode scanner.
BarcodeUseCase: Configuration of the barcode scanner screen's behavior.
BaseCameraConfiguration
BaseViewFinderConfiguration: Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.
BasicImageLoadOptions: Basic options for loading image.
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.
BoardingPassLegNormalizedFieldNames: Constants for the field type names of BoardingPass.Leg.
BoardingPassNormalizedFieldNames: Constants for the field type names of BoardingPass.
BrIdCardBack: Brazilian National Identity Card (Registro Geral), back side
BrIdCardBackFieldNames: Constants for the field type names of BrIdCardBack.
BrIdCardBackNormalizedFieldNames: Constants for the field type names of BrIdCardBack.
BrIdCardFront: Brazilian National Identity Card (Registro Geral)
BrIdCardFrontFieldNames: Constants for the field type names of BrIdCardFront.
BrIdCardFrontNormalizedFieldNames: Constants for the field type names of BrIdCardFront.
BrIdCardFrontPhotoOnly: BrIdCardFrontPhotoOnly
BrIdCardFrontPhotoOnlyFieldNames: Constants for the field type names of BrIdCardFrontPhotoOnly.
BrIdCardFrontPhotoOnlyNormalizedFieldNames: Constants for the field type names of BrIdCardFrontPhotoOnly.
BrightnessFilter: Brightness adjustment filter.
BritishColumbiaDriverLicense: British Columbia (Canada) driver license
BritishColumbiaDriverLicenseFieldNames: Constants for the field type names of BritishColumbiaDriverLicense.
BritishColumbiaDriverLicenseNormalizedFieldNames: Constants for the field type names of BritishColumbiaDriverLicense.
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.
Cancel<T>
CANCheck: A check format commonly used in Canada
CANCheckFieldNames: Constants for the field type names of CANCheck.
CANCheckNormalizedFieldNames: Constants for the field type names of CANCheck.
CaptureFeedback: Configuration of the feedback shown after snapping a page.
CBufferImageLoadOptions
CEncodeImageOptions
Check: Check Document
CheckFieldNames: Constants for the field type names of Check.
CheckIntroCustomImage: A custom image for the introduction screen.
CheckIntroDefaultImage: No image for the introduction screen.
CheckIntroImage: The image for the introduction screen with a check template.
CheckNoImage: No image for the introduction screen.
CheckNormalizedFieldNames: Constants for the field type names of Check.
CheckScannerConfiguration: Configuration of the check scanner.
CheckScannerGuidanceConfiguration: Configuration of the hints guiding users through the check scanning process.
CheckScannerGuidanceStates: Configure the captions of the user guidance hints for different scanning states.
CheckScannerIntroImage: The image for the introduction screen of a check scanner screen.
CheckScannerIntroScreenConfiguration: Configuration of the introduction screen for the check scanner.
CheckScannerScreenConfiguration: Configuration of the screen for detecting check data.
CheckScannerScreenTextLocalization: Configuration of the all strings for check scanner screen.
CheckScannerUiResult: Configuration of the check scanner RTU UI result.
CheckScanningProgressConfiguration: Configuration of visualization of the scanning progress - indeterminate progress.
CheckScanningResult: The result of check scanning.
CImageInfo
CnEntryAndExitPermitBack: CnEntryAndExitPermitBack
CnEntryAndExitPermitBackFieldNames: Constants for the field type names of CnEntryAndExitPermitBack.
CnEntryAndExitPermitBackNormalizedFieldNames: Constants for the field type names of CnEntryAndExitPermitBack.
CnEntryAndExitPermitFront: CnEntryAndExitPermitFront
CnEntryAndExitPermitFrontFieldNames: Constants for the field type names of CnEntryAndExitPermitFront.
CnEntryAndExitPermitFrontNormalizedFieldNames: Constants for the field type names of CnEntryAndExitPermitFront.
CnPermanentResidentCardFront: CnPermanentResidentCardFront
CnPermanentResidentCardFrontFieldNames: Constants for the field type names of CnPermanentResidentCardFront.
CnPermanentResidentCardFrontNormalizedFieldNames: Constants for the field type names of CnPermanentResidentCardFront.
ColorDocumentFilter: Color document filter. This filter is a good starting point for most use cases.
CompositeFieldValueSemantics: Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.
ConsistencyVerificationReport: Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field is consistent.
ContentValidator: Base class for content validators.
ContourConfiguration
ContrastFilter: Contrast adjustment filter.
CPathImageLoadOptions
CreateDocumentOptions: Options for creating a document from images.
CRectangleInt
CreditCard: Credit Card Document
CreditCardFieldNames: Constants for the field type names of CreditCard.
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.
CreditCardNormalizedFieldNames: Constants for the field type names of CreditCard.
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.
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: 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.
DeAddressParserConfiguration: German Address Field validation configuration. This configuration does not enable the scanning of any document types by itself. Add to recognizer configuration to require German Address validation checks for specific document types.
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.
DeHealthInsuranceCardFrontNormalizedFieldNames: Constants for the field type names of DeHealthInsuranceCardFront.
DeIdCardBack: German ID card, back side
DeIdCardBackFieldNames: Constants for the field type names of DeIdCardBack.
DeIdCardBackNormalizedFieldNames: Constants for the field type names of DeIdCardBack.
DeIdCardFront: German ID card, front side
DeIdCardFrontFieldNames: Constants for the field type names of DeIdCardFront.
DeIdCardFrontNormalizedFieldNames: Constants for the field type names of DeIdCardFront.
DEMedicalPlan: Medical Plan
DEMedicalPlanDoctor: Doctor
DEMedicalPlanDoctorFieldNames: Constants for the field type names of DEMedicalPlan.Doctor.
DEMedicalPlanDoctorNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.Doctor.
DEMedicalPlanFieldNames: Constants for the field type names of DEMedicalPlan.
DEMedicalPlanNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.
DEMedicalPlanPatient: Patient
DEMedicalPlanPatientFieldNames: Constants for the field type names of DEMedicalPlan.Patient.
DEMedicalPlanPatientNormalizedFieldNames: 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.
DEMedicalPlanSubheadingMedicineNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Medicine.
DEMedicalPlanSubheadingMedicineSubstance: Substance
DEMedicalPlanSubheadingMedicineSubstanceFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Medicine.Substance.
DEMedicalPlanSubheadingMedicineSubstanceNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Medicine.Substance.
DEMedicalPlanSubheadingNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.
DEMedicalPlanSubheadingPrescription: Prescription
DEMedicalPlanSubheadingPrescriptionFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Prescription.
DEMedicalPlanSubheadingPrescriptionNormalizedFieldNames: Constants for the field type names of DEMedicalPlan.Subheading.Prescription.
DePassport: German travel passport (Reisepass)
DePassportFieldNames: Constants for the field type names of DePassport.
DePassportNormalizedFieldNames: Constants for the field type names of DePassport.
DeResidencePermitBack: German Residence Permit (Aufenthaltstitel), Back side
DeResidencePermitBackFieldNames: Constants for the field type names of DeResidencePermitBack.
DeResidencePermitBackNormalizedFieldNames: Constants for the field type names of DeResidencePermitBack.
DeResidencePermitFront: German Residence Permit (Aufenthaltstitel), Front side
DeResidencePermitFrontFieldNames: Constants for the field type names of DeResidencePermitFront.
DeResidencePermitFrontNormalizedFieldNames: Constants for the field type names of DeResidencePermitFront.
DeviceDeregistrationError: Description of error that occurred during device deregistration.
DocumentCameraConfiguration
DocumentClassicScannerConfiguration
DocumentClassifierConfiguration: Configuration for the document classifier.
DocumentClassifierResult: Contains the result of running the document classifier.
DocumentData: Document Data.
DocumentDataExtractionProgressConfiguration: Configuration of visualization of the scanning progress - indeterminate progress.
DocumentDataExtractionResult: Contains the result of running the document data 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 document data extraction configuration elements.
DocumentDataExtractorGuidanceConfiguration: Configuration of the hints guiding users through the document scanning process.
DocumentDataExtractorGuidanceStates: Configure the captions of the user guidance hints for different scanning states.
DocumentDataExtractorIntroImage: The image for the introduction screen of a document data extractor screen.
DocumentDataExtractorIntroScreenConfiguration: Configuration of the introduction screen for the document data extractor.
DocumentDataExtractorScreenConfiguration: Configuration of the screen for extracting data from ID documents.
DocumentDataExtractorScreenTextLocalization: Configuration of the all strings for document data extractor screen.
DocumentDataExtractorUiResult: Configuration of the generic text scanner RTU UI result.
DocumentDataIntroCustomImage: A custom image for the introduction screen.
DocumentDataIntroDefaultImage: The image for the introduction screen featuring a document.
DocumentDataIntroNoImage: No image for the introduction screen.
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.
DocumentScannerCamera
DocumentScannerCameraConfiguration: Configuration of the camera behavior.
DocumentScannerCameraController
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.
DocumentScanningResult: Result of the document detection followed by cropping of the found document.
DocumentVerificationReport: Report of the document verification.
EncodeImageOptions: Options for encoding image.
Error<T>
EuropeanDriverLicenseBack: European driver license, back side
EuropeanDriverLicenseBackCategories: Categories table row container
EuropeanDriverLicenseBackCategoriesA: EuropeanDriverLicenseBack.Categories.A
EuropeanDriverLicenseBackCategoriesA1: EuropeanDriverLicenseBack.Categories.A1
EuropeanDriverLicenseBackCategoriesA2: EuropeanDriverLicenseBack.Categories.A2
EuropeanDriverLicenseBackCategoriesAM: EuropeanDriverLicenseBack.Categories.AM
EuropeanDriverLicenseBackCategoriesB: EuropeanDriverLicenseBack.Categories.B
EuropeanDriverLicenseBackCategoriesB1: EuropeanDriverLicenseBack.Categories.B1
EuropeanDriverLicenseBackCategoriesBE: EuropeanDriverLicenseBack.Categories.BE
EuropeanDriverLicenseBackCategoriesC: EuropeanDriverLicenseBack.Categories.C
EuropeanDriverLicenseBackCategoriesC1: EuropeanDriverLicenseBack.Categories.C1
EuropeanDriverLicenseBackCategoriesC1E: EuropeanDriverLicenseBack.Categories.C1E
EuropeanDriverLicenseBackCategoriesCE: EuropeanDriverLicenseBack.Categories.CE
EuropeanDriverLicenseBackCategoriesD: EuropeanDriverLicenseBack.Categories.D
EuropeanDriverLicenseBackCategoriesD1: EuropeanDriverLicenseBack.Categories.D1
EuropeanDriverLicenseBackCategoriesD1E: EuropeanDriverLicenseBack.Categories.D1E
EuropeanDriverLicenseBackCategoriesDE: EuropeanDriverLicenseBack.Categories.DE
EuropeanDriverLicenseBackCategoriesL: EuropeanDriverLicenseBack.Categories.L
EuropeanDriverLicenseBackCategoriesT: EuropeanDriverLicenseBack.Categories.T
EuropeanDriverLicenseBackCategory: A category row from the categories table
EuropeanDriverLicenseBackCategoryFieldNames: Constants for the field type names of EuropeanDriverLicenseBack.Category.
EuropeanDriverLicenseBackCategoryNormalizedFieldNames: Constants for the field type names of EuropeanDriverLicenseBack.Category.
EuropeanDriverLicenseBackFieldNames: Constants for the field type names of EuropeanDriverLicenseBack.
EuropeanDriverLicenseBackNormalizedFieldNames: Constants for the field type names of EuropeanDriverLicenseBack.
EuropeanDriverLicenseFront: European driver license, front side
EuropeanDriverLicenseFrontFieldNames: Constants for the field type names of EuropeanDriverLicenseFront.
EuropeanDriverLicenseFrontNormalizedFieldNames: Constants for the field type names of EuropeanDriverLicenseFront.
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.
EuropeanHealthInsuranceCardNormalizedFieldNames: Constants for the field type names of EuropeanHealthInsuranceCard.
ExpectedBarcode: Configuration of the barcode to find and scan.
FadeOutView
Field: Generic document field.
FieldConsistencyVerificationReport: Report of the field consistency verification.
FieldInvalidDataVerificationReport: Report which shows whether the data in the field that can be validated is valid.
FieldParsedData: Parsed data.
FieldSuspiciousDataVerificationReport: Report of the suspicious data field verification.
FieldType: Generic Document Type.
FieldValueSemantics: Report of the field value semantics verification.
FieldWrapper
FindAndPickArOverlayPolygonConfiguration: Configuration of the overlay polygon displayed on top of a barcode in the camera preview.
FindAndPickBadgeConfiguration: Configuration of the round badge on find and pick ar layer.
FindAndPickScanningMode: Configuration of the Find and Pick barcode scanning mode.
FinderConfiguration: The finder view is a rectangular overlay view that clips the camera view, so that the detection will focus just a specific area. You can specify the size and positioning, as well as other UI properties. Set this property to true if you want to use the Finder View, false otherwise (default: false)
FinderCorneredStyle: A variant of the viewfinder displaying only the four corners of the scanning area.
FinderStrokedStyle: A variant of the viewfinder displaying a full outline of the scanning area.
FinderStyle: The visual appearance of the viewfinder.
FinderView
ForegroundStyle: Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).
FRACheck: A check format commonly used in France
FRACheckFieldNames: Constants for the field type names of FRACheck.
FRACheckNormalizedFieldNames: Constants for the field type names of FRACheck.
GenericDocument: Generic document.
GenericDocumentType: Generic Document Type.
GenericDocumentWrapper
GlareDetectionConfiguration: Glare detection configuration. The recognizer will detect whether fields are obstructed by glare. This feature is enabled by default. This configuration has no effect in SINGLE_SHOT mode.
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.
GS1ElementNormalizedFieldNames: Constants for the field type names of GS1.Element.
GS1ElementValidationError: Validation Errors
GS1ElementValidationErrorFieldNames: Constants for the field type names of GS1.Element.ValidationError.
GS1ElementValidationErrorNormalizedFieldNames: Constants for the field type names of GS1.Element.ValidationError.
HIBC: HIBC
HIBCFieldNames: Constants for the field type names of HIBC.
HIBCNormalizedFieldNames: Constants for the field type names of HIBC.
HkIdentityCardFront: HkIdentityCardFront
HkIdentityCardFrontFieldNames: Constants for the field type names of HkIdentityCardFront.
HkIdentityCardFrontNormalizedFieldNames: Constants for the field type names of HkIdentityCardFront.
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.
IDCardPDF417: ID Card
IDCardPDF417FieldNames: Constants for the field type names of IDCardPDF417.
IDCardPDF417NormalizedFieldNames: 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.
INDCheckNormalizedFieldNames: Constants for the field type names of INDCheck.
Insets
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.
InvalidDataVerificationReport: Report of the field validation verification.
IosShutterButton
ISRCheck: A check format commonly used in Israel
ISRCheckFieldNames: Constants for the field type names of ISRCheck.
ISRCheckNormalizedFieldNames: 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.
KWTCheckNormalizedFieldNames: Constants for the field type names of KWTCheck.
LegacyFilter: Deprecated. Returns the input image unchanged.
LicenseInfo: Information about the SDK license.
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.
MedicalCertificate: Medical Certificate
MedicalCertificateFieldNames: Constants for the field type names of MedicalCertificate.
MedicalCertificateIntroImage: The image for the introduction screen with a medical certificate template.
MedicalCertificateNormalizedFieldNames: Constants for the field type names of MedicalCertificate.
Metadata: Metadata for the document
MetadataFieldNames: Constants for the field type names of Metadata.
MetadataNormalizedFieldNames: Constants for the field type names of Metadata.
ModifyPageOptions: Options for modifying a page within a document.
MoIdentityCardBack: MoIdentityCardBack
MoIdentityCardBackFieldNames: Constants for the field type names of MoIdentityCardBack.
MoIdentityCardBackNormalizedFieldNames: Constants for the field type names of MoIdentityCardBack.
MoIdentityCardFront: MoIdentityCardFront
MoIdentityCardFrontFieldNames: Constants for the field type names of MoIdentityCardFront.
MoIdentityCardFrontNormalizedFieldNames: Constants for the field type names of MoIdentityCardFront.
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.
MRZNormalizedFieldNames: Constants for the field type names of MRZ.
MrzParserConfiguration: Configuration for MRZ parser.
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.
OcrConfigsResult: OCR configurations result.
OcrConfiguration
OcrElement: Base class for units of text, e.g. glyphs, words, lines, blocks, pages.
OcrPage: Represents result of performing OCR on an image. A page is made up of blocks.
OcrResult: Result of OCR text recognition.
Ok<T>
Page: SDK Page
PageAspectRatio
PageData: The result of the health insurance card recognition.
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.
ParsedDeAddress: Parsed German Address part of the document
ParsedDeAddressFieldNames: Constants for the field type names of ParsedDeAddress.
ParsedDeAddressNormalizedFieldNames: Constants for the field type names of ParsedDeAddress.
PartiallyVisibleDocumentConfiguration: Configuration for handling partially visible documents.
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:
PdfExtractorOptions: Options for extracting images from a PDF document.
PerformOcrResult: The result of OCR recognition.
PermanentViewFinderConfiguration: Configuration of the scanning interface’s viewfinder, which is always visible to guide the user.
PolygonPoint: Polygon Point
PolygonStyle: Configuration of the polygon appearance.
PopupMenuItem: Configuration for the popup menu items.
PreviewButton: Configuration of the 'preview' button.
ProcessByTileConfiguration: Configuration for processing image by tiles. This can be used to make the document quality analyzer processing faster with lower memory consumption, but prediction can be less accurate.
RangeEncoding: A character encoding for a given range of bytes.
RawImageLoadOptions: Options for loading images that come from sensor.
ReceiptsIntroImage: The image for the introduction screen with a receipt template.
Rect
RefCountedObjectProfile: Profile info of a reference-counted stored object.
ReorderPagesScreenConfiguration: Configuration of the screen for reordering the scanned pages.
Result<T>
ResultAccumulationConfiguration: Configuration for how to accumulate results.
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.
ScanbotBarcode: Entry point for all barcode features.
ScanbotBinarizationFilter: Automatic binarization filter. This filter is a good starting point for most use cases.
ScanbotCamera
ScanbotCameraController
ScanbotCameraWidgetState
ScanbotCheck: Entry point for all Check scanning features.
ScanbotColor
ScanbotCreditCard: Entry point for all Credit Card scanning features.
ScanbotCroppingWidget
ScanbotDocument: Entry point for all document features.
ScanbotDocumentDataExtractor: Entry point for all Document Data Extractor features.
ScanbotEdgeInsets: Represents the insets of a rectangle.
ScanbotIconButton: Configuration of the icon appearance on a button.
ScanbotImageProcessor: Entry point for all image processing features.
ScanbotLegacyPage: Entry point for all legacy page features.
ScanbotMrz: Entry point for all MRZ scanning features.
ScanbotOcrEngine: Entry point for all OCR engine features.
ScanbotPdfGenerator: Entry point for all PDF generation features.
ScanbotPdfImageExtractor: Entry point for all PDF image extraction features.
ScanbotSdk: Entry point for all features that are part of Scanbot SDK.
ScanbotTextPattern: Entry point for all Text Pattern scanning features.
ScanbotTiffGenerator: Entry point for all TIFF generation features.
ScanbotVin: Entry point for all VIN scanning features.
ScanCompletionOverlay: Configuration of the overlay to be shown after the successful scan.
SdkConfiguration: Initialize configuration for the Scanbot SDK.
SelectionOverlayScannerConfiguration: Barcode Selection Overlay configuration
SemanticsVerificationReport: Report of the document value semantics verification.
SEPA: SEPA
SEPAFieldNames: Constants for the field type names of SEPA.
SEPANormalizedFieldNames: Constants for the field type names of SEPA.
Sheet: Configuration of the preview mode for scanning multiple barcodes.
SheetContent: Configuration of the list containing the barcodes that have already been scanned.
ShutterAnimation
ShutterButton: Configuration of the 'shutter' button.
ShutterButtonView
SingleScanningMode: Configuration of the single barcode scanning mode.
Size: Standard size object
Sound: Configuration for the sound.
StructuredAppendInfo: The structured append mode can be used to split a message across multiple barcodes.
StyledText: Configuration of the text field appearance.
SuspiciousDataVerificationReport: Report of the suspicious data document verification.
SwipeToDelete: Configuration of the swipe-to-delete button.
SwissQR: SwissQR
SwissQRFieldNames: Constants for the field type names of SwissQR.
SwissQRNormalizedFieldNames: Constants for the field type names of SwissQR.
SymbolBox: Structure containing recognized symbol text and bounds.
TextButtonMode: Configuration of the 'preview' button in 'text button mode'.
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.
TextWithBadgeButtonMode: Configuration of the 'preview' button in 'text with badge button mode'.
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.
TwEntryAndExitPermit: TwEntryAndExitPermit
TwEntryAndExitPermitFieldNames: Constants for the field type names of TwEntryAndExitPermit.
TwEntryAndExitPermitNormalizedFieldNames: Constants for the field type names of TwEntryAndExitPermit.
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.
UAECheckNormalizedFieldNames: 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.
USACheckNormalizedFieldNames: 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.
UserGuidanceConfiguration: Configuration of the hint guiding users through the scanning process.
UserGuidanceStates: Configure the titles of the user guidance hints for different states.
ValidatedTextFieldWrapper: Text field wrapper
VCard: VCard
VCardAgent: Agent
VCardAnniversary: Anniversary
VCardBirthday: Birthday
VCardBusyTimeURL: Busy Time URL
VCardCalendarURI: Calendar URI
VCardCalendarURIForRequests: Calendar URI For Requests
VCardCategory: Category
VCardClassification: Classification
VCardClientPIDMap: Client PID Map
VCardCustom: Custom
VCardDeliveryAddress: Delivery Address
VCardEmail: Email
VCardEntry: VCard Entry
VCardEntryFieldNames: Constants for the field type names of VCard.Entry.
VCardEntryNormalizedFieldNames: Constants for the field type names of VCard.Entry.
VCardFormattedName: Formatted Name
VCardGender: Gender
VCardGeoLocation: Geo Location
VCardIMPP: IMPP
VCardKind: Kind
VCardLabel: Label
VCardLanguage: Language
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
VCardSortString: Sort String
VCardSound: Sound
VCardSource: Source
VCardTelephoneNumber: Telephone Number
VCardTimeZone: Time Zone
VCardTitle: Title
VCardUID: UID
VCardURL: URL
VCardVersion: Version
VCardXML: XML
Vibration: Configure the vibration.
ViewFinderConfiguration: Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.
VinBarcodeResult: Result of the barcode scanner.
VinIntroCustomImage: A custom image for the introduction screen.
VinIntroDefaultImage: The default image for the introduction screen.
VinIntroNoImage: No image for the introduction screen.
VinScannerConfiguration: Configuration for the VIN scanner.
VinScannerIntroImage: The image for the introduction screen of a VIN scanner screen.
VinScannerIntroScreenConfiguration: Configuration of the introduction screen for the VIN scanner.
VinScannerResult: Result of the VIN scanner.
VinScannerScreenConfiguration: Configuration of the screen for detecting VIN data.
VinScannerScreenTextLocalization: Configuration of the all strings for generic text scanner screen.
VinScannerUiResult: Configuration of the generic text scanner RTU UI result.
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.
ZoomRange: Defines a range for zooming

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.
BarcodeAccumulationMethod: The method how to display barcodes from previous frames.
BarcodeDocumentFormat: Type of barcode document format used.
BarcodeDocumentModelRootType
BarcodeFormat: Enumerates barcode formats.
BarcodeItemInfoPosition: Where to display the barcode info box in the camera preview.
BarcodeOverlayTextFormat: Barcode scanner engine mode
BarcodeScannerEngineMode: The engine mode for barcode scanning.
BinarizationFilterPreset: Preset of parameters for custom binarization filter.
BottomBarMode: The visual mode used for the bottom bar.
BufferLoadMode: Image Ref Buffer Load Mode.
CameraLiveScannerResolution: The size of the image from camera which would be sent to the scanner for live scanning.
CameraModule: Determines which camera module to use on start-up.
CameraPreviewMode: Configuration of the camera preview mode.
CanvasColor: Canvas color to use when converting images with alpha channel to images without alpha channel.
CapturePhotoQualityPrioritization: Determines the prioritization of still image quality and capturing speed.
CharacterEncoding: Enumerates character encodings.
CheckDocumentDetectionMode: Check document detection and extraction mode.
CheckDocumentModelRootType
CheckMagneticInkStripScanningStatus: Check magnetic ink (MICR) strip scanning status.
CheckStandard: Supported check standards.
CollapsedVisibleHeight: Configuration of the barcodes result sheet's height while collapsed.
ColorConversion: Color conversion to apply during image loading.
CommonFieldType: Common field types.
CompressionMode: TIFF compression type.
ConfirmationMethod: Method used to confirm a result.
CreditCardDocumentModelRootType
CreditCardScanningStatus: The status of the scanning process.
DetectorType
DocumentAnalysisMode: Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
DocumentClassifierStatus: The status of the classification result.
DocumentDataExtractionStatus: The status of the extraction process.
DocumentDetectionStatus: Status of the document detection.
DocumentDisplacement: The direction towards the center of the document if the document is partially visible.
DocumentQuality: Result of document quality analysis.
DocumentScannerEngineMode: Engines for document scanning.
DocumentsModelRootType
DocumentTrustMode: Level of trust in the authenticity of the extracted document.
DocumentType: The type of the document.
DocumentVerificationStatus: Overall status of the document verification.
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.
Feature: License features.
FieldDataFormat: Type of parsing applied to field.
FieldValidationStatus: Field validation status.
FileEncryptionMode: File encryption mode.
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
ImageOrigin: Location of the image origin in the image coordinate system.
ImageRotation: Image rotation.
ImageSourceType: The type of source which originated the underlying image.
LicenseStatus: Status of the license plate scanner.
MrzDocumentType: Type of document containing the MRZ.
MrzIncompleteResultHandling: Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
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.
OcrEngine: The modes of the optical character recognition engine.
OneDConfirmationMode: Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes. Some barcode types are naturally prone to false positives (e.g. MSI Plessey). For those barcode types false positives can be drastically reduced (precision can be increased) by requiring that multiple scan-lines in the input scan to the same result. However, this stronger condition can lead to missed barcodes (lower recall). Confirmation is avoided for barcode types, which are by design resistant to false positives, (e.g. Code128) to maximize recall.
OperationStatus
OrientationLockMode: Configure the orientation of the interface.
OutputMode: Output mode of binarization filter.
PageBinarization: Binarization behavior to apply when adding a page to a PDF/TIFF.
PageDirection: Page direction.
PageFit: Page fit.
PageImageSource: The source of an image.
PageSize: Page size.
PathLoadMode: Image Ref Path Load Mode.
PatternGrammar: Grammar of pattern matching.
ProcessingMode: Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.
ResamplingMethod: Resampling method.
SBExceptionType
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.
StorageImageFormat: Image format for storing images.
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.
ValueConsistency: The status of the consistency verification.
ValueSemantics: The result of the value semantics verification.
VinBarcodeExtractionStatus: Status of the barcode extraction.

Extensions

GenericDocumentExtension on GenericDocument: Extension function to GenericDocument to make it easier to access fields.
KotlinFunctionsForObject on T
PointExtension on Point<num>

Functions

autorelease<R>(R computation()) → R
colorFromString(String? color) → Color?
createSBException(String errorCode, String message) → SBException
encodeByteListToBase64(Uint8List bytes) → String
executeRtuUiWithResult<T>(Future<String> invokeMethod(), {required T fromJson(Map<String, dynamic> data)}) → Future<Result<T>>
executeWithResult<T>(Future<T> action()) → Future<Result<T>>
toColorString(Color? color) → String?
toSerializedImageFileUriInput(String imageFileUri) → Map<String, dynamic>
toSerializedImageFileUrisInput(List<String>? imageUris) → Map<String, dynamic>
toSerializedImageRefInput(ImageRef imageRef) → Map<String, dynamic>
toSerializedImageRefsInput(List<ImageRef> imageRefs) → Map<String, dynamic>
uintListFromString(String string) → Uint8List

Typedefs

AcquireSerializedReference = bool Function(Pointer<Utf8> uuid)
AcquireSerializedReferenceNative = Bool Function(Pointer<Utf8> uuid)
AnalyticsSubscriber = void Function(AnalyticsEvent event)
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)
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 = bool Function(Pointer<Utf8> uuid)
HibernateNative = Bool 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)

Exceptions / Errors

ComponentUnavailableException
IllegalStateException
InvalidArgumentException
InvalidDataException
InvalidImageRefException
InvalidLicenseException
IOException
NullPointerException
OperationCanceledException
OutOfMemoryException
ProcessException
SBException
TimeoutException
UnknownException

scanbot_sdk library

Classes

Enums

Extensions

Functions

Typedefs

Exceptions / Errors

scanbot_sdk package

scanbot_sdk library