core library Core

Classes

AccumulatedResultsVerifierConfiguration: Configure the frame accumulation process.
AspectRatio: Aspect ratio is the ratio of the width to the height of an image or screen.
AutoReleasable
AutoReleasePool
BarcodeDocumentFormats: Barcode document formats.
BarcodeFormatAustraliaPostConfiguration: Australia Post barcode configuration. Add to scanner configuration to scan Australia Post barcodes.
BarcodeFormatAztecConfiguration: Aztec configuration. Add to scanner configuration to scan Aztec codes.
BarcodeFormatCodabarConfiguration: Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.
BarcodeFormatCode11Configuration: Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.
BarcodeFormatCode128Configuration: Code 128 barcode configuration. Add to scanner configuration to scan Code 128 barcodes.
BarcodeFormatCode2Of5Configuration: Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes.
BarcodeFormatCode39Configuration: Code 39 barcode and derivatives configuration. Add to scanner configuration to scan Code 39, Code 32 (Italian Pharmacode), PZN7 and PZN8 (Pharmazentralnummer) barcodes.
BarcodeFormatCode93Configuration: Code 93 barcode configuration. Add to scanner configuration to scan Code 93 barcodes.
BarcodeFormatCommonConfiguration: Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.
BarcodeFormatCommonFourStateConfiguration: Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state codes.
BarcodeFormatCommonOneDConfiguration: Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple linear (1D) barcode formats.
BarcodeFormatCommonTwoDConfiguration: Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.
BarcodeFormatConfigurationBase: Base class for all barcode configurations.
BarcodeFormatDataBarConfiguration: GS1 DataBar barcode configuration. Add to scanner configuration to scan GS1 DataBar-14, GS1 DataBar-14 Truncated, GS1 DataBar-14 Stacked and GS1 DataBar-14 Stacked Omnidirectional barcodes.
BarcodeFormatDataBarExpandedConfiguration: GS1 DataBar Expanded barcode configuration. Add to scanner configuration to scan GS1 DataBar Expanded and GS1 DataBar Expanded Stacked barcodes.
BarcodeFormatDataBarLimitedConfiguration: GS1 DataBar Limited barcode configuration. Add to scanner configuration to scan GS1 DataBar Limited barcodes.
BarcodeFormatDataMatrixConfiguration: DataMatrix configuration. Add to scanner configuration to scan DataMatrix and DataMatrix rectangular extensions (DMRE) codes.
BarcodeFormatFourStateConfigurationBase: Base class for all four-state barcode configurations.
BarcodeFormatGs1CompositeConfiguration: GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes.
BarcodeFormatItfConfiguration: ITF (Interleaved 2-of-5) barcode configuration. Add to scanner configuration to scan Interleaved 2-of-5 (ITF) barcodes.
BarcodeFormatJapanPostConfiguration: Japan Post barcode configuration. Add to scanner configuration to scan Japan Post barcodes.
BarcodeFormatMaxiCodeConfiguration: MaxiCode configuration. Add to scanner configuration to scan MaxiCode codes.
BarcodeFormatMicroPdf417Configuration: MicroPDF417 configuration. Add to scanner configuration to scan MicroPDF417 codes.
BarcodeFormatMsiPlesseyConfiguration: MSI Plessey barcode configuration. Add to scanner configuration to scan MSI Plessey barcodes.
BarcodeFormatOneDConfigurationBase: Base class for all linear (1D) barcode configurations.
BarcodeFormatPdf417Configuration: PDF417 configuration. Add to scanner configuration to scan PDF417 codes.
BarcodeFormatPharmaCodeConfiguration: PharmaCode barcode configuration. Add to scanner configuration to scan linear (1D) Laetus Pharmacode barcodes. Two-track PharmaCode scanning is configured separately through the PharmaCodeTwoTrackConfig class.
BarcodeFormatPharmaCodeTwoTrackConfiguration: PHARMA_CODE_TWO_TRACK barcode configuration. Add to scanner configuration to scan Laetus two-track PharmaCode barcodes. Linear (i.e. one-track) PharmaCode scanning is configured separately through the PharmaCodeConfig class.
BarcodeFormatQrCodeConfiguration: QR Code configuration. Add to scanner configuration to scan QR codes, Micro QR codes and rectangular Micro QR (rMQR) codes.
BarcodeFormatRoyalMailConfiguration: Royal Mail barcode configuration. Add to scanner configuration to scan Royal Mail (a.k.a. RM4SCC, CBC, BPO 4-State) barcodes.
BarcodeFormatRoyalTntPostConfiguration: Royal TNT Post barcode configuration. Add to scanner configuration to scan Royal TNT Post (a.k.a. KIX, Klant IndeX) barcodes.
BarcodeFormats: Lists of barcode formats to decode.
BarcodeFormatTwoDConfigurationBase: Base class for all 2D barcode configurations.
BarcodeFormatUpcEanConfiguration: UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.
BarcodeFormatUspsIntelligentMailConfiguration: USPS Intelligent Mail barcode configuration. Add to scanner configuration to scan USPS Intelligent Mail (a.k.a. USPS OneCode, USPS-STD-11) barcodes.
BarcodeItem: A single barcode found in the input image. Barcodes with the same content but different locations in the image are considered separate barcodes.
BarcodeScannerConfiguration: Configuration for the barcode scanner.
BarcodeScannerResult: The result of barcode scanning.
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.
CBufferImageLoadOptions
CEncodeImageOptions
CheckScannerConfiguration: Configuration of the check scanner.
CheckScanningResult: The result of check scanning.
CImageInfo
ColorDocumentFilter: Color document filter. This filter is a good starting point for most use cases.
ContentValidator: Base class for content validators.
ContrastFilter: Contrast adjustment filter.
CPathImageLoadOptions
CRectangleInt
CreditCardScannerConfiguration: Configuration for the credit card scanner.
CreditCardScanningResult: Contains the result of running the credit card scanner.
CSaveImageOptions
CustomBinarizationFilter: Automatic binarization filter. This filter is a good starting point for most use cases.
DateValidationConfiguration: Date validation configuration. This configuration element does not enable the scanning of any document types by itself. Add to recognizer configuration to require date validation checks for specific document types.
DefaultContentValidator: Default content validator. Accepts only non-empty strings.
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.
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.
DocumentScannerConfiguration: Configuration for the document scanner.
DocumentScannerParameters: Parameters for the document scanner.
EncodeImageOptions: Options for encoding image.
EuropeanHealthInsuranceCardConfiguration: European Health Insurance Card (EHIC) configuration element. Add to extractor configuration to scan EHICs.
EuropeanHealthInsuranceCardRecognitionResult: The result of the health insurance card recognition.
EuropeanHealthInsuranceCardRecognitionResultField: Health insurance card field.
EuropeanHealthInsuranceCardRecognizerConfiguration: Configuration for the European health insurance card (EHIC) recognizer.
Field: Generic document field.
FieldParsedData: Parsed data.
FieldType: Generic Document Type.
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.
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.
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.
MedicalCertificateCheckBox: Structure to contain full information about found box.
MedicalCertificateDateRecord: Structure to contain date record information.
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.
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.
MrzScannerConfiguration: Configuration for MRZ scanner.
MrzScannerResult: Container for result of MRZ scanning attempt.
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.
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:
RawImageLoadOptions: Options for loading images that come from sensor.
RefCountedObjectProfile: Profile info of a reference-counted stored object.
ResultAccumulationConfiguration: Configuration for how to accumulate results.
SaveImageOptions: Options for saving image to a path.
ScanbotBinarizationFilter: Automatic binarization filter. This filter is a good starting point for most use cases.
SymbolBox: Structure containing recognized symbol text and bounds.
TextPatternScannerConfiguration: Configuration for the text pattern scanner.
TextPatternScannerResult: The result of the text line recognition.
TiffGeneratorParameters: TIFF generator parameters.
ToJsonConfiguration: Configuration used to serialize an object to json.
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.
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.

Enums

AustraliaPostCustomerFormat: Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
BarcodeDocumentFormat: Type of barcode document format used.
BarcodeFormat: Enumerates barcode formats.
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.
CheckDocumentDetectionMode: Check document detection and extraction mode.
CheckMagneticInkStripScanningStatus: Check magnetic ink (MICR) strip scanning status.
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.
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.
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.
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.
UpcEanExtensionBehavior: Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
VinBarcodeExtractionStatus: Status of the barcode extraction.

Functions

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

Typedefs

AcquireSerializedReference = bool Function(Pointer<Utf8> uuid)
AcquireSerializedReferenceNative = Bool Function(Pointer<Utf8> uuid)
BufferData = Pointer<Uint8> Function(Pointer<Opaque> buffer)
BufferDataNative = Pointer<Uint8> Function(Pointer<Opaque> buffer)
BufferSize = int Function(Pointer<Opaque> buffer)
BufferSizeNative = Int Function(Pointer<Opaque> buffer)
Clear = void Function(Pointer<Utf8> uuid)
ClearNative = Void Function(Pointer<Utf8> uuid)
Clone = Pointer<Utf8> Function(Pointer<Utf8> uuid)
CloneNative = Pointer<Utf8> Function(Pointer<Utf8> uuid)
CreateFromEncodedBuffer = Pointer<Utf8> Function(Pointer<Uint8> data, int size, Pointer<CBufferImageLoadOptions> options)
CreateFromEncodedBufferNative = Pointer<Utf8> Function(Pointer<Uint8> data, Int size, Pointer<CBufferImageLoadOptions> options)
CreateFromPath = Pointer<Utf8> Function(Pointer<Utf8> path, Pointer<CPathImageLoadOptions> options)
CreateFromPathNative = Pointer<Utf8> Function(Pointer<Utf8> path, Pointer<CPathImageLoadOptions> options)
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)

core library Core

Classes

Enums

Functions

Typedefs

scanbot_sdk package

scanbot.core library