LivenessEngine

Superclass:
NSObject
Declared In:

Introduction

Liveness check engine class.



Methods

-checkLiveness:error:

Checks liveness from the given WAV file.

-checkLiveness:sampleRate:error:

Checks liveness from the given PCM16 audio samples.

-initWithPath:error:

Creates LivenessEngine instance.


checkLiveness:error:


Checks liveness from the given WAV file.

- (LivenessResult* _Nullable)checkLiveness:(NSString* _Nonnull)wavFile 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
wavFile

path to the WAV file

error

pointer to NSError for error reporting

Return Value

Liveness check result.


checkLiveness:sampleRate:error:


Checks liveness from the given PCM16 audio samples.

- (LivenessResult* _Nullable)checkLiveness:(NSData* _Nonnull)PCM16Samples 
        sampleRate:(size_t)sampleRate error:(NSError* _Nullable* _Nullable)error; 
Parameters
PCM16Samples

audio samples in PCM16 format

sampleRate

sampling rate of audio samples in Hz

error

pointer to NSError for error reporting

Return Value

Liveness check result.


initWithPath:error:


Creates LivenessEngine instance.

- (instancetype _Nullable)initWithPath:(NSString* _Nonnull)path 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
path

initialization data path

error

pointer to NSError for error reporting