TechTrue® Android SDK  

V1.3.7

Android SDK for TechTrue®'s face recognition
br.com.techmag.ttface.TTFaceRecognitionService Class Reference

Public Member Functions

 TTFaceRecognitionService ()
 
void releaseInstance () throws TTException
 
TTPerson createPerson ()
 
TTPerson createPerson (String extId)
 
void clearDB ()
 
String getSdkVersion ()
 
void deactivateDevice () throws TTException
 

Static Public Member Functions

static TTFaceRecognitionService getInstance ()
 
static TTFaceRecognitionService createInstance (Context ctx) throws TTException
 

Detailed Description

Provides main access to TTFace SDK functionality.

Creates an instance by calling createInstance() static method, then applications may use createPerson() method to have access to main face recognition features. All allocated resources will be released by calling releaseInstance() method.

Constructor & Destructor Documentation

◆ TTFaceRecognitionService()

br.com.techmag.ttface.TTFaceRecognitionService.TTFaceRecognitionService ( )
inline

Member Function Documentation

◆ clearDB()

void br.com.techmag.ttface.TTFaceRecognitionService.clearDB ( )
inline

Clears the entire Face Database.

Warning! This operation cannot be reverted!

◆ createInstance()

static TTFaceRecognitionService br.com.techmag.ttface.TTFaceRecognitionService.createInstance ( Context  ctx) throws TTException
inlinestatic

Creates new instance of TTFace SDK.

Parameters
ctxAndroid app Context reference
Returns
TTFaceRecognitionService object
Exceptions
TTExceptionWhen could not initialize the native library

◆ createPerson() [1/2]

TTPerson br.com.techmag.ttface.TTFaceRecognitionService.createPerson ( )
inline

Person factory. Used to interact with face recognition features.

Returns
TTPerson object

◆ createPerson() [2/2]

TTPerson br.com.techmag.ttface.TTFaceRecognitionService.createPerson ( String  extId)
inline

Person factory. Used to interact with face recognition features.

Parameters
extIdExternal ID that will be stored within this Person
Returns
TTPerson object

◆ deactivateDevice()

void br.com.techmag.ttface.TTFaceRecognitionService.deactivateDevice ( ) throws TTException
inline

Deactivates the Device.

This method will deactivate the SDK on a device. Future usage shall have the device to be activated again in order to work.

This method requires internet connection to work!

◆ getInstance()

static TTFaceRecognitionService br.com.techmag.ttface.TTFaceRecognitionService.getInstance ( )
inlinestatic

◆ getSdkVersion()

String br.com.techmag.ttface.TTFaceRecognitionService.getSdkVersion ( )
inline

Gets the SDK version in use.

Returns
String with the version following SemVer format MAJOR.MINOR.PATCH.

◆ releaseInstance()

void br.com.techmag.ttface.TTFaceRecognitionService.releaseInstance ( ) throws TTException
inline

Releases all allocated resources

Exceptions
TTExceptionWhen could not release resources