SybrinFacialRecognition

import com.sybrin.facialrecognition.SybrinFacialRecognition

To see this class and its functionality in action go visit our Facial Recognition feature page!

Summary

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

Public methods
SybrinFacialRecognitionConfiguration	getConfiguration()
FacialRecognitionInitializer<FacialRecognitionInitializationModel>	loadModel(String identifier)
FacialRecognizer<FacialRecognitionModel>	openFacialRecognition(String identifier)
FacialTrainer<FacialTrainingModel>	trainFace(String identifier)

Static methods

getBuiltInstance

public static SybrinFacialRecognition getBuiltInstance ()

Returns an already built instance of the SybrinFacialRecognition class.

Returns
SybrinFacialRecognition	This value cannot be null.

getInstance

public static SybrinFacialRecognition getInstance (Context context, SybrinFacialRecognitionConfiguration configuration)

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

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

Returns
SybrinFacialRecognition	This value cannot be null.

Public methods

getConfiguration

public SybrinFacialRecognitionConfiguration getConfiguration ()

Returns the SybrinFacialRecognitionConfiguration provided when the SybrinFacialRecognition instance was created.

Returns
SybrinFacialRecognitionConfiguration	This value cannot be null.

loadModel

public FacialRecognitionInitializer<FacialRecognitionInitializationModel> loadModel (String identifier)

Initializes all components needed for facial recognition and training. This includes downloading the saved facial recognition model associated with the provided identifier if available.

Parameters
identifier	String: Unique string used to locate saved facial recognition model.

Returns
FacialRecognitionInitializer<FacialRecognitionInitializationModel>	This value cannot be null.

openFacialRecognition

public FacialRecognizer<FacialRecognitionModel> openFacialRecognition (String identifier)

Starts the facial recognition process.

Parameters
identifier	String: Unique string used to recognize the presented face.

Returns
FacialRecognizer<FacialRecognitionModel>	This value cannot be null.

trainFace

public FacialTrainer<FacialTrainingModel> trainFace (String identifier)

Starts the facial training process.

Parameters
identifier	String: Unique string that is associated with the trained model.

Returns
FacialTrainer<FacialTrainingModel>	This value cannot be null.