Package com.regula.facesdk.configuration

Class LivenessConfiguration

java.lang.Object

com.regula.facesdk.configuration.CameraConfiguration

com.regula.facesdk.configuration.LivenessConfiguration

public final class LivenessConfiguration
extends CameraConfiguration

The configuration provides convenient properties to change the behavior and the appearance of the Liveness UI module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LivenessConfiguration.Builder	Build a new LivenessConfiguration.

Field Summary

Fields

Modifier and Type	Field	Description
static final <any>	CREATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LivenessConfiguration(LivenessConfiguration.Builder init)

Method Summary

Modifier and Type	Method	Description
int	describeContents()
int	getAttemptsCount()	Returns the number of attempts
JSONObject	getMetadata()
Class<? extends BaseFaceLivenessProcessingFragment>	getProcessingFragment()
RecordingProcess	getRecordingProcess()	Return the flag from RecordingProcess enum to recording liveness process
LivenessSkipStep[]	getSkipStep()
String	getTag()
LivenessType	getType()
boolean	isLocationTrackingEnabled()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.regula.facesdk.configuration.CameraConfiguration

getCameraId, getRegisteredUiFragmentClass, getScreenOrientation, getScreenOrientationInt, hasCopyright, isCameraSwitchEnabled, isCloseButtonEnabled, isTorchButtonEnabled, isVibrateOnSteps

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CREATOR

public static final <any> CREATOR

Constructor Details

LivenessConfiguration

protected LivenessConfiguration(LivenessConfiguration.Builder init)

Method Details

getAttemptsCount

public int getAttemptsCount()

Returns the number of attempts

Returns:

When attemptsCount is `0` Liveness will always ask to retry on error. When attemptsCount is `1` or more Liveness will end with ProcessingAttemptsEnded error when the number of attemps exceeds.

getRecordingProcess

public RecordingProcess getRecordingProcess()

Return the flag from RecordingProcess enum to recording liveness process

Returns:

Default: RecordingProcess.ASYNCHRONOUS_UPLOAD.

isLocationTrackingEnabled

public boolean isLocationTrackingEnabled()

getTag

public String getTag()

getSkipStep

public LivenessSkipStep[] getSkipStep()

getType

public LivenessType getType()

getMetadata

public JSONObject getMetadata()

getProcessingFragment

public Class<? extends BaseFaceLivenessProcessingFragment> getProcessingFragment()

writeToParcel

public void writeToParcel(Parcel dest,
 int flags)

Overrides:

writeToParcel in class CameraConfiguration

describeContents

public int describeContents()