voicesdk::LivenessResult Struct Reference

Voice liveness check result. More...

#include <voicesdk/liveness/liveness.h>

Classes
struct	Value
	Result value of successful liveness check. More...

Public Types
enum	ValidationStatusCode { ValidationStatusCode::kOk, ValidationStatusCode::kTooSmallSpeechLength }
	Status code of validation preceding liveness check. More...

Public Member Functions
	LivenessResult ()=default
	LivenessResult (const Value &value)
	LivenessResult (ValidationStatusCode status_code)
bool	Ok () const noexcept
	Returns flag indicating whether validation was successful and liveness result value is available. More...
const Value &	GetValue () const
	Gets liveness check result value. Available only if validation preceding liveness check was successful,. More...
const ValidationStatusCode &	GetStatusCode () const noexcept

Friends
std::ostream &	operator<< (std::ostream &os, const LivenessResult &result)

Detailed Description

Voice liveness check result.

Member Enumeration Documentation

ValidationStatusCode

enum voicesdk::LivenessResult::ValidationStatusCode

strong

Status code of validation preceding liveness check.

Enumerator
kOk	Successful validation
kTooSmallSpeechLength	Speech length is too small for liveness check to be performed

Constructor & Destructor Documentation

LivenessResult() [1/3]

voicesdk::LivenessResult::LivenessResult ( )

default

LivenessResult() [2/3]

voicesdk::LivenessResult::LivenessResult ( const Value &  value )

inlineexplicit

LivenessResult() [3/3]

voicesdk::LivenessResult::LivenessResult ( ValidationStatusCode  status_code )

inlineexplicit

Member Function Documentation

GetStatusCode()

const ValidationStatusCode& voicesdk::LivenessResult::GetStatusCode ( ) const

inlinenoexcept

Gets validation status code.

Returns

Validation status code

GetValue()

const Value& voicesdk::LivenessResult::GetValue ( ) const

inline

Gets liveness check result value. Available only if validation preceding liveness check was successful,.

See also

Ok.

Returns

Liveness check result value

Exceptions

std::runtime_error

if instance does not contain result value

Ok()

bool voicesdk::LivenessResult::Ok ( ) const

inlinenoexcept

Returns flag indicating whether validation was successful and liveness result value is available.

Returns

true if validation was successful and value is available, otherwise false

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const LivenessResult &  result  )

friend