Configuration

data class Configuration @JvmOverloads constructor(val cameraFacing: CameraFacing = CameraFacing.BACK, val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, val torchEnabled: 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.

Parameters

cameraFacing

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

cameraPreviewScaleType

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

torchEnabled

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.

validationMode

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

qualityAttributeThresholds

Quality attribute thresholds. Default value is QualityAttributeThresholdPresets.standard.

isDetectionLayerVisible

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

mrzValidation

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

sessionToken

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.

placeholderType

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

Constructors

Link copied to clipboard
fun Configuration(cameraFacing: CameraFacing = CameraFacing.BACK, cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, torchEnabled: 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
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val sessionToken: String? = null
Link copied to clipboard
val torchEnabled: Boolean = false
Link copied to clipboard