ScanningSettings

data class ScanningSettings(val documentCaptureModule: DocumentCaptureModuleSettings? = DocumentCaptureModuleSettings(), val barcodeModule: BarcodeModuleSettings? = BarcodeModuleSettings(), val mrzModule: MrzModuleSettings? = MrzModuleSettings(), val vizModule: VizModuleSettings? = VizModuleSettings(), val maxAllowedMismatchesPerField: UInt) : Parcelable

Represents the configurable settings for scanning a document.

This structure allows for the granular configuration of different extraction modules, enabling or disabling specific features based on the scanning use case.

Constructors

Link copied to clipboard
constructor(documentCaptureModule: DocumentCaptureModuleSettings? = DocumentCaptureModuleSettings(), barcodeModule: BarcodeModuleSettings? = BarcodeModuleSettings(), mrzModule: MrzModuleSettings? = MrzModuleSettings(), vizModule: VizModuleSettings? = VizModuleSettings(), maxAllowedMismatchesPerField: UInt)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Settings for the barcode extraction module. This module manages the detection and data extraction from various 1D and 2D barcode formats (such as PDF417, QR codes, and various retail codes). It can operate as a standalone module or in combination with document capture.

Link copied to clipboard

Settings for the document capture module. This module is responsible for the initial document detection, image extraction (such as face and document images), and image quality validation (blur, glare, and lighting checks).

Link copied to clipboard

The maximum allowed mismatches per field during data matching. Configures the maximum number of characters per field that can be inconsistent during data matching. By default, no mismatches are allowed.

Link copied to clipboard

Settings for the MRZ (Machine Readable Zone) extraction module. This module is dedicated to the detection and parsing of machine-readable zone typically found on passports, visas, and identity cards.

Link copied to clipboard

Settings for the VIZ (Visual Inspection Zone) extraction module. This module is responsible for extracting data from the document's visual fields. It supports features such as character validation for increased accuracy, signature image extraction, and data aggregation across multiple video frames.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)