#include <voicesdk/core/core_c_api.h>

Classes
struct	VoiceSdkLivenessResult
	Voice liveness check result. More...

Typedefs
typedef struct VoiceSdkLivenessEngine	VoiceSdkLivenessEngine
	Voice liveness check structure. More...

typedef enum VoiceSdkLivenessResultValidationStatusCode	VoiceSdkLivenessResultValidationStatusCode
	Status code of validation preceding liveness check. More...

typedef struct VoiceSdkLivenessResult	VoiceSdkLivenessResult
	Voice liveness check result. More...

Enumerations
enum	VoiceSdkLivenessResultValidationStatusCode { kVoiceSdkLivenessResultValidationStatusCodeOk, kVoiceSdkLivenessResultValidationStatusCodeTooSmallSpeechLength }
	Status code of validation preceding liveness check. More...

Functions
VOICE_SDK_API VoiceSdkLivenessEngine *	VoiceSdkLivenessEngineCreate (const char init_path, VoiceSdkErrorCode error_code, char **error_msg)
	Creates VoiceSdkLivenessEngine. More...

VOICE_SDK_API bool	VoiceSdkLivenessEngineCheckLivenessAudioFile (const VoiceSdkLivenessEngine engine, const char audio_path, VoiceSdkLivenessResult result, VoiceSdkErrorCode error_code, char **error_msg)
	Checks liveness from the given audio file. More...

VOICE_SDK_API bool	VoiceSdkLivenessEngineCheckLivenessBytes (const VoiceSdkLivenessEngine engine, const uint8_t bytes, size_t num_bytes, size_t sample_rate, VoiceSdkLivenessResult result, VoiceSdkErrorCode error_code, char **error_msg)
	Checks liveness from the given byte representation of PCM16 audio samples. More...

VOICE_SDK_API bool	VoiceSdkLivenessEngineCheckLivenessPcm16Samples (const VoiceSdkLivenessEngine engine, const int16_t pcm16_samples, size_t num_samples, size_t sample_rate, VoiceSdkLivenessResult result, VoiceSdkErrorCode error_code, char **error_msg)
	Checks liveness from the given PCM16 audio samples. More...

VOICE_SDK_API bool	VoiceSdkLivenessEngineCheckLivenessFloatSamples (const VoiceSdkLivenessEngine engine, const float float_samples, size_t num_samples, size_t sample_rate, VoiceSdkLivenessResult result, VoiceSdkErrorCode error_code, char **error_msg)
	Checks liveness from the given float audio samples. More...

VOICE_SDK_API void	VoiceSdkLivenessEngineRelease (VoiceSdkLivenessEngine *engine)
	Releases all memory allocated for this VoiceSdkLivenessEngine instance. More...

Typedef Documentation

◆ VoiceSdkLivenessEngine

typedef struct VoiceSdkLivenessEngine VoiceSdkLivenessEngine

Voice liveness check structure.

◆ VoiceSdkLivenessResult

typedef struct VoiceSdkLivenessResult VoiceSdkLivenessResult

Voice liveness check result.

◆ VoiceSdkLivenessResultValidationStatusCode

typedef enum VoiceSdkLivenessResultValidationStatusCode VoiceSdkLivenessResultValidationStatusCode

Status code of validation preceding liveness check.

Enumeration Type Documentation

◆ VoiceSdkLivenessResultValidationStatusCode

enum VoiceSdkLivenessResultValidationStatusCode

Status code of validation preceding liveness check.

Enumerator
kVoiceSdkLivenessResultValidationStatusCodeOk	Successful validation
kVoiceSdkLivenessResultValidationStatusCodeTooSmallSpeechLength	Speech length is too small for liveness check to be performed

Function Documentation

◆ VoiceSdkLivenessEngineCheckLivenessAudioFile()

VOICE_SDK_API bool VoiceSdkLivenessEngineCheckLivenessAudioFile	(	const VoiceSdkLivenessEngine *	engine,
		const char *	audio_path,
		VoiceSdkLivenessResult *	result,
		VoiceSdkErrorCode *	error_code,
		char **	error_msg
	)

Checks liveness from the given audio file.

Parameters

[in]	engine	instance of Liveness Engine created with VoiceSdkLivenessEngineCreate
[in]	audio_path	path to audio file on the filesystem
[out]	result	liveness check result, pointer to preallocated structure instance. Not changed unless this call returns true.
[out]	error_code	pointer to the error code.
[out]	error_msg	output error message. Points to the null-terminated string containing message in case of failure or to the NULL in case of success. The memory it points to should be freed manually.

Returns: true if call completed successfully, false otherwise

◆ VoiceSdkLivenessEngineCheckLivenessBytes()

VOICE_SDK_API bool VoiceSdkLivenessEngineCheckLivenessBytes	(	const VoiceSdkLivenessEngine *	engine,
		const uint8_t *	bytes,
		size_t	num_bytes,
		size_t	sample_rate,
		VoiceSdkLivenessResult *	result,
		VoiceSdkErrorCode *	error_code,
		char **	error_msg
	)

Checks liveness from the given byte representation of PCM16 audio samples.

Parameters

[in]	engine	instance of Liveness Engine created with VoiceSdkLivenessEngineCreate
[in]	bytes	pointer to byte array containing PCM16 audio samples. Each two bytes make up one little-endian sample.
[in]	num_bytes	size of the byte array
[in]	sample_rate	sample rate of the passed audio in Hz
[out]	result	liveness check result, pointer to preallocated structure instance. Not changed unless this call returns true.
[out]	error_code	pointer to the error code.
[out]	error_msg	output error message. Points to the null-terminated string containing message in case of failure or to the NULL in case of success. The memory it points to should be freed manually.

Returns: true if call completed successfully, false otherwise

◆ VoiceSdkLivenessEngineCheckLivenessFloatSamples()

VOICE_SDK_API bool VoiceSdkLivenessEngineCheckLivenessFloatSamples	(	const VoiceSdkLivenessEngine *	engine,
		const float *	float_samples,
		size_t	num_samples,
		size_t	sample_rate,
		VoiceSdkLivenessResult *	result,
		VoiceSdkErrorCode *	error_code,
		char **	error_msg
	)

Checks liveness from the given float audio samples.

Parameters

[in]	engine	instance of Liveness Engine created with VoiceSdkLivenessEngineCreate
[in]	float_samples	pointer to array containing normalized (from -1 to 1) float audio samples
[in]	num_samples	size of the floats array
[in]	sample_rate	sample rate of the passed audio in Hz
[out]	result	resulting spoof check, pointer to preallocated structure instance. Not changed unless this call returns true.
[out]	error_code	pointer to the error code.
[out]	error_msg	output error message. Points to the null-terminated string containing message in case of failure or to the NULL in case of success. The memory it points to should be freed manually.

Returns: true if call completed successfully, false otherwise

◆ VoiceSdkLivenessEngineCheckLivenessPcm16Samples()

VOICE_SDK_API bool VoiceSdkLivenessEngineCheckLivenessPcm16Samples	(	const VoiceSdkLivenessEngine *	engine,
		const int16_t *	pcm16_samples,
		size_t	num_samples,
		size_t	sample_rate,
		VoiceSdkLivenessResult *	result,
		VoiceSdkErrorCode *	error_code,
		char **	error_msg
	)

Checks liveness from the given PCM16 audio samples.

Parameters

[in]	engine	instance of Liveness Engine created with VoiceSdkLivenessEngineCreate
[in]	pcm16_samples	pointer to shorts array containing PCM16 audio samples
[in]	num_samples	size of the shorts array
[in]	sample_rate	sample rate of the passed audio in Hz
[out]	result	liveness check result, pointer to preallocated structure instance. Not changed unless this call returns true.
[out]	error_code	pointer to the error code.
[out]	error_msg	output error message. Points to the null-terminated string containing message in case of failure or to the NULL in case of success. The memory it points to should be freed manually.

Returns: true if call completed successfully, false otherwise

◆ VoiceSdkLivenessEngineCreate()

VOICE_SDK_API VoiceSdkLivenessEngine* VoiceSdkLivenessEngineCreate	(	const char *	init_path,
		VoiceSdkErrorCode *	error_code,
		char **	error_msg
	)

Creates VoiceSdkLivenessEngine.

Parameters

[in]	init_path	path to the init data folder
[out]	error_code	pointer to the error code.
[out]	error_msg	output error message. Points to the null-terminated string containing message in case of failure or to the NULL in case of success. The memory it points to should be freed manually.

Returns: VoiceSdkLivenessEngine* or NULL in case of any errors

◆ VoiceSdkLivenessEngineRelease()

VOICE_SDK_API void VoiceSdkLivenessEngineRelease ( VoiceSdkLivenessEngine * engine )

Releases all memory allocated for this VoiceSdkLivenessEngine instance.

Parameters

engine instance of VoiceSdkLivenessEngine that needs freeing

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ VoiceSdkLivenessEngine

◆ VoiceSdkLivenessResult

◆ VoiceSdkLivenessResultValidationStatusCode

Enumeration Type Documentation

◆ VoiceSdkLivenessResultValidationStatusCode

Function Documentation

◆ VoiceSdkLivenessEngineCheckLivenessAudioFile()

◆ VoiceSdkLivenessEngineCheckLivenessBytes()

◆ VoiceSdkLivenessEngineCheckLivenessFloatSamples()

◆ VoiceSdkLivenessEngineCheckLivenessPcm16Samples()

◆ VoiceSdkLivenessEngineCreate()

◆ VoiceSdkLivenessEngineRelease()