dot-face-lite/com.innovatrics.dot.face.lite.autocapture.ui/BaseFaceAutoCaptureFragment

BaseFaceAutoCaptureFragment

abstract class BaseFaceAutoCaptureFragment(@LayoutRes contentLayoutId: Int = R.layout.dot_face_fragment_base_face_auto_capture) : FaceCameraPreviewFragment

Base UI Face Auto Capture component.

A visual component for capturing good quality images of a human face. This component primarily focuses on the camera preview functionality. It is intended to be used as a base for custom UI. If you prefer a ready-to-use UI component, use FaceAutoCaptureFragment instead.

To implement a custom UI, you need to pass your layout resource using a constructor argument contentLayoutId and include a layout from DOT SDK. Use this snippet in your custom layout XML file:

<include layout="@layout/dot_face_fragment_base_face_auto_capture" />

After including the default layout, you can add your custom UI elements (e.g. instructions, buttons, etc.) to your layout XML file.

Inheritors

FaceAutoCaptureFragment

Constructors

BaseFaceAutoCaptureFragment

constructor(@LayoutRes contentLayoutId: Int = R.layout.dot_face_fragment_base_face_auto_capture)

Types

Configuration

data class Configuration(val common: CommonConfiguration = CommonConfiguration(), val camera: CameraConfiguration = CameraConfiguration( facing = CameraFacing.FRONT, ), val autoCapture: AutoCaptureConfiguration = AutoCaptureConfiguration( minValidSamplesInRowToStartCandidateSelection = FaceAutoCaptureController.Configuration.DEFAULT_MIN_VALID_SAMPLES_IN_ROW_TO_START_CANDIDATE_SELECTION, candidateSelectionDurationMillis = FaceAutoCaptureController.Configuration.DEFAULT_CANDIDATE_SELECTION_DURATION_MILLIS, ), val qualityAttributeThresholds: QualityAttributeThresholds = QualityAttributeThresholds.Presets.standard, val captureMode: CaptureMode = CaptureMode.AUTO_CAPTURE)

Configuration for the UI Face Auto Capture component.

Functions

onFinished

open fun onFinished(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.

onUiStateUpdated