IDLive Face C# API  1.50.5
Classes | Enumerations
Idrnd.FaceSdk Namespace Reference

Classes

class  FaceException
 Custom runtime exception for FaceSDK methods More...
 
class  StatusInfo
 Result status info, contains the same info as FaceException More...
 
class  OptionalResult
 Optional result wrapper, wraps an instance of a result class and only allows to access it when status is OK. More...
 
class  Meta
 Meta information provided for calibration More...
 
class  Image
 Class for storing image in Face SDK format More...
 
class  ImageBatch
 Class for storing Image batch (a sequence of photos) More...
 
class  InitConfig
 Configuration file parser More...
 
struct  QualityResult
 Quality estimation result More...
 
struct  LivenessResult
 Liveness detection result More...
 
struct  PipelineResult
 Liveness detection result More...
 
class  Pipeline
 Liveness detection pipeline More...
 
struct  LicenseFeatureInfo
 IDLive Face license feature info More...
 
class  VersionInfo
 FaceSDK version info More...
 
class  Settings
 Provides a way to control global FaceSDK configuration More...
 
class  QualityEngine
 Quality estimation engine More...
 
struct  BoundingBox
 Face rectangle bounding box More...
 
struct  HeadPose
 Set of yaw, pith, and roll angles (in degrees) More...
 
struct  Keypoints
 Facial key points More...
 
struct  FaceParameters
 Facial parameters More...
 
struct  DetectionResult
 Face detection result More...
 
class  DetectEngine
 Face detection engine More...
 

Enumerations

enum class  FaceExceptionStatus {
  FACE_TOO_CLOSE = 0 , FACE_CLOSE_TO_BORDER = 1 , FACE_CROPPED = 2 , FACE_NOT_FOUND = 3 ,
  TOO_MANY_FACES = 4 , FACE_TOO_SMALL = 5 , FACE_ANGLE_TOO_LARGE = 6 , FAILED_TO_READ_IMAGE = 7 ,
  FAILED_TO_WRITE_IMAGE = 8 , FAILED_TO_READ_MODEL = 9 , FAILED_TO_BUILD_INTERPRETER = 10 , FAILED_TO_INVOKE_INTERPRETER = 11 ,
  FAILED_TO_ALLOCATE = 12 , INVALID_CONFIG = 13 , NO_SUCH_OBJECT_IN_BUILD = 14 , FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICT = 15 ,
  FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECT = 16 , FAILED_TO_PREDICT_LANDMARKS = 17 , INVALID_FUSE_MODE = 18 , NULLPTR = 19 ,
  LICENSE_ERROR = 20 , INVALID_META = 21 , UNKNOWN = 22 , OK
}
 FaceException error code More...
 
enum class  ColorEncoding { RGB888 = 0 , BGR888 = 1 }
 Color encoding enum More...
 
enum class  MetaOs { ANDROID = 0 , IOS = 1 , DESKTOP = 2 , UNKNOWN = 3 }
 OS type for calibration More...
 
enum class  MetaModel { UNKNOWN = 0 }
 Device model More...
 
enum class  MetaManufacturer { UNKNOWN = 0 }
 Device manufacture More...
 
enum class  MetaCalibration { REGULAR = 0 , SOFT = 1 }
 Liveness checking threshold calibration type More...
 
enum class  LicenseFeature { PAD = 12 , DFD = 13 }
 IDLive Face license features More...
 
enum class  ThreadingLevel { PIPELINE = 0 , ENGINE = 1 , OPERATOR = 2 }
 FaceSDK threading level, used to set different number of threads for different levels More...
 

Enumeration Type Documentation

◆ ColorEncoding

Color encoding enum

Enumerator
RGB888 

Bytes in RGB format

BGR888 

Bytes in BGR format

◆ FaceExceptionStatus

FaceException error code

Enumerator
FACE_TOO_CLOSE 

A distance between face and image border is too small for preprocessing issues

FACE_CLOSE_TO_BORDER 

Face is too close to one or more borders. May reduce the accuracy of spoofing detection because edges of face may not be seen

FACE_CROPPED 

Face is cropped. May reduce the accuracy of spoofing detection because edges of face may not be seen

FACE_NOT_FOUND 

Face detector can't find face on image

TOO_MANY_FACES 

Face detector found more than one face on image

FACE_TOO_SMALL 

Facial area is not big enough for analysis

FACE_ANGLE_TOO_LARGE 

Facial out-of-plane rotation angle is extremely large

FAILED_TO_READ_IMAGE 

File decoding error

FAILED_TO_WRITE_IMAGE 

File encoding error

FAILED_TO_READ_MODEL 

Model deserializing error

FAILED_TO_BUILD_INTERPRETER 

tflite::Interpreter building error

FAILED_TO_INVOKE_INTERPRETER 

tflite::Interpreter invoking error

FAILED_TO_ALLOCATE 

Memory allocation error

INVALID_CONFIG 

Config deserializing error

NO_SUCH_OBJECT_IN_BUILD 

Engine or backend is not supported by the build

FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICT 

Liveness prediction error

FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECT 

Face detection error

FAILED_TO_PREDICT_LANDMARKS 

Landmarks prediction error

INVALID_FUSE_MODE 

Invalid fuse mode provided

NULLPTR 

Nullptr provided

LICENSE_ERROR 

Some error occurred during license checking

INVALID_META 

Invalid facesdk::Meta value

UNKNOWN 

Unhandled exception in the code

OK 

No errors

◆ LicenseFeature

IDLive Face license features

Enumerator
PAD 

Presentation attack detection functionality

DFD 

Deepfake detection functionality

◆ MetaCalibration

Liveness checking threshold calibration type

Enumerator
REGULAR 

Regular calibration, provides a good balance between APCER and BPCER

SOFT 

Soft calibration, designed to reduce false rejection rates while still providing reliable attack detection

◆ MetaManufacturer

Device manufacture

Enumerator
UNKNOWN 

Unknown manufacture

◆ MetaModel

Device model

Enumerator
UNKNOWN 

Unknown model

◆ MetaOs

enum Idrnd.FaceSdk.MetaOs
strong

OS type for calibration

Enumerator
ANDROID 

Android OS

IOS 

iOS

DESKTOP 

Any desktop OS

UNKNOWN 

Unknown OS

◆ ThreadingLevel

FaceSDK threading level, used to set different number of threads for different levels

Enumerator
PIPELINE 

Pipeline threading level, corresponding environment variable: FACESDK_NUM_THREADS_PIPELINE

ENGINE 

Single engine (e.g. Pipeline, QualityEngine) threading level, corresponding environment variable: FACESDK_NUM_THREADS_ENGINE

OPERATOR 

Single internal engine operator threading level, corresponding environment variable: FACESDK_NUM_THREADS_OPERATOR