Package com.appliedrec.verid.ui2

Interface VerIDSessionInViewDelegate

All Known Subinterfaces:

VerIDSessionDelegate

public interface VerIDSessionInViewDelegate

Ver-ID session delegate to use with VerIDSessionInView

Method Summary

Modifier and Type	Method	Description
default java.util.function.Function<android.content.Context,IImageIterator>	createImageIteratorFactory(IVerIDSession<?> session)
default SessionFunctions	createSessionFunctions(IVerIDSession<?> session, VerID verID, VerIDSessionSettings sessionSettings)
default int	getCapturedImageMinimumArea()
default CameraLocation	getSessionCameraLocation(IVerIDSession<?> session)	Called by the session to see which camera lens to use to capture the session faces
void	onSessionFinished(IVerIDSession<?> session, VerIDSessionResult result)	Called when session finishes
default boolean	shouldSessionRecordVideo(IVerIDSession<?> session)
default boolean	shouldSessionSpeakPrompts(IVerIDSession<?> session)	Called to see whether to use speech to communicate the session prompts to the user

Method Detail

onSessionFinished

void onSessionFinished(@NonNull
                       IVerIDSession<?> session,
                       @NonNull
                       VerIDSessionResult result)

Called when session finishes

Parameters:

session - Session that finished

result - Session result

Since:

2.0.0

shouldSessionSpeakPrompts

default boolean shouldSessionSpeakPrompts(@NonNull
                                          IVerIDSession<?> session)

Called to see whether to use speech to communicate the session prompts to the user

Parameters:

session - Session

Returns:

true to speak the session prompts

Since:

2.0.0

getSessionCameraLocation

@NonNull
default CameraLocation getSessionCameraLocation(@NonNull
                                                IVerIDSession<?> session)

Called by the session to see which camera lens to use to capture the session faces

Parameters:

session - Session

Returns:

CameraLocation.BACK to use the back camera or CameraLocation.FRONT (default) to use the front-facing (selfie) camera

Since:

2.0.0

shouldSessionRecordVideo

default boolean shouldSessionRecordVideo(@NonNull
                                         IVerIDSession<?> session)

Parameters:

session - Session which should be recorded

Returns:

true to record session video

Since:

2.0.0

createImageIteratorFactory

@NonNull
default java.util.function.Function<android.content.Context,IImageIterator> createImageIteratorFactory(@NonNull
                                                                                                             IVerIDSession<?> session)

Returns:

Function that creates image iterator from an instance of VerID

Since:

2.0.0

createSessionFunctions

@NonNull
default SessionFunctions createSessionFunctions(@NonNull
                                                IVerIDSession<?> session,
                                                @NonNull
                                                VerID verID,
                                                @NonNull
                                                VerIDSessionSettings sessionSettings)

Parameters:

verID - Instance of VerID to use in session functions

sessionSettings - Session settings to use in session functions

Returns:

Functions that control the liveness detection logic of the session

Since:

2.0.0

getCapturedImageMinimumArea

default int getCapturedImageMinimumArea()

Returns:

Minimum image area (width x height) to capture for face detection and recognition (in pixels).

Since:

2.5.0