dot-face-core/com.innovatrics.dot.face.autocapture/FaceAutoCaptureFragment/Configuration

Configuration

data class Configuration @JvmOverloads constructor(    val cameraFacing: CameraFacing = CameraFacing.FRONT,     val cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT,     val isTorchEnabled: Boolean = false,     val isVideoCaptureEnabled: Boolean = false,     val faceSizeRatioInterval: IntervalDouble = FaceAutoCaptureController.Configuration.DEFAULT_FACE_SIZE_RATIO_INTERVAL,     val captureMode: CaptureMode = CaptureMode.AUTO_CAPTURE,     val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard,     val minValidFramesInRowToStartCandidateSelection: Int = FaceAutoCaptureController.Configuration.DEFAULT_MIN_VALID_FRAMES_IN_ROW_TO_START_CANDIDATE_SELECTION,     val candidateSelectionDurationMillis: Int = FaceAutoCaptureController.Configuration.DEFAULT_CANDIDATE_SELECTION_DURATION_MILLIS,     val isPlaceholderVisible: Boolean = true,     val isDetectionLayerVisible: Boolean = false,     val query: FaceDetectionQuery = FaceDetectionQuery(),     val sessionToken: String? = null,     val isCameraPreviewVisible: Boolean = true)

Configuration for the Face Auto Capture UI component.

See also

face size ratio definition.

Constructors

Link copied to clipboard
@JvmOverloads
fun Configuration(    cameraFacing: CameraFacing = CameraFacing.FRONT,     cameraPreviewScaleType: CameraPreviewScaleType = CameraPreviewScaleType.FIT,     isTorchEnabled: Boolean = false,     isVideoCaptureEnabled: Boolean = false,     faceSizeRatioInterval: IntervalDouble = FaceAutoCaptureController.Configuration.DEFAULT_FACE_SIZE_RATIO_INTERVAL,     captureMode: CaptureMode = CaptureMode.AUTO_CAPTURE,     qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholdPresets.standard,     minValidFramesInRowToStartCandidateSelection: Int = FaceAutoCaptureController.Configuration.DEFAULT_MIN_VALID_FRAMES_IN_ROW_TO_START_CANDIDATE_SELECTION,     candidateSelectionDurationMillis: Int = FaceAutoCaptureController.Configuration.DEFAULT_CANDIDATE_SELECTION_DURATION_MILLIS,     isPlaceholderVisible: Boolean = true,     isDetectionLayerVisible: Boolean = false,     query: FaceDetectionQuery = FaceDetectionQuery(),     sessionToken: String? = null,     isCameraPreviewVisible: Boolean = true)

Types

Link copied to clipboard
object Presets

Pre-defined sets of configurations.

Properties

Link copied to clipboard
val cameraFacing: CameraFacing

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

Link copied to clipboard
val cameraPreviewScaleType: CameraPreviewScaleType

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

Link copied to clipboard
val candidateSelectionDurationMillis: Int

Duration of candidate selection in milliseconds. Value must be greater than or equal to 0. Default value is 2_000.

Link copied to clipboard
val captureMode: CaptureMode

Capture mode. Default value is CaptureMode.AUTO_CAPTURE.

Link copied to clipboard
val faceSizeRatioInterval: IntervalDouble

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

Link copied to clipboard
val isCameraPreviewVisible: Boolean = true

If camera preview is visible. Default value is true.

Link copied to clipboard
val isDetectionLayerVisible: Boolean = false

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

Link copied to clipboard
val isPlaceholderVisible: Boolean = true

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

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
val isVideoCaptureEnabled: Boolean = false

If video capture is enabled. When enabled, the recording duration is limited to a maximum of 8 seconds, corresponding to the end of the processing session. The captured video is included exclusively in the binary content of the result. Default value is false.

val minValidFramesInRowToStartCandidateSelection: Int

Minimum number of valid frames in a row to start candidate selection. Value must be greater than or equal to 1. Default value is 2.

Link copied to clipboard
Link copied to clipboard
val query: FaceDetectionQuery

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.

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.