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

Interface FaceAuthFrameEvent

public interface FaceAuthFrameEvent

This interface contains all information about the current frame captured by the camera. If frame contains a detected face, it will contain all needed information to locate it.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
android.graphics.Rect	getFaceCoordinate() Retrieve a rectangle where user face has been detected
FaceAuthImage	getImage() Get the captured face image.
FaceAuthStatus	getLastFaceExtractionStatus() Return the FaceAuthStatus of the last addFaceToEnroll action.
java.util.EnumSet<FaceAuthLivenessAction>	getLivenessAction() Retrieve the FaceAuthLivenessAction needed by the face engine, if an action is needed This only applies to FaceAuthVerifier; The action will contain the instructions to the user in order to complete the verification.
int	getLivenessScore() Retrieve the liveness score in the range of [0..100] of the captured frame if liveness mode is FaceAuthSettings.FaceAuthLivenessMode.LIVENESS_PASSIVE .
float	getPitchAngle() Retrieve the pitch angle of the user face
float	getRollAngle() Retrieve the roll angle of the user face
FaceAuthStatus	getStatus() Retrieve the FaceAuthStatus associated with this frame
float	getYawAngle() Retrieve the yaw angle of the user face

Method Detail

getFaceCoordinate

android.graphics.Rect getFaceCoordinate()

Retrieve a rectangle where user face has been detected

Returns:

user face rectangle if available null otherwise.

getYawAngle

float getYawAngle()

Retrieve the yaw angle of the user face

Returns:

yaw angle

getPitchAngle

float getPitchAngle()

Retrieve the pitch angle of the user face

Returns:

pitch angle

getRollAngle

float getRollAngle()

Retrieve the roll angle of the user face

Returns:

roll angle

getLivenessScore

int getLivenessScore()

Retrieve the liveness score in the range of [0..100] of the captured frame if liveness mode is FaceAuthSettings.FaceAuthLivenessMode.LIVENESS_PASSIVE . Otherwise 254 is returned This only applies to FaceAuthVerifier;

Returns:

quality score

getStatus

FaceAuthStatus getStatus()

Retrieve the FaceAuthStatus associated with this frame

Returns:

FaceAuthStatus

getLastFaceExtractionStatus

FaceAuthStatus getLastFaceExtractionStatus()

Return the FaceAuthStatus of the last addFaceToEnroll action. This only applies to FaceAuthEnroller;

Returns:

FaceAuthStatus

getLivenessAction

java.util.EnumSet<FaceAuthLivenessAction> getLivenessAction()

Retrieve the FaceAuthLivenessAction needed by the face engine, if an action is needed This only applies to FaceAuthVerifier; The action will contain the instructions to the user in order to complete the verification. eg: keep still or blink

Returns:

FaceAuthLivenessAction if action is needed, null otherwise.

getImage

FaceAuthImage getImage()

Get the captured face image.

Returns:

FaceAuthImage if image is available null otherwise