Liveness Engine SDK
Liveness detection engine.
 All Classes Files Functions Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
lsdk::ILivenessEngine Struct Referenceabstract
Liveness detection.

Root Liveness SDK object interface. More...

#include <LivenessEngine.h>

Inheritance diagram for lsdk::ILivenessEngine:

Public Member Functions

virtual fsdk::ResultValue
< fsdk::FSDKError, fsdk::Ref
< ILiveness > > 		createLiveness (LivenessAlgorithmType type) noexcept=0
 Creates a simple liveness of given type. More...
 
virtual fsdk::ResultValue
< fsdk::FSDKError, fsdk::Ref
< IUnifiedLiveness > > 		createUnifiedLiveness (LivenessAlgorithmType type) noexcept=0
 Creates a unified liveness which performs all possible calculations and tracks value from given type. More...
 
virtual fsdk::ResultValue
< fsdk::FSDKError, fsdk::Ref
< IComplexLiveness > > 		createComplexLiveness (ComplexLivenessAlgorithmType type) noexcept=0
 Creates a complex liveness of given type. More...
 
virtual void setSettingsProvider (fsdk::ISettingsProvider *provider) noexcept=0
 Sets settings provider. More...
 
virtual fsdk::ISettingsProvider * getSettingsProvider () const noexcept=0
 Gets settings provider. More...
 
virtual void setDataDirectory (const char *path) noexcept=0
 Sets data directory. More...
 
virtual const char * getDataDirectory () const noexcept=0
 Gets data directory. More...
 

Detailed Description

Root Liveness SDK object interface.

Note
Liveness Engine also implements factory interface so all usual factory options apply.

Member Function Documentation

virtual fsdk::ResultValue<fsdk::FSDKError, fsdk::Ref<IComplexLiveness> > lsdk::ILivenessEngine::createComplexLiveness ( ComplexLivenessAlgorithmType  type)
pure virtualnoexcept

Creates a complex liveness of given type.

Parameters
[in]typecomplex liveness type.
Note
The following types are supported:
  • CLA_DEPTH
See Also
LivenessAlgorithmType for more information.
Returns
Complex liveness object if succeeded, nullptr if failed.
virtual fsdk::ResultValue<fsdk::FSDKError, fsdk::Ref<ILiveness> > lsdk::ILivenessEngine::createLiveness ( LivenessAlgorithmType  type)
pure virtualnoexcept

Creates a simple liveness of given type.

Parameters
[in]typeliveness type.
Note
The following types are supported:
  • LA_PITCH_DOWN,
  • LA_PITCH_UP,
  • LA_YAW_LEFT,
  • LA_YAW_RIGHT,
  • LA_SMILE,
  • LA_MOUTH,
  • LA_EYEBROW,
  • LA_EYE,
  • LA_INFRARED
See Also
LivenessAlgorithmType for more information.
Returns
liveness object if succeeded, nullptr if failed.
virtual fsdk::ResultValue<fsdk::FSDKError, fsdk::Ref<IUnifiedLiveness> > lsdk::ILivenessEngine::createUnifiedLiveness ( LivenessAlgorithmType  type)
pure virtualnoexcept

Creates a unified liveness which performs all possible calculations and tracks value from given type.

Parameters
[in]typeliveness type to track.
See Also
LivenessAlgorithmType for more information.
Returns
Unified liveness object if succeeded, nullptr if failed.
virtual const char* lsdk::ILivenessEngine::getDataDirectory ( ) const
pure virtualnoexcept

Gets data directory.

By default is set to "./data".

Returns
path to data directory.
virtual fsdk::ISettingsProvider* lsdk::ILivenessEngine::getSettingsProvider ( ) const
pure virtualnoexcept

Gets settings provider.

Returns
settings provider.
virtual void lsdk::ILivenessEngine::setDataDirectory ( const char *  path)
pure virtualnoexcept

Sets data directory.

Parameters
[in]pathpath to data directory.
virtual void lsdk::ILivenessEngine::setSettingsProvider ( fsdk::ISettingsProvider *  provider)
pure virtualnoexcept

Sets settings provider.

Parameters
[in]providersettings provider.
The documentation for this struct was generated from the following file: