Package com.appliedrec.verid.ui2

Interface ISessionView

All Superinterfaces:

java.util.Iterator<FaceBounds>

All Known Implementing Classes:

BaseSessionView

public interface ISessionView
extends java.util.Iterator<FaceBounds>

Interface for views that render the camera preview and face detection overlay

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ISessionView.SessionViewListener	Session view listener

Method Summary

Modifier and Type	Method	Description
void	addListener(ISessionView.SessionViewListener listener)	Add a listener Call removeListener(SessionViewListener) when you no longer need to listen for session view events
void	drawFaces(java.util.List<? extends android.graphics.drawable.Drawable> faceImages)	Draw captured face images, e.g., faces captured during a registration session
int	getCapturedFaceImageHeight()	Get the height of the captured face images
FaceExtents	getDefaultFaceExtents()
int	getDisplayRotation()	Get the display rotation
java.lang.Class<?>	getPreviewClass()	Get preview class (used to determine the available camera preview sizes)
default void	onSessionStarted()
void	removeListener(ISessionView.SessionViewListener listener)	Remove a listener
default void	setCameraPreviewMirrored(boolean mirrored)
void	setDefaultFaceExtents(FaceExtents defaultFaceExtents)	Set default face extents
void	setFaceDetectionResult(FaceDetectionResult faceDetectionResult, java.lang.String prompt)	Set face detection result used to render camera preview overlay
void	setPreviewSize(int width, int height, int sensorOrientation)	Set the size of the camera preview
default void	setSessionSettings(VerIDSessionSettings sessionSettings)
default void	willFinishWithResult(VerIDSessionResult result, java.lang.Runnable completionCallback)

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

setDefaultFaceExtents

void setDefaultFaceExtents(FaceExtents defaultFaceExtents)

Set default face extents

Parameters:

defaultFaceExtents - Face extents (proportion of the view taken up by the face oval when no face is detected)

Since:

2.0.0

getPreviewClass

java.lang.Class<?> getPreviewClass()

Get preview class (used to determine the available camera preview sizes)

Returns:

Preview class

Since:

2.0.0

addListener

void addListener(ISessionView.SessionViewListener listener)

Add a listener Call removeListener(SessionViewListener) when you no longer need to listen for session view events

Parameters:

listener - Session view listener

Since:

2.0.0

removeListener

void removeListener(ISessionView.SessionViewListener listener)

Remove a listener

Parameters:

listener - Listener added using addListener(SessionViewListener)

Since:

2.0.0

setFaceDetectionResult

void setFaceDetectionResult(FaceDetectionResult faceDetectionResult,
                            java.lang.String prompt)

Set face detection result used to render camera preview overlay

Parameters:

faceDetectionResult - Face detection result or null to clear the face oval overlay

prompt - Prompt to be displayed above the detected face or null to hide the prompt

Since:

2.0.0

drawFaces

void drawFaces(java.util.List<? extends android.graphics.drawable.Drawable> faceImages)

Draw captured face images, e.g., faces captured during a registration session

Parameters:

faceImages - Face image drawables

Since:

2.0.0

getCapturedFaceImageHeight

int getCapturedFaceImageHeight()

Get the height of the captured face images

Returns:

Desired height of the captured face images (used to scale the images)

Since:

2.0.0

getDisplayRotation

int getDisplayRotation()

Get the display rotation

Returns:

Display rotation in degrees

Since:

2.0.0

setPreviewSize

void setPreviewSize(int width,
                    int height,
                    int sensorOrientation)

Set the size of the camera preview

Parameters:

width - Width of the images delivered by the camera preview

height - Height of the images delivered by the camera preview

sensorOrientation - Camera sensor orientation

Since:

2.0.0

getDefaultFaceExtents

FaceExtents getDefaultFaceExtents()

Returns:

Default face extents

Since:

2.0.0

setSessionSettings

default void setSessionSettings(VerIDSessionSettings sessionSettings)

Parameters:

sessionSettings - Session settings

Since:

2.7.0

setCameraPreviewMirrored

default void setCameraPreviewMirrored(boolean mirrored)

Parameters:

mirrored - Whether camera preview is mirrored (flipped horizontally)

Since:

2.7.0

willFinishWithResult

default void willFinishWithResult(VerIDSessionResult result,
                                  java.lang.Runnable completionCallback)

onSessionStarted

default void onSessionStarted()