VerIDSessionSettings

Base class for session settings

Constructors

VerIDSessionSettings

Introduced in version 1.8

public VerIDSessionSettings()

VerIDSessionSettings

Introduced in version 1.8

public VerIDSessionSettings(JSONObject)

Parameters

jsonObject org.json.JSONObject

Methods

toJSON

Introduced in version 1.8

public toJSON()

Returns

org.json.JSONObject

Throws

org.json.JSONException

describeContents

Introduced in version 1.8

public describeContents()

Returns

int

Properties

numberOfResultsToCollect

Introduced in version 1.8

public int numberOfResultsToCollect

Number of results to collect in the session

expiryTime

Introduced in version 1.8

public long expiryTime

Milliseconds before the session expires

showGuide

Introduced in version 1.8

Deprecated in version 3.1.0

public boolean showGuide

Set to true to show screens that guide the user through the task before the session starts.

showResult

Introduced in version 3.1.0

public boolean showResult

Set to true to show the result at the end of the session.

apiSecret

Introduced in version 2.0.2

public String apiSecret

The Ver-ID SDK API secret of the app running the session. If set, this will take precedence over the API secret set in the app's manifest.

cameraId

Introduced in version 2.0.5

Deprecated in 4.3.0. Use com.appliedrec.ver_id.session.VerIDSessionSettings.html#cameraLensFacing

public int cameraId

The ID of the camera to use in this session. Defaults to Camera.CameraInfo.CAMERA_FACING_FRONT.

cameraLensFacing

Introduced in version 4.3.0

public VerIDSessionSettings.CameraLensFacing cameraLensFacing

Camera to use in the session. Defaults to the front-facing camera (CameraLensFacing.FRONT).

cameraMirroring

Introduced in version 4.1.0

public boolean cameraMirroring

Indicates whether to mirror the image received from the camera preview false (default): Let the system decide based on the camera location on the device true Force the image to be mirrored

videoURL

Introduced in version 4.3.0

public Uri videoURL

File URI to which a video recording of the session will be saved. Set to null (default) to disable video recording.

maxRetryCount

Introduced in version 1.8

public int maxRetryCount

includeFaceTemplatesInResult

Introduced in version 1.8

public boolean includeFaceTemplatesInResult

If set to true the session result will include the face templates collected in the session. Templates can be used for comparison with other faces.

sessionLocale

Introduced in version 4.4.0

public Locale sessionLocale

Set to override the locale setting for the duration of the Ver-ID session.