Configuration

data class Configuration @JvmOverloads constructor(val cameraFacing: CameraFacing = CameraFacing.FRONT, val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, val isTorchEnabled: Boolean = false, val captureMode: CaptureMode = CaptureMode.AUTO_CAPTURE, val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard, val isPlaceholderVisible: Boolean = true, val isDetectionLayerVisible: Boolean = false, val sessionToken: String? = null)

Configuration for the Face Auto Capture UI component.

Parameters

cameraFacing

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

cameraPreviewScaleType

The camera preview scale type. Default value is CameraPreviewScaleType.FIT.

isTorchEnabled

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.

captureMode

Capture mode. Default value is CaptureMode.AUTO_CAPTURE.

qualityAttributeThresholds

Quality attribute thresholds. Default value is QualityAttributeThresholdPresets.standard.

isPlaceholderVisible

If placeholder for the face is visible. Default value is true.

isDetectionLayerVisible

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

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.

Constructors

Link copied to clipboard
fun Configuration(cameraFacing: CameraFacing = CameraFacing.FRONT, cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, isTorchEnabled: Boolean = false, captureMode: CaptureMode = CaptureMode.AUTO_CAPTURE, qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard, isPlaceholderVisible: Boolean = true, isDetectionLayerVisible: Boolean = false, sessionToken: String? = null)

Types

Link copied to clipboard
object Presets

Pre-defined sets of configurations.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val isTorchEnabled: Boolean = false
Link copied to clipboard
val sessionToken: String? = null