voicesdk::LivenessEngine Class Reference

Voice liveness check class. LivenessEngine is thread-safe. More...

#include <voicesdk/liveness/liveness.h>

Public Types
using	Ptr = std::shared_ptr< LivenessEngine >
	Smart pointer to LivenessEngine instance. More...

Public Member Functions
virtual LivenessResult	CheckLiveness (const uint8_t *pcm16_bytes, size_t num_bytes, size_t sample_rate) const =0
virtual LivenessResult	CheckLiveness (const int16_t *pcm16_samples, size_t num_samples, size_t sample_rate) const =0
virtual LivenessResult	CheckLiveness (const float *float_samples, size_t num_samples, size_t sample_rate) const =0
virtual LivenessResult	CheckLiveness (const std::string &audio_path) const =0
	Checks voice liveness from the given audio file. More...
virtual	~LivenessEngine ()=default

Static Public Member Functions
static LivenessEngine::Ptr	Create (const std::string &init_path)
	Creates LivenessEngine instance. More...

Detailed Description

Voice liveness check class. LivenessEngine is thread-safe.

Member Typedef Documentation

Ptr

using voicesdk::LivenessEngine::Ptr = std::shared_ptr<LivenessEngine>

Smart pointer to LivenessEngine instance.

Constructor & Destructor Documentation

~LivenessEngine()

virtual voicesdk::LivenessEngine::~LivenessEngine ( )

virtualdefault

Member Function Documentation

CheckLiveness() [1/4]

virtual LivenessResult voicesdk::LivenessEngine::CheckLiveness ( const float *  float_samples, size_t  num_samples, size_t  sample_rate  ) const

pure virtual

Checks voice liveness from the given float audio samples

Parameters

float_samples	A buffer containing normalized (from -1 to 1) float audio samples
num_samples	Number of samples
sample_rate	Audio sampling rate in Hz

Returns

Liveness check result

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

CheckLiveness() [2/4]

virtual LivenessResult voicesdk::LivenessEngine::CheckLiveness ( const int16_t *  pcm16_samples, size_t  num_samples, size_t  sample_rate  ) const

pure virtual

Checks voice liveness from the given PCM16 audio samples

Parameters

pcm16_samples	A buffer containing PCM16 audio samples
num_samples	Number of samples
sample_rate	Audio sampling rate in Hz

Returns

Liveness check result

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

CheckLiveness() [3/4]

virtual LivenessResult voicesdk::LivenessEngine::CheckLiveness ( const std::string &  audio_path ) const

pure virtual

Checks voice liveness from the given audio file.

Parameters

audio_path

Path to audio file

Returns

Liveness check result

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

CheckLiveness() [4/4]

virtual LivenessResult voicesdk::LivenessEngine::CheckLiveness ( const uint8_t *  pcm16_bytes, size_t  num_bytes, size_t  sample_rate  ) const

pure virtual

Checks voice liveness from the given audio bytes

Parameters

pcm16_bytes	A buffer containing byte representation of PCM16 audio samples
num_bytes	Number of bytes
sample_rate	Audio sampling rate in Hz

Returns

Liveness check result

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

Create()

static LivenessEngine::Ptr voicesdk::LivenessEngine::Create ( const std::string &  init_path )

static

Creates LivenessEngine instance.

Parameters

init_path

Initialization data path

Returns

Smart pointer to created LivenessEngine instance

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred