All Classes Class Summary Enum Summary Exception Summary
| Class |
Description |
| Accelerator |
Accelerator to use for running machine learning models.
|
| AccumulatedResultsVerifierConfiguration |
Configure the frame accumulation process.
|
| AspectRatio |
Aspect ratio is the ratio of the width to the height of an image or screen.
|
| AustraliaPostCustomerFormat |
Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62.
|
| AutoFocusConfiguration |
Auto-focus configuration.
|
| BarcodeAccumulationConfiguration |
Configuration for how to accumulate results.
|
| BarcodeAccumulationMethod |
The method how to display barcodes from previous frames.
|
| BarcodeDocumentFormat |
Type of barcode document format used.
|
| BarcodeDocumentFormats |
Barcode document formats.
|
| BarcodeDocumentParser |
API for parsing barcode documents.
|
| BarcodeDocumentParserResult |
The result of barcode document parsing.
|
| BarcodeFormat |
Enumerates barcode formats.
|
| BarcodeFormatAustraliaPostConfiguration |
Australia Post barcode configuration.
|
| BarcodeFormatAztecConfiguration |
Aztec configuration.
|
| BarcodeFormatCodabarConfiguration |
Codabar barcode configuration.
|
| BarcodeFormatCode11Configuration |
Code 11 barcode configuration.
|
| BarcodeFormatCode128Configuration |
Code 128 barcode configuration.
|
| BarcodeFormatCode2Of5Configuration |
Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig).
|
| BarcodeFormatCode39Configuration |
Code 39 barcode and derivatives configuration.
|
| BarcodeFormatCode93Configuration |
Code 93 barcode configuration.
|
| BarcodeFormatCommonConfiguration |
Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration.
|
| BarcodeFormatCommonFourStateConfiguration |
Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration.
|
| BarcodeFormatCommonOneDConfiguration |
Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration.
|
| BarcodeFormatCommonTwoDConfiguration |
Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration.
|
| BarcodeFormatConfigurationBase |
Base class for all barcode configurations.
|
| BarcodeFormatDataBarConfiguration |
GS1 DataBar barcode configuration.
|
| BarcodeFormatDataBarExpandedConfiguration |
GS1 DataBar Expanded barcode configuration.
|
| BarcodeFormatDataBarLimitedConfiguration |
GS1 DataBar Limited barcode configuration.
|
| BarcodeFormatDataMatrixConfiguration |
DataMatrix configuration.
|
| BarcodeFormatFourStateConfigurationBase |
Base class for all four-state barcode configurations.
|
| BarcodeFormatGs1CompositeConfiguration |
GS1 Composite configuration.
|
| BarcodeFormatItfConfiguration |
ITF (Interleaved 2-of-5) barcode configuration.
|
| BarcodeFormatJapanPostConfiguration |
Japan Post barcode configuration.
|
| BarcodeFormatMaxiCodeConfiguration |
MaxiCode configuration.
|
| BarcodeFormatMicroPdf417Configuration |
MicroPDF417 configuration.
|
| BarcodeFormatMsiPlesseyConfiguration |
MSI Plessey barcode configuration.
|
| BarcodeFormatOneDConfigurationBase |
Base class for all linear (1D) barcode configurations.
|
| BarcodeFormatPdf417Configuration |
PDF417 configuration.
|
| BarcodeFormatPharmaCodeConfiguration |
PharmaCode barcode configuration.
|
| BarcodeFormatPharmaCodeTwoTrackConfiguration |
PHARMA_CODE_TWO_TRACK barcode configuration.
|
| BarcodeFormatQrCodeConfiguration |
QR Code configuration.
|
| BarcodeFormatRoyalMailConfiguration |
Royal Mail barcode configuration.
|
| BarcodeFormatRoyalTntPostConfiguration |
Royal TNT Post barcode configuration.
|
| BarcodeFormats |
Lists of barcode formats to decode.
|
| BarcodeFormatTwoDConfigurationBase |
Base class for all 2D barcode configurations.
|
| BarcodeFormatUpcEanConfiguration |
UPC/EAN barcode configuration.
|
| BarcodeFormatUspsIntelligentMailConfiguration |
USPS Intelligent Mail barcode configuration.
|
| BarcodeItem |
A single barcode found in the input image.
|
| BarcodeScanner |
API for barcode scanning.
|
| BarcodeScannerConfiguration |
Configuration for the barcode scanner.
|
| BarcodeScannerEngineMode |
The engine mode for barcode scanning.
|
| BarcodeScannerResult |
The result of barcode scanning.
|
| BasicImageLoadOptions |
Basic options for loading image.
|
| BinarizationFilterPreset |
Preset of parameters for custom binarization filter.
|
| Block |
Represents a single block, e.g.
|
| BrightnessFilter |
Brightness adjustment filter.
|
| BufferImageLoadOptions |
Options for loading image from buffer.
|
| BufferLoadMode |
Image Ref Buffer Load Mode.
|
| CharacterEncoding |
Enumerates character encodings.
|
| CheckDocumentDetectionMode |
Check document detection and extraction mode.
|
| CheckMagneticInkStripScanningStatus |
Check magnetic ink (MICR) strip scanning status.
|
| CheckScanner |
API for check scanning.
|
| CheckScannerConfiguration |
Configuration of the check scanner.
|
| CheckScanningResult |
The result of check scanning.
|
| CheckStandard |
Supported check standards.
|
| ColorConversion |
Color conversion to apply during image loading.
|
| ColorDocumentFilter |
Color document filter.
|
| CommonFieldType |
Common field types.
|
| ComponentUnavailableException |
Exception that is thrown if a program component is not available
|
| CompositeFieldValueSemantics |
Report of a logical field value semantics verification.
|
| CompressionMode |
TIFF compression type.
|
| ConfirmationMethod |
Method used to confirm a result.
|
| ConsistencyVerificationReport |
Report of the document consistency verification.
|
| ContentValidator |
Base class for content validators.
|
| ContrastFilter |
Contrast adjustment filter.
|
| CreditCardScanner |
API for credit card scanning.
|
| CreditCardScannerConfiguration |
Configuration for the credit card scanner.
|
| CreditCardScanningResult |
Contains the result of running the credit card scanner.
|
| CreditCardScanningStatus |
The status of the scanning process.
|
| CustomBinarizationFilter |
Automatic binarization filter.
|
| DateValidationConfiguration |
Date validation configuration.
|
| DeAddressParserConfiguration |
German Address Field validation configuration.
|
| DefaultContentValidator |
Default content validator.
|
| DeviceDeregistrationError |
Description of error that occurred during device deregistration.
|
| DeviceSession |
Convenience class to manage device usage for a floating license.
|
| DocumentClassifier |
API for document classification.
|
| DocumentClassifierConfiguration |
Configuration for the document classifier.
|
| DocumentClassifierResult |
Contains the result of running the document classifier.
|
| DocumentClassifierStatus |
The status of the classification result.
|
| DocumentDataExtractionResult |
Contains the result of running the document data extractor.
|
| DocumentDataExtractionStatus |
The status of the extraction process.
|
| DocumentDataExtractor |
API for extracting data from documents.
|
| DocumentDataExtractorCommonConfiguration |
Convenience configuration element for enabling the scanning of multiple document types with a common configuration.
|
| DocumentDataExtractorConfiguration |
Configuration for the document data extractor.
|
| DocumentDataExtractorConfigurationElement |
Base class for all document data extraction configuration elements.
|
| DocumentDetectionResult |
Result of the document contour detection.
|
| DocumentDetectionScores |
The total and partial scores for the detected document contour.
|
| DocumentDetectionStatus |
Status of the document detection.
|
| DocumentDisplacement |
The displacement of the document from the image center if the document is partially visible.
|
| DocumentQuality |
Result of document quality analysis.
|
| DocumentQualityAnalyzer |
API for analyzing document quality.
|
| DocumentQualityAnalyzerConfiguration |
Document Quality Analyzer configuration.
|
| DocumentQualityAnalyzerResult |
Result of document quality analysis.
|
| DocumentQualityThreshold |
Point in the quality-number of symbols space to separate quality levels.
|
| DocumentScanner |
API for document detection and scanning.
|
| DocumentScannerConfiguration |
Configuration for the document scanner.
|
| DocumentScannerEngineMode |
Engines for document scanning.
|
| DocumentScannerParameters |
Parameters for the document scanner.
|
| DocumentScanningResult |
Result of the document detection followed by cropping of the found document.
|
| DocumentTrustMode |
Level of trust in the authenticity of the extracted document.
|
| DocumentType |
The type of the document.
|
| DocumentVerificationReport |
Report of the document verification.
|
| DocumentVerificationStatus |
Overall status of the document verification.
|
| EncodeImageOptions |
Options for encoding image.
|
| EncodingFormat |
Image Encoding Format.
|
| EuropeanHealthInsuranceCardConfiguration |
European Health Insurance Card (EHIC) configuration element.
|
| EuropeanHealthInsuranceCardIssuingCountry |
European Health Insurance Card (EHIC) issuing country.
|
| ExtractedImage |
An image extracted from a multipage image.
|
| ExtractedImageMetadata |
The metadata is taken from the PDF stream's dictionary, not from the image header inside the stream.
|
| ExtractedPage |
A single page extracted from a multipage image.
|
| Feature |
License features.
|
| Field |
Generic document field.
|
| FieldConsistencyVerificationReport |
Report of the field consistency verification.
|
| FieldDataFormat |
Type of parsing applied to field.
|
| 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.
|
| FieldValidationStatus |
Field validation status.
|
| FieldValueSemantics |
Report of the field value semantics verification.
|
| GenericDocument |
Generic document.
|
| GenericDocumentType |
Generic Document Type.
|
| GlareDetectionConfiguration |
Glare detection configuration.
|
| Glyph |
Represents a single glyph, i.e.
|
| GrayscaleFilter |
Converts color images to grayscale and applies autocontrast.
|
| Gs1Handling |
GS1 message handling options.
|
| ImageInfo |
Image Info.
|
| ImageManipulator |
API for image processing.
|
| ImageOrigin |
Location of the image origin in the image coordinate system.
|
| ImageProcessor |
API for image processing.
|
| ImageProfile |
ImageRef profile part specific to image information.
|
| ImageRef |
Represent an image that is backed by native resources and can be created from various sources.
|
| ImageRefPoolSnapshot |
Snapshot of all alive ImageRefs.
|
| ImageRefPoolSnapshotsDiff |
difference between two snapshots.
|
| ImageRefProfile |
ImageRef profile which provides detailed information about stored object.
|
| ImageRefProfiler |
ImageRef memory profiler.
|
| ImageRotation |
Image rotation.
|
| ImageSource |
Description of source from which the ImageRef was created.
|
| ImageSourceType |
The type of source which originated the underlying image.
|
| InvalidDataException |
Exception that is thrown if the data to be processed is invalid
|
| InvalidDataVerificationReport |
Report of the field validation verification.
|
| InvalidImageRefException |
Exception that is thrown if an image ref is invalid
|
| LegacyFilter |
Deprecated.
|
| LicenseException |
Exception that is thrown if license is invalid or the requested operation is not available under used license
|
| LicenseInfo |
Information about the SDK license.
|
| LicenseStatus |
Status of the license plate scanner.
|
| Line |
Represents a single line.
|
| LineSegmentFloat |
Represents a line segment in 2D space.
|
| LineSegmentInt |
Represents a line segment in 2D space.
|
| MapBuilder<K,V> |
Helper class to build HashMaps in a builder pattern style.
|
| MedicalCertificateCheckBox |
Structure to contain full information about found box.
|
| MedicalCertificateCheckBoxType |
Type of the checkbox.
|
| MedicalCertificateDateRecord |
Structure to contain date record information.
|
| MedicalCertificateDateRecordType |
Type of a date record.
|
| MedicalCertificateFormType |
Type of the medical certificate form.
|
| MedicalCertificatePatientInfoBox |
Patient information box.
|
| MedicalCertificatePatientInfoField |
Patient information field.
|
| MedicalCertificatePatientInfoFieldType |
Type of a field in the patient info box.
|
| MedicalCertificateScanner |
API for medical certificate scanning.
|
| MedicalCertificateScanningParameters |
Parameters for the medical certificate scanning.
|
| MedicalCertificateScanningResult |
The result of the medical certificate scanning.
|
| MrzDocumentType |
Type of document containing the MRZ.
|
| MrzFallbackConfiguration |
MRZ fallback configuration element.
|
| MrzIncompleteResultHandling |
Defines how to handle incomplete MRZ results (e.g.
|
| MrzParser |
API for machine readable zone parsing.
|
| MrzParserConfiguration |
Configuration for MRZ parser.
|
| MrzScanner |
API for machine readable zone scanning.
|
| MrzScannerConfiguration |
Configuration for MRZ scanner.
|
| MrzScannerResult |
Container for result of MRZ scanning attempt.
|
| MsiPlesseyChecksumAlgorithm |
Checksum algorithm for MSI_PLESSEY.
|
| MultiPageImageExtractor |
API for extracting images from multi-page images (PDF, TIFF) and single-page images (JPEG, PNG).
|
| OcrElement |
Base class for units of text, e.g.
|
| OcrEngine |
API for optical character recognition.
|
| OcrResult |
Result of OCR text recognition.
|
| OutputMode |
Output mode of binarization filter.
|
| Page |
Represents result of performing OCR on an image.
|
| PageBinarization |
Binarization behavior to apply when adding a page to a PDF/TIFF.
|
| PageDirection |
Page direction.
|
| PageExtractionResult |
Result of the extraction of pages from a multipage image.
|
| PageFit |
Page fit.
|
| PageSize |
Page size.
|
| ParametricFilter |
Base class for all parametric filters.
|
| PartiallyVisibleDocumentConfiguration |
Configuration for handling partially visible documents.
|
| PathImageLoadOptions |
Options for loading image from path.
|
| PathLoadMode |
Image Ref Path Load Mode.
|
| PatternContentValidator |
Pattern content validator.
|
| PatternGrammar |
Grammar of pattern matching.
|
| 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.
|
| Point |
Represents a point with integer coordinates in 2D space.
|
| PointF |
Represents a point with float coordinates in 2D space.
|
| ProcessingMode |
Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.
|
| RandomAccessSource |
RandomAccessSource is a wrapper around a native memory-mapped file or byte array.
|
| RangeEncoding |
A character encoding for a given range of bytes.
|
| RawImageLoadOptions |
Options for loading images that come from sensor.
|
| Rectangle |
Represents a rectangle with integer coordinates in 2D space.
|
| RectangleF |
Represents a rectangle with float coordinates in 2D space.
|
| RefCountedObjectProfile |
Profile info of a reference-counted stored object.
|
| ResamplingMethod |
Resampling method.
|
| ResultAccumulationConfiguration |
Configuration for how to accumulate results.
|
| SaveImageOptions |
Options for saving image to a path.
|
| ScanbotBinarizationFilter |
Automatic binarization filter.
|
| ScanbotSDK |
The class is responsible for initializing the Scanbot SDK functionality and managing global SDK settings.
|
| SemanticsVerificationReport |
Report of the document value semantics verification.
|
| StructuredAppendInfo |
The structured append mode can be used to split a message across multiple barcodes.
|
| SuspiciousDataVerificationReport |
Report of the suspicious data document verification.
|
| SymbolBox |
Structure containing recognized symbol text and bounds.
|
| TensorRtAccelerator |
TensorRT accelerator.
|
| TextPatternScanner |
API for text pattern scanning.
|
| TextPatternScannerConfiguration |
Configuration for the text pattern scanner.
|
| TextPatternScannerResult |
The result of the text line recognition.
|
| TiffGeneratorParameters |
TIFF generator parameters.
|
| UpcEanExtensionBehavior |
Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions.
|
| 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.
|
| ValueConsistency |
The status of the consistency verification.
|
| ValueSemantics |
The result of the value semantics verification.
|
| VinBarcodeExtractionStatus |
Status of the barcode extraction.
|
| VinBarcodeResult |
Result of the barcode scanner.
|
| VinScanner |
API for VIN scanning.
|
| VinScannerConfiguration |
Configuration for the VIN 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.
|
| WordBox |
Structure containing recognized word text and bounds.
|