SybrinLivenessDetection

import com.sybrin.livenessdetection.SybrinLivenessDetection

To see this class and its functionality in action go visit our Liveness Detection feature page!

Summary

Static methods
SybrinLivenessDetection	getBuiltInstance() Returns an already built instance of the SybrinLivenessDetection class.
SybrinLivenessDetection	getInstance(Context context, SybrinLivenessDetectionConfiguration configuration) Creates and returns an instance of the SybrinLivenessDetection class.

Public methods
SybrinLivenessDetectionConfiguration	getConfiguration()
ActiveLivenessDetector <ActiveLivenessDetectionModel>	openActiveLivenessDetection()
ActiveLivenessDetector <ActiveLivenessDetectionModel>	openActiveLivenessDetection(ActiveLivenessDetectionAction[] activeLivenessActions)
ActivePassiveLivenessDetector <ActivePassiveLivenessDetectionModel>	openActivePassiveLivenessDetection()
ActivePassiveLivenessDetector <ActivePassiveLivenessDetectionModel>	openActivePassiveLivenessDetection(ActivePassiveLivenessDetectionAction[] activePassiveLivenessActions)
PassiveLivenessDetector <PassiveLivenessDetectionModel>	openPassiveLivenessDetection()
SingleImagePassiveLivenessDetector <PassiveLivenessDetectionModel>	passiveLivenessDetectionFromImage(Bitmap image)

Static methods

getBuiltInstance

public static SybrinLivenessDetection getBuiltInstance ()

Returns an already built instance of the SybrinLivenessDetection class.

Returns
SybrinLivenessDetection	This value cannot be null.

getInstance

public static SybrinLivenessDetection getInstance (Context context, SybrinLivenessDetectionConfiguration configuration)

Creates and returns an instance of the SybrinLivenessDetection class using the provided configuration.

Parameters
context	Context
configuration	SybrinLivenessDetectionConfiguration : The built configuration needed by the SDK to manipulate behavior.

Returns
SybrinLivenessDetection	This value cannot be null.

Public methods

getConfiguration

public SybrinLivenessDetectionConfiguration getConfiguration ()

Returns the SybrinLivenessDetectionConfiguration provided when the SybrinLivenessDetection instance was created.

Returns
SybrinLivenessDetectionConfiguration	This value cannot be null.

openActiveLivenessDetection

public ActiveLivenessDetector<ActiveLivenessDetectionModel> openActiveLivenessDetection ()

Starts the active liveness detection process.

Returns
ActiveLivenessDetector <ActiveLivenessDetectionModel>	This value cannot be null.

openActiveLivenessDetection

public ActiveLivenessDetector<ActiveLivenessDetectionModel> openActiveLivenessDetection (ActiveLivenessDetectionAction[] activeLivenessActions)

Starts the active liveness detection process with custom actions.

Parameters
activeLivenessActions	ActiveLivenessDetectionAction[]: Actions that the subject will be prompted with during the active liveness detection process.

Returns
ActiveLivenessDetector <ActiveLivenessDetectionModel>	This value cannot be null.

openActivePassiveLivenessDetection

public ActivePassiveLivenessDetector<ActivePassiveLivenessDetectionModel> openActivePassiveLivenessDetection ()

Starts the active liveness detection process.

Returns
ActivePassiveLivenessDetector <ActivePassiveLivenessDetectionModel>	This value cannot be null.

openActivePassiveLivenessDetection

public ActivePassiveLivenessDetector<ActivePassiveLivenessDetectionModel> openActivePassiveLivenessDetection (ActivePassiveLivenessDetectionAction[] activePassiveLivenessActions)

Starts the active passive liveness detection process with custom actions.

Parameters
activePassiveLivenessActions	ActivePassiveLivenessDetectionAction[]: Actions that the subject will be prompted with during the active passive liveness detection process.

Returns
ActivePassiveLivenessDetector <ActivePassiveLivenessDetectionModel>	This value cannot be null.

openPassiveLivenessDetection

public PassiveLivenessDetector<PassiveLivenessDetectionModel> openPassiveLivenessDetection()

Starts the passive liveness detection process.

Returns
PassiveLivenessDetector<PassiveLivenessDetectionModel>	This value cannot be null.

passiveLivenessDetectionFromImage

public SingleImagePassiveLivenessDetector<PassiveLivenessDetectionModel> passiveLivenessDetectionFromImage(Bitmap image)

Performs passive liveness detection on a single image.

Parameters
image	Bitmap: Image of face used for passive liveness detection.

Returns
SingleImagePassiveLivenessDetector <PassiveLivenessDetectionModel>	This value cannot be null.