DocumentCaptureModuleSettings

The sensitivity of blur detection in the document image. Values range from SensitivityLevel.Off (detection not available) to higher sensitivity levels. SensitivityLevel.Low – less sensitive to blur; if something is detected as blur, it is almost certainly actual blur, but some amount of blur may not be detected at all. SensitivityLevel.High – highly sensitive to blur; it may detect as blur even something that only resembles blur. Defaults to SensitivityLevel.Mid.

Controls how the input image is treated with respect to document localization and perspective correction. See InputImageCropType for the available options. InputImageCropType.Cropped and InputImageCropType.Unknown are only applicable to com.microblink.blinkid.core.session.InputImageSource.Photo input sources and will cause a validation error if used with com.microblink.blinkid.core.session.InputImageSource.Video. Defaults to InputImageCropType.NotCropped.

Indicates whether the document image should be returned. Defaults to false.

The DPI value for the cropped document, face, and signature image. Allowed range is 100 to 400. Defaults to 250.

The extension factor for the cropped document image. Applicable only to document images. Allowed range is 0.0 to 1.0. Defaults to 0f.

Enables the extraction of the document's face image. If a face image is present on the document, extraction becomes mandatory if supported. For supported documents, the requirement for its presence is determined by document rules. For unsupported documents, presence is optional. Defaults to false.

If set to true, face image presence will be mandatory for the scanned document. For com.microblink.blinkid.core.session.ScanningMode.Automatic, the document side with the face image must be scanned first. In case of a timeout and advancement to the next step in the scanning flow, if a face image is detected on the scanned side but cannot be extracted, the presence requirement is considered fulfilled. As a result, face image extraction will no longer be a requirement to complete the scan on the next side. Defaults to false.

The sensitivity of glare detection in the document image. Values range from SensitivityLevel.Off (detection not available) to higher sensitivity levels. SensitivityLevel.Low – less sensitive to glare; if something is detected as glare, it is almost certainly actual glare, but some amount of glare may not be detected at all. SensitivityLevel.High – highly sensitive to glare; it may detect as glare even something that only resembles glare. Defaults to SensitivityLevel.Mid.

Indicates whether images with detected blur should be rejected. A value of true means images with detected blur will be excluded from further processing. If blur is detected, ProcessingStatus will be ProcessingStatus.ImagePreprocessingFailed. A value of false means images will be processed even if blur is detected, and the blur status will be reported in the process result. A value of null lets the SDK resolve the value based on other settings. This setting may change after initialization based on other settings. Defaults to null.

Indicates whether images with detected glare should be rejected. A value of true means images with detected glare will be excluded from further processing. If glare is detected, ProcessingStatus will be ProcessingStatus.ImagePreprocessingFailed. A value of false means images will be processed even if glare is detected, and the glare status will be reported in the process result. A value of null lets the SDK resolve the value based on other settings. This setting may change after initialization based on other settings. Defaults to null.

Indicates whether images occluded by a hand should be rejected. A value of true means images occluded by a hand will be excluded from further processing. If hand occlusion is detected, ProcessingStatus will be ProcessingStatus.ImagePreprocessingFailed and hand occlusion status will be reported in the process result. A value of null lets the SDK resolve the value based on other settings. This setting is applicable only if cropType is not InputImageCropType.Cropped. This setting may change after initialization based on other settings. Defaults to null.

Indicates whether images with poor lighting conditions should be rejected. Poor lighting conditions are represented as either too bright or too dark document images. A value of true means images with poor lighting conditions will be excluded from further processing. If poor lighting is detected, ProcessingStatus will be ProcessingStatus.ImagePreprocessingFailed and lighting status will be reported in the process result. Defaults to true.

Defines the minimum required margin (in percentage) between the edge of the input image and the document. This setting is implemented to comply with regulations in certain countries that mandate documents to be stored with adequate margins in the image. The setting is applicable only when using images from a Video source. The recommended value for Video mode is 0.02f. The setting is ignored if cropType is InputImageCropType.Cropped. Allowed range is 0.0 to 1.0. This setting may change after initialization based on other settings. Defaults to null.

Indicates whether input images should be returned in the result. Saves the input images at the moment of data extraction or timeout. This significantly increases memory consumption. Scanning performance is not affected. Defaults to false.

Before selecting the best quality image, a sequence of stable input images must be available. From this pool of input images, the one with the highest quality is selected. An input image is considered stable if the image analysis results are consistent across a consecutive stream of input images. A larger pool size increases the likelihood of capturing a high-quality image but may introduce a slight delay, as more stable input images need to be collected.

Indicates whether only the passport data page should be scanned. Scan only the data page (page containing MRZ) of the passport. If set to false, it will be required to scan the second page of certain passports. Defaults to true.

Indicates whether the back side scan should be skipped if the document supports only image capture on that side. Some documents have a back side that is supported but contains no extractable data (no MRZ, barcode, etc.). These sides will be "captured only". If set to true, the scanning process will stop after the front side for such documents. If set to false, the back side will be captured, even though no data extraction is performed. Defaults to true.

The sensitivity of allowed detected tilt of the document in the image. Values range from SensitivityLevel.Off (detection not available) to higher sensitivity levels. SensitivityLevel.Low – less sensitive to tilt. SensitivityLevel.High – highly sensitive to tilt. Defaults to SensitivityLevel.Mid.

Enables the scanning and processing of unsupported document types. A document is considered unsupported if its classification result is OTHER. Defaults to false.