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

FaceAutoCaptureFragment

abstract class FaceAutoCaptureFragment : CameraPreviewFragment

Face Auto Capture UI component.

A visual component for capturing good quality images of a human face.

Constructors

fun FaceAutoCaptureFragment()

Types

Companion

object Companion

Configuration

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

Configuration for the Face Auto Capture UI component.

Functions

onCaptured

abstract fun onCaptured(result: FaceAutoCaptureResult)

Called only once for the whole process, when the final face image candidate has been chosen. Once this callback is called, the whole process is considered to be over.

onProcessed

abstract fun onProcessed(detection: FaceAutoCaptureDetection)

Called when a camera image is processed.

provideConfiguration

open fun provideConfiguration(): FaceAutoCaptureFragment.Configuration

Subclasses should override this method to provide Configuration for the Face Auto Capture UI component.

requestCapture

@JvmOverloads

fun requestCapture(isFacePresenceRequired: Boolean = false)

Request capture event asynchronously.

start

fun start()

Start the process.

stopAsync

fun stopAsync(onStopped: () -> Unit)

Stop the process asynchronously.