Configuration

data class Configuration @JvmOverloads constructor(val cameraFacing: CameraFacing = CameraFacing.FRONT, val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT, val isTorchEnabled: Boolean = false, val faceSizeRatioInterval: IntervalDouble = IntervalDouble(0.1, 0.3), val query: FaceDetectionQuery = FaceDetectionQuery(), val sessionToken: String? = null)

Configuration for the Face Simple Capture UI component.

See also

face size ratio definition.

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.

faceSizeRatioInterval

Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].

query

Query for extra evaluations. It allows for additional processing beyond basic face detection. The default, FaceDetectionQuery, signifies no extra evaluations and is optimized for speed.

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, faceSizeRatioInterval: IntervalDouble = IntervalDouble(0.1, 0.3), query: FaceDetectionQuery = FaceDetectionQuery(), sessionToken: String? = null)

Properties

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