com.gemalto.idp.mobile.authentication.mode.face

Interface FaceAuthSettings

All Known Subinterfaces:

FaceAuthEnrollerSettings, FaceAuthVerifierSettings

public interface FaceAuthSettings

This is a generic settings for Face Authentication. Please refer to FaceAuthEnrollerSettings and FaceAuthVerifierSettings

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FaceAuthSettings.FaceAuthLivenessMode The defined liveness modes.

Method Summary

Modifier and Type	Method and Description
int	getLivenessBlinkTimeout() Blink timeout.
FaceAuthSettings.FaceAuthLivenessMode	getLivenessMode() The liveness mode
int	getLivenessThreshold() The Liveness threshold.
int	getQualityThreshold() The Quality threshold.
void	setLivenessBlinkTimeout(int timeout) Blink timeout in milliseconds.
void	setLivenessMode(FaceAuthSettings.FaceAuthLivenessMode mode) Set the liveness mode to be use.
void	setLivenessThreshold(int threshold) Set the liveness threshold.
void	setQualityThreshold(int threshold) Set the quality threshold.

Method Detail

setLivenessMode

void setLivenessMode(FaceAuthSettings.FaceAuthLivenessMode mode)

Set the liveness mode to be use. For enrollment only FaceAuthSettings.FaceAuthLivenessMode.IMAGE mode is supported. For verification, FaceAuthSettings.FaceAuthLivenessMode.LIVENESS_PASSIVE mode is highly recommended for user verification.

Parameters:

mode - mode to use during next biometric face action

getLivenessMode

FaceAuthSettings.FaceAuthLivenessMode getLivenessMode()

The liveness mode

Returns:

the liveness mode

setLivenessThreshold

void setLivenessThreshold(int threshold)

Set the liveness threshold. This threshold is used in Liveness mode only and determine how long the 'Still phase' will be. The higher threshold the longer 'Still phase'. Default value is 0 so no 'Still phase' will appear. During still phase, it requires high quality of image extraction. The user will be required to hold the camera still and with good lightening.

Parameters:

threshold - value between 0 to 100

getLivenessThreshold

int getLivenessThreshold()

The Liveness threshold.

Returns:

the Liveness Threshold.

setLivenessBlinkTimeout

void setLivenessBlinkTimeout(int timeout)

Blink timeout in milliseconds. Default value is 2000. 'Blink' is required in FaceAuthSettings.FaceAuthLivenessMode.LIVENESS_PASSIVE mode. Liveness action instruction will be given inside the frame event callback. Once 'blink' action is asked by the SDK, if blink action is not detected by the camera within the configured timeout, face extraction will fail.

Parameters:

timeout - timeout

getLivenessBlinkTimeout

int getLivenessBlinkTimeout()

Blink timeout.

Returns:

current timeout value

setQualityThreshold

void setQualityThreshold(int threshold)

Set the quality threshold. If threshold is used during enrollment to determine the quality of a face. If an extracted face quality is less than specified value, face will be rejected. Default value is 50.

Parameters:

threshold - value between 0 to 100

getQualityThreshold

int getQualityThreshold()

The Quality threshold.

Returns:

the Quality Threshold.