VizModuleSettings

data class VizModuleSettings(val presenceMandatory: Boolean = false, val signatureImageExtractionEnabled: Boolean = false, val characterValidationEnabled: Boolean = true, val resultAggregationEnabled: Boolean? = true) : Parcelable

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.

Constructors

Link copied to clipboard
constructor(presenceMandatory: Boolean = false, signatureImageExtractionEnabled: Boolean = false, characterValidationEnabled: Boolean = true, resultAggregationEnabled: Boolean? = true)

Properties

Link copied to clipboard

Indicates whether character validation is enabled. Allow only results containing expected characters for a given field. Each field is validated against a set of rules. All fields have to be successfully validated in order to successfully scan a document. Setting is used to improve scanning accuracy. If set to true, when an invalid character is detected ProcessingStatus.InvalidCharactersFound is returned. Defaults to true.

Link copied to clipboard

If set to true, Viz presence becomes mandatory for the scanned document. For Single ScanningMode, the Viz must be present on the scanned side. Only the front side of supported documents can be scanned. For Automatic ScanningMode, this setting won't affect the default behaviour; front side must be scanned first followed by the back side. In case of a timeout and advancement to the next step in the scanning flow, if a Viz was not extracted fully from a front side, we'll proceed to extract Viz from the back side, if present. Defaults to false.

Link copied to clipboard

Indicates whether the aggregation of data from multiple input images is enabled. Disabling this setting will yield higher-quality captured images, but it may slow down the scanning process due to the additional effort required to find the optimal image. Enabling this setting will simplify the extraction process, but the extracted data will be aggregated from multiple images instead of being sourced from a single image. This only applies to images from Video input image source - for images from Photo source, setting will be ignored. Defaults to true.

Link copied to clipboard

Enables the extraction of the document's signature image if supported. For supported documents, signature image extraction is determined by document rules. For unsupported documents, extraction won't be performed. Defaults to false.

Functions

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