+
+
+ BACK
+Back facing.
+
+
+
+
+
+
+
+ Back facing.
Front facing.
Camera facing.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Camera preview fragment for UI components.
Called when camera permission was not granted.
Called when camera permission was not granted.
Scale the preview, maintaining the source aspect ratio, so it fills the entire fragment layout. This may cause the preview to be cropped if the camera preview aspect ratio does not match that of its container fragment layout.
Scale the preview, maintaining the source aspect ratio, so it is entirely contained within the fragment layout. The background area not covered by the preview stream will be black or the background of the fragment layout.
Camera preview scale type.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Auto capture mode (automatic mode).
Once specified count of consecutive valid frames have been acquired, the candidate selection process is triggered and continues for specified time in milliseconds. During this period, the system analyzes the pool of valid images to determine the most suitable result image.
Wait for request mode (manual mode).
The process remains in a waiting state until the requestCapture() call is invoked, signaling the request of the capture event.
The method by which the final result is obtained.
Auto capture mode (automatic mode).
Wait for request mode (manual mode).
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Factory method.
Factory method.
Representation of closed interval with value type Double.
Representation of closed interval with value type Double.
Configuration for the main DOT SDK component.
Deinitialize DOT SDK. This operation should be called on background thread.
Resolve Application ID.
Application ID. More details in Android Documentation.
DOT SDK main component.
Deinitialize DOT SDK. This operation should be called on background thread.
Resolve Application ID.
Initialize DOT SDK. This operation should be called on background thread.
Check if DOT SDK is initialized.
Initialize DOT SDK. This operation should be called on background thread.
Configuration for DOT SDK.
Configuration for the main DOT SDK component.
Front or back camera facing.
Default value is CameraFacing.FRONT.
Builder instance.
Front or back camera facing.
The camera preview scale type.
Default value is CameraPreviewScaleType.FIT.
Builder instance.
Camera preview scale type.
If detection UI layer (tracking circle) is visible.
Default value is false.
Builder instance.
If true, detection UI layer is visible.
Face size to shorter preview container side ratio interval.
Default value is [0.1, 0.3].
Builder instance.
face size ratio definition.
Face size to shorter preview container side ratio interval.
Use FaceAutoCaptureFragment.Configuration class instead.
Configuration builder.
Front or back camera facing.
The camera preview scale type.
If detection UI layer (tracking circle) is visible.
Face size to shorter preview container side ratio interval.
Quality attribute thresholds.
Session token provided by DIS (Digital Identity Service). Set the session token if the result should be posted to DIS for evaluation.
If torch is enabled during the process. If the camera doesn't have a flash unit, then this setting will be ignored.
Quality attribute thresholds.
Default value is QualityAttributeThresholdPresets.standard.
Builder instance.
Quality attribute thresholds.
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.
Builder instance.
Session token.
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.
Builder instance.
If true, torch is enabled.
Use FaceAutoCaptureFragment.Configuration class instead.
Configuration for the Face Auto Capture UI component.
Face detection in Face Auto Capture UI component.
Overriding method `provideConfiguration()` is preferred way of providing configuration.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Capture mode. Default value is CaptureMode.AUTO_CAPTURE.
Quality attribute thresholds. Default value is QualityAttributeThresholdPresets.standard.
If placeholder for the face is visible. Default value is true.
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
Pre-defined sets of configurations.
Configuration suitable for face verification use cases. The component operates without any visual aids or guidance for the user, with the exception of the detection layer (tracking circle). There is no automatic triggering of the capture process. Instead, the client is responsible for initiating the capture by explicitly calling the requestCapture method. This configuration provides a minimalistic approach, offering flexibility to the client in managing the capture timing and user interaction, which is often desired in verification scenarios.
Configuration suitable for face verification use cases. The component operates without any visual aids or guidance for the user, with the exception of the detection layer (tracking circle). There is no automatic triggering of the capture process. Instead, the client is responsible for initiating the capture by explicitly calling the requestCapture method. This configuration provides a minimalistic approach, offering flexibility to the client in managing the capture timing and user interaction, which is often desired in verification scenarios.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
Capture mode. Default value is CaptureMode.AUTO_CAPTURE.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Configuration for the Face Auto Capture UI component.
face size ratio definition.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Capture mode. Default value is CaptureMode.AUTO_CAPTURE.
Quality attribute thresholds. Default value is QualityAttributeThresholdPresets.standard.
If placeholder for the face is visible. Default value is true.
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
If detection UI layer (tracking circle) is visible. Default value is false.
If placeholder for the face is visible. Default value is true.
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.
Quality attribute thresholds. Default value is QualityAttributeThresholdPresets.standard.
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.
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.
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.
Face Auto Capture UI component.
A visual component for capturing good quality images of a human face.
Configuration for the Face Auto Capture UI component.
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.
Called when a camera image is processed.
Subclasses should override this method to provide Configuration for the Face Auto Capture UI component.
Request capture event asynchronously.
Called only once for the whole process, when candidate selection has been started.
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.
Final face image and other data.
Called when a camera image is processed.
Face detection.
Subclasses should override this method to provide Configuration for the Face Auto Capture UI component.
Configuration for the Face Auto Capture UI component.
Request capture event asynchronously.
If true, the result will be captured only if a face is detected with defined quality attributes. Otherwise, the result will be captured regardless of the face presence.
Start the process.
Result of the Face Auto Capture UI component.
Detected face in the image. Might be null only if FaceAutoCaptureFragment.requestCapture was used to get the result.
Use QualityAttributeThresholdPresets.icao property instead.
Thresholds for ICAO image output quality. These are more strict than standard thresholds.
minConfidence value is 0.15
maxDevicePitchAngle value is 20.0
sizeInterval value is [0.16, 0.20]
yawAngleInterval value is [-4.0, 4.0]
pitchAngleInterval value is [-6.0, 2.0]
minSharpness value is 0.2832
brightnessInterval value is [0.25, 0.75]
contrastInterval value is [0.25, 0.75]
minUniqueIntensityLevels value is 0.5
minBackgroundUniformity value is 0.505
minMouthStatusScore value is 0.5
minEyesStatusScore value is 0.475
Thresholds for ICAO image output quality. These are more strict than standard thresholds.
minConfidence value is 0.15
maxDevicePitchAngle value is 20.0
sizeInterval value is [0.16, 0.20]
yawAngleInterval value is [-4.0, 4.0]
pitchAngleInterval value is [-6.0, 2.0]
minSharpness value is 0.2832
brightnessInterval value is [0.25, 0.75]
contrastInterval value is [0.25, 0.75]
minUniqueIntensityLevels value is 0.5
minBackgroundUniformity value is 0.505
minMouthStatusScore value is 0.5
minEyesStatusScore value is 0.475
Pre-defined sets of thresholds for Face Auto Capture.
Use QualityAttributeThresholdPresets.pasiveLiveness property instead.
Thresholds for Passive Liveness evaluation.
minConfidence value is 0.15
maxDevicePitchAngle value is 30.0
sizeInterval value is [0.16, 0.20]
yawAngleInterval value is [-20.0, 20.0]
pitchAngleInterval value is [-15.0, 15.0]
minSharpness value is 0.2832
brightnessInterval value is [0.11, 0.75]
contrastInterval value is [0.25, 0.80]
minUniqueIntensityLevels value is 0.525
Thresholds for Passive Liveness evaluation.
minConfidence value is 0.15
maxDevicePitchAngle value is 30.0
sizeInterval value is [0.16, 0.20]
yawAngleInterval value is [-20.0, 20.0]
pitchAngleInterval value is [-15.0, 15.0]
minSharpness value is 0.2832
brightnessInterval value is [0.11, 0.75]
contrastInterval value is [0.25, 0.80]
minUniqueIntensityLevels value is 0.525
Use QualityAttributeThresholdPresets.standard property instead.
Thresholds for standard image output quality. Suitable for onboarding or matching, etc.
minConfidence value is 0.15
maxDevicePitchAngle value is 30.0
sizeInterval value is [0.16, 0.20]
minSharpness value is 0.2832
Thresholds for standard image output quality. Suitable for onboarding or matching, etc.
minConfidence value is 0.15
maxDevicePitchAngle value is 30.0
sizeInterval value is [0.16, 0.20]
minSharpness value is 0.2832
Valid brightness interval.
Builder instance.
Values in interval [0.0, 1.0].
If value is out of the interval.
Valid contrast interval.
Builder instance.
Values in interval [0.0, 1.0].
If value is out of the interval.
Valid brightness interval.
Valid contrast interval.
Maximum device pitch angle.
Maximum glass status.
Maximum mask status.
Maximum shadow.
Minimum background uniformity.
Minimum detection confidence.
Minimum eyes status.
Minimum mouth status.
Minimum sharpness.
Minimum unique intensity levels.
Valid pitch angle interval.
Valid face size interval.
Valid yaw angle interval.
Maximum device pitch angle.
Builder instance.
Degrees in interval [0.0, 90.0].
If value is out of the interval.
Maximum glass status.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Maximum mask status.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Maximum shadow.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum background uniformity.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum detection confidence.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum eyes status.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum mouth status.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum sharpness.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Minimum unique intensity levels.
Builder instance.
Value in interval [0.0, 1.0].
If value is out of the interval.
Valid pitch angle interval.
Builder instance.
Values in interval [-90.0, 90.0].
If value is out of the interval.
Valid face size interval.
Builder instance.
Values greater than or equal to 0.0.
If value is out of the interval.
Valid yaw angle interval.
Builder instance.
Values in interval [-90.0, 90.0].
If value is out of the interval.
Minimum detection confidence. Value in interval [0.0, 1.0].
Maximum device pitch angle. Degrees in interval [0.0, 90.0].
Valid face size interval. Values greater than or equal to 0.0.
Valid pitch angle interval. Values in interval [-90.0, 90.0].
Valid yaw angle interval. Values in interval [-90.0, 90.0].
Minimum sharpness. Value in interval [0.0, 1.0].
Valid brightness interval. Values in interval [0.0, 1.0].
Valid contrast interval. Values in interval [0.0, 1.0].
Minimum unique intensity levels. Value in interval [0.0, 1.0].
Minimum background uniformity. Value in interval [0.0, 1.0].
Maximum glass status. Value in interval [0.0, 1.0].
Maximum mask status. Value in interval [0.0, 1.0].
Minimum mouth status. Value in interval [0.0, 1.0].
Minimum eyes status. Value in interval [0.0, 1.0].
Maximum shadow. Value in interval [0.0, 1.0].
Valid brightness interval. Values in interval [0.0, 1.0].
Valid contrast interval. Values in interval [0.0, 1.0].
Thresholds of quality attributes.
Minimum detection confidence. Value in interval [0.0, 1.0].
Maximum device pitch angle. Degrees in interval [0.0, 90.0].
Valid face size interval. Values greater than or equal to 0.0.
Valid pitch angle interval. Values in interval [-90.0, 90.0].
Valid yaw angle interval. Values in interval [-90.0, 90.0].
Minimum sharpness. Value in interval [0.0, 1.0].
Valid brightness interval. Values in interval [0.0, 1.0].
Valid contrast interval. Values in interval [0.0, 1.0].
Minimum unique intensity levels. Value in interval [0.0, 1.0].
Minimum background uniformity. Value in interval [0.0, 1.0].
Maximum glass status. Value in interval [0.0, 1.0].
Maximum mask status. Value in interval [0.0, 1.0].
Minimum mouth status. Value in interval [0.0, 1.0].
Minimum eyes status. Value in interval [0.0, 1.0].
Maximum shadow. Value in interval [0.0, 1.0].
If any of the parameters is out of the interval.
Maximum device pitch angle. Degrees in interval [0.0, 90.0].
Maximum glass status. Value in interval [0.0, 1.0].
Maximum mask status. Value in interval [0.0, 1.0].
Minimum background uniformity. Value in interval [0.0, 1.0].
Minimum detection confidence. Value in interval [0.0, 1.0].
Minimum eyes status. Value in interval [0.0, 1.0].
Minimum mouth status. Value in interval [0.0, 1.0].
Minimum sharpness. Value in interval [0.0, 1.0].
Minimum unique intensity levels. Value in interval [0.0, 1.0].
Valid pitch angle interval. Values in interval [-90.0, 90.0].
Valid face size interval. Values greater than or equal to 0.0.
Valid yaw angle interval. Values in interval [-90.0, 90.0].
Configuration for the Face Auto Capture UI component.
Face detection in Face Auto Capture UI component.
Face Auto Capture UI component.
Result of the Face Auto Capture UI component.
Pre-defined sets of thresholds for Face Auto Capture.
Thresholds of quality attributes.
Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. This operation should be called on background thread.
ICAO full frontal face image.
Create the face template which can be used for matching. This method requires dot-face-verification module. This operation should be called on a background thread.
Template.
If the dot-face-verification module is not activated.
Evaluation of face aspects. This operation should be called on background thread.
Face aspects.
Evaluation of all available face quality attributes. If an attribute requires a module which is not activated, it is not evaluated and null is returned. If you need only one or a specific set of attributes, use .evaluateFaceQuality method for better performance. This operation should be called on background thread.
Face quality attributes.
Evaluation of specific set of face quality attributes. This is the recommended way for face quality evaluation due to performance reasons. If an attribute in the query requires a module which is not activated, exception is thrown. This operation should be called on background thread.
Face quality attributes.
Only attributes specified in this query are being evaluated.
If required module is not activated.
Evaluation of passive liveness. This method requires dot-face-passive-liveness module. This operation should be called on background thread.
Passive liveness.
If the dot-face-passive-liveness module is not activated.
The confidence score of the face detection. It also represents the quality of the detected face.
Confidence score. Value in interval 0.0, 1.0.
Full size (camera preview) image.
Detected face.
Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. This operation should be called on background thread.
Create the face template which can be used for matching. This method requires dot-face-verification module. This operation should be called on a background thread.
Evaluation of face aspects. This operation should be called on background thread.
Evaluation of all available face quality attributes. If an attribute requires a module which is not activated, it is not evaluated and null is returned. If you need only one or a specific set of attributes, use .evaluateFaceQuality method for better performance. This operation should be called on background thread.
Evaluation of specific set of face quality attributes. This is the recommended way for face quality evaluation due to performance reasons. If an attribute in the query requires a module which is not activated, exception is thrown. This operation should be called on background thread.
Evaluation of passive liveness. This method requires dot-face-passive-liveness module. This operation should be called on background thread.
The confidence score of the face detection. It also represents the quality of the detected face.
Face image quality query.
Passive liveness evaluation flag. This method requires dot-face-passive-liveness module. Default value is false.
Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. Default value is false.
Create the face template which can be used for matching. This flag requires dot-face-verification module. Default value is false.
Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. Default value is false.
Create the face template which can be used for matching. This flag requires dot-face-verification module. Default value is false.
Passive liveness evaluation flag. This method requires dot-face-passive-liveness module. Default value is false.
Face detection query. It allows for additional processing beyond basic face detection.
If an attribute in the query requires a module which is not activated, exception is thrown during the FaceDetector.detect method.
Face image quality query.
Passive liveness evaluation flag. This method requires dot-face-passive-liveness module. Default value is false.
Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. Default value is false.
Create the face template which can be used for matching. This flag requires dot-face-verification module. Default value is false.
Factory for Face Detector component.
Detected face in the image.
Face quality attributes. Only attributes specified in FaceDetectionQuery are being evaluated.
ICAO full frontal face image. This is being evaluated only if it is specified in FaceDetectionQuery.
Passive liveness. This is being evaluated only if it is specified in FaceDetectionQuery.
Face template. It can be used for face matching. This is being evaluated only if it is specified in FaceDetectionQuery.
Detect faces in the image. This operation should be called on a background thread.
List of faces or empty list if no face is detected.
BGR raw image with expected face size ratio interval.
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.
Detection stops when number of detected faces reaches limit.
If DOT Face library with the detection module is not activated or if any of the requested attributes in query requires extra module, which is not activated.
Face Detector component.
Detect faces in the image. This operation should be called on a background thread.
Face detection query. It allows for additional processing beyond basic face detection.
Face Detector component.
Factory for Face Detector component.
Create DOT BgrRawImage.
BGR raw image.
Multi-plane Android YUV 420 image from ImageAnalysis.Analyzer.analyze callback.
Create DOT BgrRawImage.
BGR raw image.
Android Bitmap.
Factory methods for creating BgrRawImage instances.
Create DOT BgrRawImage.
Create face image object.
Object for face detection.
BGR raw image.
Minimum face size to shorter image side ratio. This defines size of searched face in the image.
Maximum face size to shorter image side ratio. This defines size of searched face in the image.
If arguments are invalid or if minFaceSizeRatio is less than min valid face size.
If DOT Face is not initialized.
Factory for Face Image object.
BGR raw image.
Interval of face size ratio.
Interval of face size ratio.
Image of a face with expected face size ratio interval. It can be used for face detection and matching. The face in the image must be upright and not tilted sideways.
BGR raw image.
Interval of face size ratio.
If arguments are invalid or if faceSizeRatioInterval corresponds to invalid face size.
If DOT Face library with the detection module is not activated.
Factory methods for creating BgrRawImage instances.
Image of a face with expected face size ratio interval. It can be used for face detection and matching. The face in the image must be upright and not tilted sideways.
Corner position for the Eye Gaze Liveness object. See EyeGazeLivenessFragment.Configuration.corners for more details.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Factory for Eye Gaze Liveness Corners Generator.
Generate a list of corners for EyeGazeLivenessFragment.Configuration.
List of corners.
Count of corners.
Eye Gaze Liveness Corners Generator.
To create an instance of this class, use CornersGeneratorFactory.
Example usage:
val cornersGenerator = CornersGeneratorFactory.create()
val corners = cornersGenerator.generate(count = 8)Front or back camera facing. Default value is CameraFacing.FRONT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
List of corners which defines where the user should look. Minimum allowed size of the list is equal to minValidSamplesCount.
Minimum number of valid samples (images) required to finish the process. Allowed value is from interval [4, 7]. Default value is 4.
Transition type between segments. Default value is TransitionType.MOVE.
Duration of each transition in milliseconds. Default value is 800.
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.
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.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Front or back camera facing. Default value is CameraFacing.FRONT.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Configuration for the Eye Gaze Liveness UI component.
Front or back camera facing. Default value is CameraFacing.FRONT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
List of corners which defines where the user should look. Minimum allowed size of the list is equal to minValidSamplesCount.
Minimum number of valid samples (images) required to finish the process. Allowed value is from interval [4, 7]. Default value is 4.
Transition type between segments. Default value is TransitionType.MOVE.
Duration of each transition in milliseconds. Default value is 800.
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.
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.
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.
Minimum number of valid samples (images) required to finish the process. Allowed value is from interval [4, 7]. Default value is 4.
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.
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.
Duration of each transition in milliseconds. Default value is 800.
Transition type between segments. Default value is TransitionType.MOVE.
Eye Gaze Liveness UI component.
A visual component for capturing images suitable for Eye Gaze Liveness evaluation.
Configuration for the Eye Gaze Liveness UI component.
Called when all specified corners has been used, but accepted sample count has not been reached. Once this callback is called, the whole process is considered to be over.
Called when the process is unable to continue. Either the face is not detected anymore or the eyes are not visible clearly. Once this callback is called, the whole process is considered to be over.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Called when a camera image is processed.
Provide Configuration for the Eye Gaze Liveness UI component.
Called when all specified corners has been used, but accepted sample count has not been reached. Once this callback is called, the whole process is considered to be over.
Called when the process is unable to continue. Either the face is not detected anymore or the eyes are not visible clearly. Once this callback is called, the whole process is considered to be over.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Eye Gaze Liveness result.
Called when a camera image is processed.
Face detection.
Provide Configuration for the Eye Gaze Liveness UI component.
Configuration for the Eye Gaze Liveness UI component.
Start the process.
Temporary property for the legacy way of liveness evaluation on DIS.
Corner position for the Eye Gaze Liveness object. See EyeGazeLivenessFragment.Configuration.corners for more details.
Eye Gaze Liveness Corners Generator.
Factory for Eye Gaze Liveness Corners Generator.
Eye Gaze Liveness UI component.
Result of the Eye Gaze Liveness UI component.
Front or back camera facing.
Default value is CameraFacing.FRONT.
Builder instance.
Front or back camera facing.
The camera preview scale type.
Default value is CameraPreviewScaleType.FIT.
Builder instance.
Camera preview scale type.
If detection UI layer (tracking circle) is visible.
Default value is false.
Builder instance.
If true, detection UI layer is visible.
Face size to shorter preview container side ratio interval.
Default value is [0.1, 0.3].
Builder instance.
face size ratio definition.
Face size to shorter preview container side ratio interval.
Use MagnifEyeLivenessFragment.Configuration class instead.
Configuration builder.
Front or back camera facing.
The camera preview scale type.
If detection UI layer (tracking circle) is visible.
Face size to shorter preview container side ratio interval.
Session token provided by DIS (Digital Identity Service). Set the session token if the result should be posted to DIS for evaluation.
If torch is enabled during the process. If the camera doesn't have a flash unit, then this setting will be ignored.
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.
Builder instance.
Session token.
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.
Builder instance.
If true, torch is enabled.
Use MagnifEyeLivenessFragment.Configuration class instead.
Configuration for the MagnifEye Liveness UI component.
Overriding method `provideConfiguration()` is preferred way of providing configuration.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Configuration for the MagnifEye Liveness UI component.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
If detection UI layer (tracking circle) is visible. Default value is 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.
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.
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.
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.
MagnifEye Liveness UI component.
A visual component for capturing images suitable for MagnifEye Liveness evaluation.
Configuration for the MagnifEye Liveness UI component.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Called when a camera image is processed.
Subclasses should override this method to provide Configuration for the MagnifEye Liveness UI component.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Final images.
Called when a camera image is processed.
Face detection.
Subclasses should override this method to provide Configuration for the MagnifEye Liveness UI component.
Configuration for the MagnifEye Liveness UI component.
Start the process.
Front or back camera facing.
Default value is CameraFacing.FRONT.
Builder instance.
Front or back camera facing.
The camera preview scale type.
Default value is CameraPreviewScaleType.FIT.
Builder instance.
Camera preview scale type.
If detection UI layer (tracking circle) is visible.
Default value is false.
Builder instance.
If true, detection UI layer is visible.
Face size to shorter preview container side ratio interval.
Default value is [0.1, 0.3].
Builder instance.
face size ratio definition.
Face size to shorter preview container side ratio interval.
Front or back camera facing.
The camera preview scale type.
If detection UI layer (tracking circle) is visible.
Face size to shorter preview container side ratio interval.
Session token provided by DIS (Digital Identity Service). Set the session token if the result should be posted to DIS for evaluation.
If torch is enabled during the process. If the camera doesn't have a flash unit, then this setting will be ignored.
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.
Builder instance.
Session token.
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.
Builder instance.
If true, torch is enabled.
Use SmileLivenessFragment.Configuration class instead.
Configuration for the Smile Liveness UI component.
Overriding method `provideConfiguration()` is preferred way of providing configuration.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Configuration for the Smile Liveness UI component.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
If detection UI layer (tracking circle) is visible. Default value is false.
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.
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.
If detection UI layer (tracking circle) is visible. Default value is 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.
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.
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.
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.
Smile Liveness UI component.
A visual component which performs the liveness check based on the changes in the face expression.
Configuration for the Smile Liveness UI component.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Called when a camera image is processed.
Subclasses should override this method to provide Configuration for the Smile Liveness UI component.
Called only once for the whole process. Once this callback is called, the whole process is considered to be over.
Final images.
Called when a camera image is processed.
Face detection.
Subclasses should override this method to provide Configuration for the Smile Liveness UI component.
Configuration for the Smile Liveness UI component.
Start the process.
Result of the Smile Liveness UI component.
BGR raw image. Post this image together with smileExpressionBgrRawImage to the DIS for liveness evaluation.
BGR raw image of smile expression face. Post this image together with bgrRawImage to the DIS for liveness evaluation.
Temporary property for liveness evaluation on DIS. It will be replaced by binary content.
DOT Face module.
DOT Face module.
Eyes expression query. Default value is null.
Mouth evaluation flag. Default value is false.
Mouth evaluation flag. Default value is false.
Expression query.
Eyes expression query. Default value is null.
Mouth evaluation flag. Default value is false.
Right eye evaluation flag. Default value is false.
Left eye evaluation flag. Default value is false.
Left eye evaluation flag. Default value is false.
Right eye evaluation flag. Default value is false.
Expression of eyes query.
Right eye evaluation flag. Default value is false.
Left eye evaluation flag. Default value is false.
Right eye evaluation flag. Default value is false.
Sharpness evaluation flag. Default value is false.
Brightness evaluation flag. Default value is false.
Contrast evaluation flag. Default value is false.
Unique intensity levels evaluation flag. Default value is false.
Shadow evaluation flag. Default value is false.
Specularity evaluation flag. Default value is false.
Background uniformity evaluation flag. Default value is false.
Background uniformity evaluation flag. Default value is false.
Brightness evaluation flag. Default value is false.
Contrast evaluation flag. Default value is false.
Shadow evaluation flag. Default value is false.
Sharpness evaluation flag. Default value is false.
Specularity evaluation flag. Default value is false.
Unique intensity levels evaluation flag. Default value is false.
Face image quality query.
Sharpness evaluation flag. Default value is false.
Brightness evaluation flag. Default value is false.
Contrast evaluation flag. Default value is false.
Unique intensity levels evaluation flag. Default value is false.
Shadow evaluation flag. Default value is false.
Specularity evaluation flag. Default value is false.
Background uniformity evaluation flag. Default value is false.
Background uniformity evaluation flag. Default value is false.
Brightness evaluation flag. Default value is false.
Contrast evaluation flag. Default value is false.
Sharpness evaluation flag. Default value is false.
Specularity evaluation flag. Default value is false.
Unique intensity levels evaluation flag. Default value is false.
Face image quality.
Face image quality query.
Head pose query.
Wearables query.
Face expression query.
Face quality query.
Face image quality query.
Head pose query.
Wearables query.
Face expression query.
Roll evaluation flag. Default value is false.
Yaw evaluation flag. Default value is false.
Pitch evaluation flag. Default value is false.
Pitch evaluation flag. Default value is false.
Roll evaluation flag. Default value is false.
Head pose query.
Roll evaluation flag. Default value is false.
Yaw evaluation flag. Default value is false.
Pitch evaluation flag. Default value is false.
Glasses evaluation flag. Default value is false.
Face mask evaluation flag. Default value is false.
Glasses evaluation flag. Default value is false.
Face mask evaluation flag. Default value is false.
Wearables query.
Glasses evaluation flag. Default value is false.
Face mask evaluation flag. Default value is false.
Expression.
Expression query.
Expression of eyes.
Expression of eyes query.
Face aspects.
Face attribute.
Face image quality.
Face image quality query.
Face quality.
Face quality query.
Head pose attribute.
Head pose query.
Wearables query.
Factory for Face Matcher component.
Face not detected in probe image.
Face not detected in reference image.
Template related error. See TemplateMatcher.MatchException for details.
Match error.
Face not detected in reference image.
Face not detected in probe image.
Template related error. See TemplateMatcher.MatchException for details.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Face matcher.
Thrown if matching is not possible to evaluate.
Match the probe face image against the reference face image.
Match the probe face image against the reference template.
Match the probe face image against the reference face image.
Matching score.
Face image.
Face image.
If verification module is not activated.
If matching is not possible to evaluate.
Match the probe face image against the reference template.
Matching result.
Reference template.
Probe face image.
If verification module is not activated.
If matching is not possible to evaluate.
Match the probe face image against the reference template.
Matching result.
Reference template bytes.
Probe face image.
If verification module is not activated.
If matching is not possible to evaluate.
Factory for Template Matcher component.
Face template is corrupted.
Incompatible version of face templates.
Error unrelated with matching.
Face template of this version is not supported.
Match error.
Incompatible version of face templates.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Template matcher.
Thrown if matching is not possible to evaluate.
Match reference and probe face templates.
Match reference and probe face templates.
Matching result.
Reference template.
Probe template.
If verification module is not activated.
If matching is not possible to evaluate.
Match reference and probe face templates.
Matching result.
Reference template bytes.
Probe template bytes.
If verification module is not activated.
If matching is not possible to evaluate.
Face matcher.
Factory for Face Matcher component.
Face template. Templates across various DOT versions might not be compatible, only templates with corresponding versions can be used for verification.
Template matcher.
Factory for Template Matcher component.
Front or back camera facing.
Default value is CameraFacing.FRONT.
Builder instance.
Front or back camera facing.
The camera preview scale type.
Default value is CameraPreviewScaleType.FIT.
Builder instance.
Camera preview scale type.
Face size to shorter preview container side ratio interval.
Default value is [0.1, 0.3].
Builder instance.
face size ratio definition.
Face size to shorter preview container side ratio interval.
Use FaceSimpleCaptureFragment.Configuration class instead.
Configuration builder.
Front or back camera facing.
The camera preview scale type.
Face size to shorter preview container side ratio interval.
Session token provided by DIS (Digital Identity Service). Set the session token if the result should be posted to DIS for evaluation.
If torch is enabled during the process. If the camera doesn't have a flash unit, then this setting will be ignored.
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.
Builder instance.
Session token.
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.
Builder instance.
If true, torch is enabled.
Use FaceSimpleCaptureFragment.Configuration class instead.
Configuration for the Face Simple Capture UI component.
Overriding method `provideConfiguration()` is preferred way of providing configuration.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
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.
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.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
Configuration for the Face Simple Capture UI component.
face size ratio definition.
Front or back camera facing. Default value is CameraFacing.FRONT.
The camera preview scale type. Default value is CameraPreviewScaleType.FIT.
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.
Face size to shorter preview container side ratio interval. Default value is [0.1, 0.3].
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.
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.
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.
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.
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.
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.
Use `FaceAutoCaptureFragment` with `FaceAutoCaptureFragment.Configuration.Presets.simple` instead.
Configuration for the Face Simple Capture UI component.
Called only once for the whole process and as soon as requestCapture has been called and face is detected. Once this callback is called, the whole process is considered to be over.
Subclasses should override this method to provide Configuration for the Face Simple Capture UI component.
Request capture event asynchronously (regardless of whether there is a face detected or not).
Called only once for the whole process and as soon as requestCapture has been called and face is detected. Once this callback is called, the whole process is considered to be over.
Final face image and other data.
Subclasses should override this method to provide Configuration for the Face Simple Capture UI component.
Configuration for the Face Simple Capture UI component.
Request capture event asynchronously (regardless of whether there is a face detected or not).
Start the process.
Face detection confidence threshold.
Default value is 0.06.
Builder instance.
Value in interval [0.0, 1.0].
Configuration builder.
Face detection confidence threshold.
Configuration for the DOT Face Library.
Constructor.
Action failed.
Action succeed.
Code.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Close DOT Face asynchronously or do nothing if it is not initialized.
Important: Do not call this method if any UI component is still running. Doing so might lead to a crash. Either deinitialize DOT Face after the UI component is finished or stop the UI component manually and wait until the component is stopped.
Callback.
Initialize DOT Face asynchronously.
DOT Face configuration.
Callback.
DOT Face Library.
Configuration for the DOT Face Library.
Factory method.
Represents an image with 8-bit BGR color components with the values Blue, Green, and Red stored in 3 bytes.
The 3 bytes of color image pixel:
0th byte: BB - blue
1st byte: GG - green
2nd byte: RR - red
DOT Face API documentation.