idliveface.h File Reference

#include <idliveface/base_types.h>
#include <idliveface/exception.h>

Classes
struct	idliveface::LicenseFeatureInfo
	IDLive Face license feature info. More...
struct	idliveface::ReleaseInfo
	Information about the IDLive Face release. More...
class	idliveface::Image
	Contains the content of the decoded image. More...
class	idliveface::ImageDecoder
	Decodes compressed images. More...
struct	idliveface::DetectedFace
	The information about the detected face. More...
struct	idliveface::FaceDetectionResult
	The result of the face detection. More...
class	idliveface::FaceDetector
	Detects and validates faces and their attributes. More...
struct	idliveface::FaceAnalysisResult
	The result of the face analysis. More...
struct	idliveface::FaceAnalysisParameters
	Optional parameters for the face analysis. More...
class	idliveface::FaceAnalyzer
	Detects face on the image and analyzes if it belongs to a real person or not. More...
class	idliveface::Blueprint
	Factory for the IDLive Face's objects. More...

Enumerations
enum class	idliveface::LicenseFeature {   kPad = 12 ,   kDfd = 13 }
	IDLive Face license features. More...
enum class	idliveface::FaceStatus {   kGenuine ,   kNotGenuine ,   kInvalid }
	The status of the analyzed face. More...

Functions
ReleaseInfo	idliveface::GetReleaseInfo ()
	Returns information about this IDLive Face release.
void	idliveface::SetLicense (const std::string &license)
	Sets a new license to be used.
RuntimeConfiguration	idliveface::CreateRuntimeConfiguration (int32_t effective_cpu_cores=0)
	Creates RuntimeConfiguration with the fields set to optimized defaults.

Enumeration Type Documentation

FaceStatus

enum class idliveface::FaceStatus

strong

The status of the analyzed face.

Enumerator
kGenuine	The face on the image is genuine and belongs to a real person.
kNotGenuine	The face on the image is not genuine, which can be a result of the presentation attack.
kInvalid	The face on the image is not suitable for the analysis or not present at all.

LicenseFeature

enum class idliveface::LicenseFeature

strong

IDLive Face license features.

Enumerator
kPad	Presentation attack detection functionality.
kDfd	Deepfake detection functionality.

Function Documentation

CreateRuntimeConfiguration()

RuntimeConfiguration idliveface::CreateRuntimeConfiguration

(

int32_t

effective_cpu_cores = 0

)

Creates RuntimeConfiguration with the fields set to optimized defaults.

By default assumes all CPU cores should be used. If there is a need to use CPU resources, the number of cores can be limited with the effective_cpu_cores parameter.

Parameters

effective_cpu_cores

Number of CPU cores to use. 0 means "use all".