VerIDSessionResult

Represents the result of a registration or authentication session

Package com.appliedrec.ver_id.session

public class VerIDSessionResult

Implements

Constructors

VerIDSessionResult

Introduced in version 1.6

public VerIDSessionResult()

VerIDSessionResult

Introduced in version 1.6

public VerIDSessionResult(VerIDSessionResult.Outcome)

Parameters

outcome com.appliedrec.ver_id.session.VerIDSessionResult.Outcome

VerIDSessionResult

Introduced in version 1.6

public VerIDSessionResult(VerIDSessionResult.Outcome, Uri, FBFace, VerID.Bearing)

Parameters

outcome com.appliedrec.ver_id.session.VerIDSessionResult.Outcome
imageUri android.net.Uri
face com.appliedrec.detreclib.detection.FBFace
bearing com.appliedrec.ver_id.VerID.Bearing

Methods

getIdentifiedUsers

Introduced in version 1.6

public getIdentifiedUsers()

Returns

com.appliedrec.ver_id.model.VerIDUser[]
Users identified (or registered) in the session

getConstituentResults

Introduced in version 1.6

public getConstituentResults()

Returns

java.util.List<VerIDSessionResult>
Individual results that constitute the final session result

isPositive

Introduced in version 1.6

public isPositive()

Returns

boolean
true if the result is positive (successful)

getFaces

Introduced in version 1.8

public getFaces(VerID.Bearing)

Get faces with the given bearing

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing
The requested bearing

Returns

com.appliedrec.ver_id.model.VerIDFace[]
Array of face objects

getFaces

Introduced in version 2.0.1

public getFaces()

Get faces with any bearing

Returns

com.appliedrec.ver_id.model.VerIDFace[]
Array of face objects

See also

getFacesSuitableForRecognition

Introduced in version 2.0.1

public getFacesSuitableForRecognition(VerID.Bearing)

Get faces with the given bearing that are suitable for face recognition

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing

Returns

com.appliedrec.ver_id.model.VerIDFace[]
Array of face objects

getFacesSuitableForRecognition

Introduced in version 2.0.1

public getFacesSuitableForRecognition()

Get aces that are suitable for face recognition

Returns

com.appliedrec.ver_id.model.VerIDFace[]
Array of face objects

getFaceImages

Introduced in version 1.8

public getFaceImages(VerID.Bearing)

Get faces with the given bearing and their corresponding images collected in this session

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing
The requested bearing

Returns

java.util.HashMap<VerIDFace, Uri>
A map of faces and image URIs

getFaceImages

Introduced in version 1.8

public getFaceImages()

Get all faces with and their corresponding images collected in this session

Returns

java.util.HashMap<VerIDFace, Uri>
A map of faces and image URIs

getImageUris

Introduced in version 1.8

public getImageUris(VerID.Bearing)

Get URIs of images collected in the session where the face matches the given bearing

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing
The requested face bearing

Returns

android.net.Uri[]
Image URIs. Use content resolver to read the files

getImageUris

Introduced in version 1.8

public getImageUris()

Get URIs of images collected in the session

Returns

android.net.Uri[]
Image URIs. Use content resolver to read the files

getFaceTemplates

Introduced in version 1.8

2.0.1

public getFaceTemplates(VerID.Bearing)

Get the recorded face templates for the given bearing. This is only available in results of a liveness detection session where VerIDLivenessDetectionSessionSettings.includeFaceTemplatesInResult is set to true.

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing
Bearing of the faces in the returned templates

Returns

java.util.HashMap<FBFace, float>
Face templates of faces with bearing recorded in the session

See also

getRecognitionFaces

Introduced in version 2.0.1

3.2.0

public getRecognitionFaces()

Get faces with extracted templates.

Returns

com.appliedrec.ver_id.model.RecognitionFace[]
Array of RecognitionFace objects

getRecognitionFaces

Introduced in version 2.0.1

3.2.0

public getRecognitionFaces(VerID.Bearing)

Get faces with extracted templates and given bearing.

Parameters

bearing com.appliedrec.ver_id.VerID.Bearing

Returns

com.appliedrec.ver_id.model.RecognitionFace[]
Array of RecognitionFace objects

getRetryCount

Introduced in version 4.0.2

public getRetryCount()

How many times has the user failed and retried

Returns

int
0 if session succeeded on first try

Properties

outcome

Introduced in version 1.6

public VerIDSessionResult.Outcome outcome

The outcome of the session