dot_face_core library
IDV Face Core plugin.
Classes
- AutoCaptureConfiguration
- Configuration for auto capture components.
- BaseFaceAutoCaptureWidgetConfiguration
- Base configuration for the UI Face Auto Capture component (FaceAutoCaptureWidget).
- CameraConfiguration
- Configuration for components utilizing a camera.
- CommonConfiguration
- Common configuration for all components.
- DetectionPosition
- Position of the detected face in the image.
- DotFaceBackgroundUniformityModuleConfiguration
- Face background uniformity module configuration.
- DotFaceDetectionBalancedModuleConfiguration
- Face detection balanced module configuration.
- DotFaceDetectionFastModuleConfiguration
- Face detection fast module configuration.
- DotFaceDetectionModuleConfiguration
- Face detection module configuration.
- DotFaceExpressionNeutralModuleConfiguration
- Face expression neutral module configuration.
- DotFaceEyeGazeLivenessModuleConfiguration
- Face eye gaze liveness module configuration.
- DotFaceLibraryConfiguration
- Face library configuration.
- DotFacePassiveLivenessModuleConfiguration
- Face passive liveness module configuration.
- DotFaceVerificationModuleConfiguration
- Face verification module configuration.
- DotSdk
- IDV SDK main component for initialization and deinitialization.
- DotSdkConfiguration
- Configuration for the main IDV SDK component (DotSdk).
- Expression
- Face expression evaluation result. Contains evaluated face attributes which represent the face expression.
- ExpressionQuery
- Expression query specifies which face expression face attributes should be evaluated.
- EyesExpression
- Eyes expression evaluation result.
- EyesExpressionQuery
- Eyes expression query specifies which eye expression face attributes should be evaluated.
- FaceAspects
- Image parameters.
- FaceAttribute
- The evaluation result of a single face quality attribute, for example sharpness or passive liveness.
- FaceAutoCaptureDetection
- Face detection in Face Auto Capture UI component.
- FaceAutoCaptureResult
- Result of the Face Auto Capture UI component.
- FaceAutoCaptureWidget
- Face Auto Capture UI component (widget).
- FaceAutoCaptureWidgetConfiguration
- Configuration for the Face Auto Capture UI component (FaceAutoCaptureWidget).
- FaceAutoCaptureWidgetConfigurationPresets
- Pre-defined sets of configurations.
- FaceAutoCaptureWidgetController
-
Controller for managing the Face Auto Capture process.
This component requires the
DotFaceDetection*module to be active. If you want to evaluate background uniformity during the face auto capture process, you will need theDotFaceBackgroundUniformitymodule to be active. If you want to evaluate face mask during the face auto capture process, you will need theDotFaceDetectionBalancedmodule to be active. - FaceDetectionQuery
- Face detection query. It allows additional processing beyond basic face detection.
- FaceDetectorFace
- Detected face in the image.
- FaceImageQuality
- Face image quality evaluation result. Contains all the evaluated face attributes which together represent the face image quality.
- FaceImageQualityQuery
- Face image quality query specifies which face image quality face attributes should be evaluated.
- FaceKeypoint
- Face Keypoint
- FaceKeypoints
- Face Keypoints evaluation result. Holds evaluated facial keypoints.
- FaceLibraryComponentConfiguration
- Configuration for face library components.
- FaceModules
- Container for library configurations.
- FaceQuality
- Face quality evaluation result. Contains all the evaluated face attributes which together represent the face quality.
- FaceQualityQuery
- Face quality query specifies which face quality face attributes should be evaluated.
- Glasses
- Face attribute for the glasses.
- HeadPose
- Head pose evaluation result. Contains evaluated face attributes which represent the head pose of the detected face.
- HeadPoseAttribute
- Head pose attribute with angle value instead of score.
- HeadPoseQuery
- Head pose query specifies which head pose attributes should be evaluated.
- HiddenPlaceholder
- Hidden placeholder.
- IdleUiState
- Idle state.
- Image
- Represents an image.
- ImageFactory
- A factory class for creating ui.Image objects.
- ImageSize
- Represents image size in pixels.
- InitializingUiState
- Initializing state.
- IntervalDouble
- Representation of closed interval with value type double.
- IosCameraPreviewStyle
- Style of the camera preview in the UI component.
- IosCandidateSelectionInstructionStyle
- Style of the instruction in the UI component with candidate selection.
- IosCandidateSelectionPlaceholderStyle
- Style of the placeholder in the UI component with candidate selection.
- IosFaceAutoCaptureWidgetStyle
- Style for the UI Face Auto Capture component (FaceAutoCaptureWidget).
- IosInstructionStyle
- Style of the instruction in the UI component.
- IosMagnifEyeLivenessWidgetStyle
- Style for the UI MagnifEye Liveness component (MagnifEyeLivenessWidget).
- IosNamedUiFont
- Representation of iOS UIFont created by UIFont(name: String, size: CGFloat). You can use native iOS fonts or you can add custom font to the iOS project and use it.
- IosPlaceholderStyle
- Style of the placeholder in the UI component.
- IosSmileLivenessWidgetStyle
- Style for the UI Smile Liveness component (SmileLivenessWidget).
- IosSystemUiFont
- Representation of iOS system UIFont.
- IosUiFont
- Representation of iOS UIFont.
- Libraries
- Container for library configurations.
- MagnifEyeLivenessResult
- Result of the MagnifEye Liveness UI component.
- MagnifEyeLivenessWidget
- MagnifEye Liveness UI component (widget).
- MagnifEyeLivenessWidgetConfiguration
- Configuration for the MagnifEye Liveness UI component (MagnifEyeLivenessWidget).
- MagnifEyeLivenessWidgetController
- Controller for managing the MagnifEye Liveness process.
- Placeholder
- Placeholder.
- PointDouble
- Point in two-dimensional euclidean space.
- Preview
- Geometric properties of the preview. All rectangles are defined relative to the preview container.
- QualityAttributeThresholdPresets
- Pre-defined sets of thresholds for Face Auto Capture.
- QualityAttributeThresholds
- Thresholds of quality attributes.
- RectangleDouble
- Rectangle in two-dimensional euclidean space.
- RunningUiState
- Running state.
- SmileLivenessResult
- Result of the Smile Liveness UI component.
- SmileLivenessWidget
- Smile Liveness UI component (widget).
- SmileLivenessWidgetConfiguration
- Configuration for the Smile Liveness UI component (SmileLivenessWidget).
- SmileLivenessWidgetController
- Controller for managing the Smile Liveness process.
- Template
- Face template.
- TiltAngles
- Tilt angles.
- UiState
- UI state.
- VisiblePlaceholder
- Visible placeholder.
- Wearables
- Wearables evaluation result. Contains evaluated face attributes which represent the detected face wearables.
- WearablesQuery
- Wearables query specifies which wearables face attributes should be evaluated.
Enums
- CameraFacing
- Camera facing.
- CameraPreviewScaleType
- Camera preview scale type.
- CaptureMode
- The method by which the final result is obtained.
- ImageFormat
- Image format.
- IosUiFontWeight
- Representation of iOS UIFont.Weight.
- Phase
- Face auto capture process phase.
- PlaceholderType
- Type of placeholder.
Typedefs
- OnFaceAutoCaptureCreatedCallback = void Function(FaceAutoCaptureWidgetController controller)
- Called when the widget is created.
- OnFaceAutoCaptureFinishedCallback = void Function(FaceAutoCaptureResult result)
- 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.
- OnFaceAutoCaptureNoCameraPermissionCallback = void Function()
- Called when camera permission was not granted.
- OnFaceAutoCaptureUiStateUpdatedCallback = void Function(UiState uiState)
- Called when a camera image is processed.
- OnMagnifEyeLivenessCreatedCallback = void Function(MagnifEyeLivenessWidgetController controller)
- Called when the widget is created.
- OnMagnifEyeLivenessFinishedCallback = void Function(MagnifEyeLivenessResult result)
- Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
- OnMagnifEyeLivenessNoCameraPermissionCallback = void Function()
- Called when camera permission was not granted.
- OnSmileLivenessCreatedCallback = void Function(SmileLivenessWidgetController controller)
- Called when the widget is created.
- OnSmileLivenessCriticalFacePresenceLostCallback = void Function()
-
If the face presence is lost after the neutral face expression image is captured.
If the face presence between the neutral and the smile face expression images is required, call
startmethod to restart the process. Otherwise the callback can be ignored. Called only once for the whole process. - OnSmileLivenessFinishedCallback = void Function(SmileLivenessResult result)
- Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
- OnSmileLivenessNoCameraPermissionCallback = void Function()
- Called when camera permission was not granted.