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

Interface FaceAuthEnroller

public interface FaceAuthEnroller

This interface offers API to control and use the Face SDK during enrollment or unenrollment. An instance of it can be created using the FaceAuthFactory methods.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
void	addFaceAuthEnrollerListener(FaceAuthEnrollerListener listener) Add a listener to receive FaceAuthFrameEvent as soon as the enroll(int, FaceAuthEnrollerCallback) is called
void	addFaceFrameForEnrollment(FaceAuthFrameEvent faceAuthFrameEvent) Add the face frame for extraction.
boolean	cancelEnrollmentProcess() Cancel enrollment process.
void	completeEnrollment(FaceAuthFrameEvent faceAuthFrameEvent) Asynchronous call to complete the enrollment process, all faces marked for enrollment will be extracted and compile to create a unique user template.
void	enroll(int timeout, FaceAuthEnrollerCallback callback) Start the enrollment process for the user.
void	removeFaceAuthEnrollerListener(FaceAuthEnrollerListener listener) Remove a FaceAuthEnrollerListener that has been added in addFaceAuthEnrollerListener(FaceAuthEnrollerListener) Removal of listener is mandatory after the enrollment is completed!
void	unenroll(FaceAuthUnenrollerCallback callback) Unenroll a user from the system.

Method Detail

enroll

void enroll(int timeout,
            FaceAuthEnrollerCallback callback)

Start the enrollment process for the user. This operation will automatically starts capturing from camera, creates a biometric template, and stops capturing. While capturing is in progress, a listener FaceAuthEnrollerListener is called with current image, capturing status, and liveness property. Please take note that context must be set previously by calling FaceAuthService.setContext(android.content.Context) (The context needs to be set again if there is a change in Activity or previous activity is killed).

Parameters:

timeout - in millisecond for operation to be completed

callback - The callback to be triggered as soon as the operation completes with any result. It must never be null. Note that the callback is always called from within the main UI thread context and always after this method returns to its caller.

addFaceFrameForEnrollment

void addFaceFrameForEnrollment(FaceAuthFrameEvent faceAuthFrameEvent)
                        throws FaceAuthException

Add the face frame for extraction. The FaceAuthFrameEvent can be retrieved from FaceAuthEnrollerListener.onFrameReceived(FaceAuthFrameEvent) Once a frame event is received, the application developer should decide if the frame is to be added for extraction. Some checking can be performed. eg:

• Get the face Rectangle, check its position to see if it is well centered
• Get the face Rectangle, check its size to see if it is good enough
• Get the yaw angle, check if it is left/right face
• Get the pitch angle, check if it is from top/bottom
• Get pitch and yaw, check both are close to 0 so it is capturing a front face

Parameters:

faceAuthFrameEvent - event containing the face to be added

Throws:

FaceAuthException

completeEnrollment

void completeEnrollment(FaceAuthFrameEvent faceAuthFrameEvent)

Asynchronous call to complete the enrollment process, all faces marked for enrollment will be extracted and compile to create a unique user template. Once finished FaceAuthEnrollerCallback is called.

Parameters:

faceAuthFrameEvent - FaceFrameEvent containing the user face to use for enrollment

unenroll

void unenroll(FaceAuthUnenrollerCallback callback)

Unenroll a user from the system. All face data related to this user will be permanently deleted. Please take note that context must be set previously by calling FaceAuthService.setContext(android.content.Context) (For example, if there is a change in Activity).

Parameters:

callback - The callback to be triggered as soon as the operation completes with any result. Must never be null. Note that the callback is always called from within the main UI thread context and always after this method returns to its caller.

addFaceAuthEnrollerListener

void addFaceAuthEnrollerListener(FaceAuthEnrollerListener listener)

Add a listener to receive FaceAuthFrameEvent as soon as the enroll(int, FaceAuthEnrollerCallback) is called

Parameters:

listener - Listener to be added

removeFaceAuthEnrollerListener

void removeFaceAuthEnrollerListener(FaceAuthEnrollerListener listener)

Remove a FaceAuthEnrollerListener that has been added in addFaceAuthEnrollerListener(FaceAuthEnrollerListener) Removal of listener is mandatory after the enrollment is completed!

Parameters:

listener - Listener to be removed

cancelEnrollmentProcess

boolean cancelEnrollmentProcess()

Cancel enrollment process. It must be invoked if user cancels the enrollment while it is in progress!

Returns:

true if enrollment has been cancelled false otherwise