| ▼Nscanbotsdk | |
| ▼Napi | |
| ▼Nbarcode | |
| ►Nbarcode_configuration_types | |
| CAustraliaPostCustomerFormat | Can be either numeric or alphanumeric and is only relevant for Format Codes 59 and 62 |
| CBarcodeFormatAustraliaPostConfiguration | Australia Post barcode configuration |
| CBarcodeFormatAztecConfiguration | Aztec configuration |
| CBarcodeFormatCodabarConfiguration | Codabar barcode configuration |
| CBarcodeFormatCode11Configuration | Code 11 barcode configuration |
| CBarcodeFormatCode128Configuration | Code 128 barcode configuration |
| CBarcodeFormatCode2Of5Configuration | Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig) |
| CBarcodeFormatCode39Configuration | Code 39 barcode and derivatives configuration |
| CBarcodeFormatCode93Configuration | Code 93 barcode configuration |
| CBarcodeFormatCommonConfiguration | Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration |
| CBarcodeFormatCommonFourStateConfiguration | Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration |
| CBarcodeFormatCommonOneDConfiguration | Convenience configuration for enabling the scanning of multiple linear (1D) barcode formats with a common configuration |
| CBarcodeFormatCommonTwoDConfiguration | Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration |
| CBarcodeFormatConfigurationBase | Base class for all barcode configurations |
| CBarcodeFormatDataBarConfiguration | GS1 DataBar barcode configuration |
| CBarcodeFormatDataBarExpandedConfiguration | GS1 DataBar Expanded barcode configuration |
| CBarcodeFormatDataBarLimitedConfiguration | GS1 DataBar Limited barcode configuration |
| CBarcodeFormatDataMatrixConfiguration | DataMatrix configuration |
| CBarcodeFormatFourStateConfigurationBase | Base class for all four-state barcode configurations |
| CBarcodeFormatGs1CompositeConfiguration | GS1 Composite configuration |
| CBarcodeFormatItfConfiguration | ITF (Interleaved 2-of-5) barcode configuration |
| CBarcodeFormatJapanPostConfiguration | Japan Post barcode configuration |
| CBarcodeFormatMaxiCodeConfiguration | MaxiCode configuration |
| CBarcodeFormatMicroPdf417Configuration | MicroPDF417 configuration |
| CBarcodeFormatMsiPlesseyConfiguration | MSI Plessey barcode configuration |
| CBarcodeFormatOneDConfigurationBase | Base class for all linear (1D) barcode configurations |
| CBarcodeFormatPdf417Configuration | PDF417 configuration |
| CBarcodeFormatPharmaCodeConfiguration | PharmaCode barcode configuration |
| CBarcodeFormatPharmaCodeTwoTrackConfiguration | PHARMA_CODE_TWO_TRACK barcode configuration |
| CBarcodeFormatQrCodeConfiguration | QR Code configuration |
| CBarcodeFormatRoyalMailConfiguration | Royal Mail barcode configuration |
| CBarcodeFormatRoyalTntPostConfiguration | Royal TNT Post barcode configuration |
| CBarcodeFormatTwoDConfigurationBase | Base class for all 2D barcode configurations |
| CBarcodeFormatUpcEanConfiguration | UPC/EAN barcode configuration |
| CBarcodeFormatUspsIntelligentMailConfiguration | USPS Intelligent Mail barcode configuration |
| CMsiPlesseyChecksumAlgorithm | Checksum algorithm for MSI_PLESSEY |
| ►Nbarcode_document_parser | |
| CBarcodeDocumentParser | API for parsing barcode documents |
| ►Nbarcode_document_types | |
| CBarcodeDocumentFormat | Type of barcode document format used |
| CBarcodeDocumentFormats | Barcode document formats |
| CBarcodeDocumentParserResult | The result of barcode document parsing |
| ►Nbarcode_scanner | |
| CBarcodeScanner | API for barcode scanning |
| ►Nbarcode_scanner_types | |
| CBarcodeAccumulationConfiguration | Configuration for how to accumulate results |
| CBarcodeAccumulationMethod | The method how to display barcodes from previous frames |
| CBarcodeItem | A single barcode found in the input image |
| CBarcodeScannerConfiguration | Configuration for the barcode scanner |
| CBarcodeScannerEngineMode | The engine mode for barcode scanning |
| CBarcodeScannerResult | The result of barcode scanning |
| CBarcodeSelectionConfiguration | Configuration for how to select barcode results |
| CBarcodeSelectionMethod | The method used to select barcodes |
| ►Nbarcode_types | |
| CBarcodeDefectProfile | Specifies the types of defects expected when scanning barcodes |
| CBarcodeFormat | Enumerates barcode formats |
| CBarcodeFormats | Lists of barcode formats to decode |
| CCharacterEncoding | Enumerates character encodings |
| CConfigState | Specify whether a field should be enabled, disabled, or inherited |
| CGs1Handling | GS1 message handling options |
| COneDConfirmationMode | Allows to select the balance between result accuracy (precision) and missed barcodes (recall) for linear barcodes |
| CRangeEncoding | A character encoding for a given range of bytes |
| CStructuredAppendInfo | The structured append mode can be used to split a message across multiple barcodes |
| CTwoDDecodingMode | Allows to select the decoding effort to be spent on decoding 2D barcodes |
| CUpcEanExtensionBehavior | Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions |
| ▼Ncheck | |
| ►Ncheck_scanner | |
| CCheckScanner | API for check scanning |
| ►Ncheck_scanner_types | |
| CCheckDocumentDetectionMode | Check document detection and extraction mode |
| CCheckMagneticInkStripScanningStatus | Check magnetic ink (MICR) strip scanning status |
| CCheckScannerConfiguration | Configuration of the check scanner |
| CCheckScanningResult | The result of check scanning |
| CCheckStandard | Supported check standards |
| ▼Ncommon | |
| ►Ncommon_types | |
| CProcessingMode | Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it |
| ▼Ncredit_card | |
| ►Ncredit_card_scanner | |
| CCreditCardScanner | API for credit card scanning |
| ►Ncredit_card_types | |
| CCreditCardScannerConfiguration | Configuration for the credit card scanner |
| CCreditCardScanningResult | Contains the result of running the credit card scanner |
| CCreditCardScanningStatus | The status of the scanning process |
| ▼Ndocument_data | |
| ►Ndocument_data_extractor | |
| CDocumentDataExtractor | API for extracting data from documents |
| ►Ndocument_data_extractor_configuration_types | |
| CAutoFocusConfiguration | Auto-focus configuration |
| CDateValidationConfiguration | Date validation configuration |
| CDeAddressParserConfiguration | German Address Field validation configuration |
| CDocumentDataExtractorCommonConfiguration | Convenience configuration element for enabling the scanning of multiple document types with a common configuration |
| CDocumentDataExtractorConfigurationElement | Base class for all document data extraction configuration elements |
| CEuropeanHealthInsuranceCardConfiguration | European Health Insurance Card (EHIC) configuration element |
| CEuropeanHealthInsuranceCardIssuingCountry | European Health Insurance Card (EHIC) issuing country |
| CGlareDetectionConfiguration | Glare detection configuration |
| CMrzFallbackConfiguration | MRZ fallback configuration element |
| ►Ndocument_data_extractor_types | |
| CCompositeFieldValueSemantics | Report of a logical field value semantics verification |
| CConsistencyVerificationReport | Report of the document consistency verification |
| CDocumentDataExtractionResult | Contains the result of running the document data extractor |
| CDocumentDataExtractionStatus | The status of the extraction process |
| CDocumentDataExtractorConfiguration | Configuration for the document data extractor |
| CDocumentTrustMode | Level of trust in the authenticity of the extracted document |
| CDocumentVerificationReport | Report of the document verification |
| CDocumentVerificationStatus | Overall status of the document verification |
| CFieldConsistencyVerificationReport | Report of the field consistency verification |
| CFieldInvalidDataVerificationReport | Report which shows whether the data in the field that can be validated is valid |
| CFieldSuspiciousDataVerificationReport | Report of the suspicious data field verification |
| CFieldValueSemantics | Report of the field value semantics verification |
| CInvalidDataVerificationReport | Report of the field validation verification |
| CSemanticsVerificationReport | Report of the document value semantics verification |
| CSuspiciousDataVerificationReport | Report of the suspicious data document verification |
| CValueConsistency | The status of the consistency verification |
| CValueSemantics | The result of the value semantics verification |
| ▼Ndocument_quality_analyzer | |
| ►Ndocument_quality_analyzer | |
| CDocumentQualityAnalyzer | API for analyzing document quality |
| ►Ndocument_quality_analyzer_types | |
| CCharacterLevelAnnotation | Character level annotation, contains information about the quality of a character in the document |
| CCharacterLevelAnnotations | Character level annotations, contains information about each character in the document |
| CDocumentQuality | Result of document quality analysis |
| CDocumentQualityAnalyzerCompatibilityMode | Compatibility mode for the Document Quality Analyzer |
| CDocumentQualityAnalyzerCompatibilityModeConfiguration | Configuration for the compatibility mode of the Document Quality Analyzer |
| CDocumentQualityAnalyzerConfiguration | Document Quality Analyzer configuration |
| CDocumentQualityAnalyzerResult | Result of document quality analysis |
| CDocumentQualityAnalyzerTrainingData | Contains all the data needed to train a Document Quality Analyzer |
| CDocumentQualityAssessment | Result of document quality analysis |
| CDocumentQualityThreshold | Point in the quality-number of symbols space to separate quality levels |
| CProcessByTileConfiguration | Configuration for processing image by tiles |
| ▼Ndocument_quality_analyzer_configurator | |
| ►Ndocument_quality_analyzer_training_data_annotator | |
| CDocumentQualityAnalyzerTrainingDataAnnotator | API for generating annotations that can be used to create custom document quality analyzer configurations |
| ▼Ndocument_scanner | |
| ►Ndocument_scanner | |
| CDocumentScanner | API for document detection and scanning |
| ►Ndocument_scanner_types | |
| CDocumentDetectionResult | Result of the document contour detection |
| CDocumentDetectionScores | The total and partial scores for the detected document contour |
| CDocumentDetectionStatus | Status of the document detection |
| CDocumentDisplacement | The direction towards the center of the document if the document is partially visible |
| CDocumentScannerConfiguration | Configuration for the document scanner |
| CDocumentScannerEngineMode | Engines for document scanning |
| CDocumentScannerParameters | Parameters for the document scanner |
| CDocumentScanningResult | Result of the document detection followed by cropping of the found document |
| CPartiallyVisibleDocumentConfiguration | Configuration for handling partially visible documents |
| ►Ndocument_straightener | |
| CDocumentStraightener | Provides functionality to straighten document photos by eliminating physical deformations and surface warping, such as folds, creases, wrinkles, crumples, page and geometric bends |
| ►Ndocument_straightener_types | |
| CDocumentStraighteningMode | Type of document straightening to apply |
| CDocumentStraighteningParameters | Configuration for document straightening |
| CDocumentStraighteningResult | Result of the document straightening |
| ▼Nframe_accumulation | |
| ►Nframe_accumulation_types | |
| CAccumulatedResultsVerifierConfiguration | Configure the frame accumulation process |
| CConfirmationMethod | Method used to confirm a result |
| CResultAccumulationConfiguration | Configuration for how to accumulate results |
| ▼Ngeneric_document | |
| ►Ncommon_field_type | |
| CCommonFieldType | Common field types |
| ►Ngeneric_document | |
| CField | Generic document field |
| CFieldDataFormat | Type of parsing applied to field |
| CFieldParsedData | Parsed data |
| CFieldType | Generic Document Type |
| CFieldValidationStatus | Field validation status |
| CGenericDocument | Generic document |
| CGenericDocumentType | Generic Document Type |
| COcrResult | Result of OCR text recognition |
| ▼Ngeometry | |
| ►Ngeometry | |
| CAspectRatio | Aspect ratio is the ratio of the width to the height of an image or screen |
| CLineSegmentFloat | Represents a line segment in 2D space |
| CLineSegmentInt | Represents a line segment in 2D space |
| ▼Nimage | |
| ►Nimage_ref_profiler | |
| CImageRefProfiler | ImageRef memory profiler |
| ►Nimage_ref_types | |
| CBasicImageLoadOptions | Basic options for loading image |
| CBufferImageLoadOptions | Options for loading image from buffer |
| CBufferLoadMode | Image Ref Buffer Load Mode |
| CCanvasColor | Canvas color to use when converting images with alpha channel to images without alpha channel |
| CColorConversion | Color conversion to apply during image loading |
| CEncodeImageOptions | Options for encoding image |
| CEncodingFormat | Image Encoding Format |
| CImageInfo | Image Info |
| CImageProfile | ImageRef profile part specific to image information |
| CImageRefPoolSnapshot | Snapshot of all alive ImageRefs |
| CImageRefPoolSnapshotsDiff | Difference between two snapshots |
| CImageRefProfile | ImageRef profile which provides detailed information about stored object |
| CImageSource | Description of source from which the ImageRef was created |
| CImageSourceType | The type of source which originated the underlying image |
| CPathImageLoadOptions | Options for loading image from path |
| CPathLoadMode | Image Ref Path Load Mode |
| CRawImageLoadOptions | Options for loading images that come from sensor |
| CSaveImageOptions | Options for saving image to a path |
| ►Nimage_types | |
| CImageOrigin | Location of the image origin in the image coordinate system |
| CImageRotation | Image rotation |
| ▼Nimage_manipulation | |
| ►Nimage_manipulator | |
| CImageManipulator | API for image processing |
| ▼Nimage_processing | |
| ►Ndocument_cleanup | |
| CDocumentCleanup | API for document cleanup |
| ►Ndocument_cleanup_types | |
| CDocumentCleanupConfiguration | The document cleanup configuration |
| CDocumentCleanupResult | Result of a document cleanup run |
| CDocumentCleanupStatus | Status of the document cleanup operation |
| ►Nimage_processor | |
| CImageProcessor | API for image processing |
| ►Nimage_processor_types | |
| CDocumentCropOptimization | Optimizations applied when cropping physical documents from a larger photo |
| ►Nparametric_filters | |
| CBinarizationFilterPreset | Preset of parameters for custom binarization filter |
| CBrightnessFilter | Brightness adjustment filter |
| CColorDocumentFilter | Color document filter |
| CColorDocumentShadowRemovalFilter | Color document shadow removal filter |
| CContrastFilter | Contrast adjustment filter |
| CCustomBinarizationFilter | Automatic binarization filter |
| CGrayscaleFilter | Converts color images to grayscale and applies autocontrast |
| CLegacyFilter | Deprecated |
| COutputMode | Output mode of binarization filter |
| CPageBinarization | Binarization behavior to apply when adding a page to a PDF/TIFF |
| CParametricFilter | Base class for all parametric filters |
| CScanbotBinarizationFilter | Automatic binarization filter |
| CWhiteBlackPointFilter | 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 |
| ▼Nlicensing | |
| ►Nlicensing_types | |
| CDeviceDeregistrationError | Description of error that occurred during device deregistration |
| CFeature | License features |
| CLicenseInfo | Information about the SDK license |
| CLicenseStatus | Status of the license plate scanner |
| ▼Nmedical_certificate | |
| ►Nmedical_certificate_scanner | |
| CMedicalCertificateScanner | API for medical certificate scanning |
| ►Nmedical_certificate_types | |
| CMedicalCertificateCheckBox | Structure to contain full information about found box |
| CMedicalCertificateCheckBoxType | Type of the checkbox |
| CMedicalCertificateDateRecord | Structure to contain date record information |
| CMedicalCertificateDateRecordType | Type of a date record |
| CMedicalCertificateFormType | Type of the medical certificate form |
| CMedicalCertificatePatientInfoBox | Patient information box |
| CMedicalCertificatePatientInfoField | Patient information field |
| CMedicalCertificatePatientInfoFieldType | Type of a field in the patient info box |
| CMedicalCertificateScanningParameters | Parameters for the medical certificate scanning |
| CMedicalCertificateScanningResult | The result of the medical certificate scanning |
| ▼Nml | |
| ►Naccelerator_types | |
| CAccelerator | Accelerator to use for running machine learning models |
| CTensorRtAccelerator | TensorRT accelerator |
| ▼Nmrz | |
| ►Nmrz_scanner | |
| CMrzParser | API for machine readable zone parsing |
| CMrzScanner | API for machine readable zone scanning |
| ►Nmrz_types | |
| CMrzDocumentType | Type of document containing the MRZ |
| CMrzIncompleteResultHandling | Defines how to handle incomplete MRZ results (e.g |
| CMrzParserConfiguration | Configuration for MRZ parser |
| CMrzScannerConfiguration | Configuration for MRZ scanner |
| CMrzScannerResult | Container for result of MRZ scanning attempt |
| ▼Nmulti_page_image_extractor | |
| ►Nmulti_page_image_extractor | |
| CMultiPageImageExtractor | API for extracting images from multi-page images (PDF, TIFF) and single-page images (JPEG, PNG) |
| ►Nmulti_page_image_extractor_types | |
| CExtractedImage | An image extracted from a multipage image |
| CExtractedImageMetadata | The metadata is taken from the PDF stream's dictionary, not from the image header inside the stream |
| CExtractedPage | A single page extracted from a multipage image |
| CPageExtractionResult | Result of the extraction of pages from a multipage image |
| ▼Nocr | |
| ►Nocr_engine | |
| COcrEngine | API for optical character recognition |
| ►Nocr_types | |
| CBlock | Represents a single block, e.g |
| CGlyph | Represents a single glyph, i.e |
| CLine | Represents a single line |
| COcrElement | Base class for units of text, e.g |
| CPage | Represents result of performing OCR on an image |
| CWord | Represents a single word |
| ▼Npdf_generation | |
| ►Npdf_configuration_types | |
| CPageDirection | Page direction |
| CPageFit | Page fit |
| CPageSize | Page size |
| CPdfAttributes | PDF attributes |
| CPdfConfiguration | The parameters pageSize, pageFit, dpi and resamplingMethod interact in a complex way when adding bitmap images (JPEG, PNG, or raw) to the PDF |
| CResamplingMethod | Resampling method |
| ▼Ntext_pattern | |
| ►Ntext_pattern_scanner | |
| CTextPatternScanner | API for text pattern scanning |
| ►Ntext_pattern_scanner_types | |
| CContentValidator | Base class for content validators |
| CDefaultContentValidator | Default content validator |
| CPatternContentValidator | Pattern content validator |
| CPatternGrammar | Grammar of pattern matching |
| CSymbolBox | Structure containing recognized symbol text and bounds |
| CTextPatternScannerConfiguration | Configuration for the text pattern scanner |
| CTextPatternScannerResult | The result of the text line recognition |
| CWordBox | Structure containing recognized word text and bounds |
| ▼Ntiff_generation | |
| ►Ntiff_types | |
| CCompressionMode | TIFF compression type |
| CTiffGeneratorParameters | TIFF generator parameters |
| CUserField | User-defined TIFF field |
| CUserFieldDoubleValue | Double value (TIFF_DOUBLE) |
| CUserFieldIntValue | 32-bit int value (TIFF_LONG) |
| CUserFieldStringValue | ASCII string value (TIFF_ASCII) |
| CUserFieldValue | User-defined TIFF field value |
| ▼Nutils | |
| ►Nobject_pool_types | |
| CRefCountedObjectProfile | Profile info of a reference-counted stored object |
| ▼Nvin | |
| ►Nvin_scanner | |
| CVinScanner | API for VIN scanning |
| ►Nvin_scanner_types | |
| CVinBarcodeExtractionStatus | Status of the barcode extraction |
| CVinBarcodeResult | Result of the barcode scanner |
| CVinScannerConfiguration | Configuration for the VIN scanner |
| CVinScannerResult | Result of the VIN scanner |
| ▼Nbasic_geometry | |
| CPoint | Represents a point with integer coordinates in 2D space |
| CPointF | Represents a point with floating-point coordinates in 2D space |
| CRectangle | Represents a rectangle with integer coordinates in 2D space |
| CRectangleF | Represents a rectangle with floating-point coordinates in 2D space |
| ▼Nerror | |
| CComponentUnavailableError | Exception raised when some required program component is not available |
| CInvalidDataError | Exception raised when invalid data is encountered, e.g |
| CInvalidImageRefError | Exception raised when an operation with an invalid image reference is attempted |
| CInvalidOperationError | Exception raised when an operation is not valid |
| CLicenseError | Exception raised when a license error occurs |
| COperationCanceledError | Exception raised when an asynchronous operation is canceled |
| ▼Nimage_ref | |
| CImageRef | Represents an image that is backed by native resources and can be created from various sources |
| ▼Nrandom_access_source | |
| CRandomAccessSource | |
| ▼Nscanbotsdk | |
| CDeviceSession | |
1.13.2