Configuration

data class Configuration @JvmOverloads constructor(val cameraFacing: CameraFacing = CameraFacing.BACK, val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, val isTorchEnabled: Boolean = false, val validationMode: ValidationMode = ValidationMode.STANDARD, val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard, val isDetectionLayerVisible: Boolean = false, val mrzValidation: MrzValidation = MrzValidation.NONE, val sessionToken: String? = null, val placeholderType: PlaceholderType = PlaceholderType.CORNERS_ONLY)

Configuration for the Document Auto Capture UI component.

Constructors

Link copied to clipboard
fun Configuration(cameraFacing: CameraFacing = CameraFacing.BACK, cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, isTorchEnabled: Boolean = false, validationMode: ValidationMode = ValidationMode.STANDARD, qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard, isDetectionLayerVisible: Boolean = false, mrzValidation: MrzValidation = MrzValidation.NONE, sessionToken: String? = null, placeholderType: PlaceholderType = PlaceholderType.CORNERS_ONLY)

Properties

Link copied to clipboard

Front or back camera facing. Default value is CameraFacing.BACK.

Link copied to clipboard

Camera preview scale type. Default value is CameraPreviewScaleType.FIT.

Link copied to clipboard

If detection UI layer (tracking rectangle) is visible. Default value is false.

Link copied to clipboard
val isTorchEnabled: Boolean = false

If torch is enabled during the process. If the camera doesn't have a flash unit, then this setting will be ignored. Default value is false.

Link copied to clipboard

Configuration of MRZ (Machine Readable Zone) validation mode. Default value is MrzValidation.NONE.

Link copied to clipboard

Sets the type of placeholder used in document auto-capture UI. Default value is PlaceholderType.CORNERS_ONLY.

Link copied to clipboard
Link copied to clipboard
val sessionToken: String? = null

Session token provided by DIS (Digital Identity Service). Set the session token if the result should be posted to DIS for evaluation. Default value is null.

Link copied to clipboard

How strict position validation is. Default value is ValidationMode.STANDARD.