voicesdk::VoiceVerifyStreamOpus Class Reference

Class for continuous voice verification using Opus audio stream. More...

#include <voicesdk/verify/verify_stream.h>

Public Types
using	Ptr = std::shared_ptr< VoiceVerifyStreamOpus >

Public Member Functions
virtual void	reset ()=0
	Resets stream state. More...
virtual void	addPacket (const uint8_t *bytes, size_t bytesNum)=0
	Adds Opus packet to process. More...
virtual void	finalize ()=0
	Finalizes input audio stream to process remaining audio samples and produce result if it's possible. More...
virtual bool	hasVerifyResults () const =0
	Checks if there are available verification results in output queue. More...
virtual VerifyStreamResult	getVerifyResult ()=0
	Retrieves verification result from output queue. Use hasVerifyResult() to know if there are available results. More...
virtual	~VoiceVerifyStreamOpus ()=default

Static Public Member Functions
static Ptr	create (VoiceTemplateFactory::Ptr voiceTemplateFactory, VoiceTemplateMatcher::Ptr voiceTemplateMatcher, VoiceTemplate::Ptr voiceTemplate, size_t sampleRate, size_t audioContextLengthSeconds=10)
	Factory method. More...

Detailed Description

Class for continuous voice verification using Opus audio stream.

Member Typedef Documentation

Ptr

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

Constructor & Destructor Documentation

~VoiceVerifyStreamOpus()

virtual voicesdk::VoiceVerifyStreamOpus::~VoiceVerifyStreamOpus ( )

virtualdefault

Member Function Documentation

addPacket()

virtual void voicesdk::VoiceVerifyStreamOpus::addPacket ( const uint8_t *  bytes, size_t  bytesNum  )

pure virtual

Adds Opus packet to process.

Parameters

bytes	A buffer containing single Opus packet. It is expected that packet contains data for single mono stream
bytesNum	Number of bytes

Exceptions

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

Note

if exception was thrown, then stream state is being reset except the accumulated results buffer

create()

static Ptr voicesdk::VoiceVerifyStreamOpus::create ( VoiceTemplateFactory::Ptr  voiceTemplateFactory, VoiceTemplateMatcher::Ptr  voiceTemplateMatcher, VoiceTemplate::Ptr  voiceTemplate, size_t  sampleRate, size_t  audioContextLengthSeconds = 10  )

static

Factory method.

Parameters

voiceTemplateFactory	Voice template factory instance
voiceTemplateMatcher	Voice template matcher instance
voiceTemplate	Reference voice template to match with
sampleRate	Input audio stream sampling frequency in Hz. Must be one of 8000, 12000, 16000, 24000 or 48000.
audioContextLengthSeconds	Length of audio context for voice verification in seconds, must be at least 3 seconds

Returns

Created VoiceVerifyStream instance

Exceptions

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

Note

Sampling frequency should be equal to or greater than the value returned by VoiceTemplateFactory::getMinimumAudioSampleRate

Voice template matcher, voice template factory and voice template should have the same init data ID

finalize()

virtual void voicesdk::VoiceVerifyStreamOpus::finalize ( )

pure virtual

Finalizes input audio stream to process remaining audio samples and produce result if it's possible.

getVerifyResult()

virtual VerifyStreamResult voicesdk::VoiceVerifyStreamOpus::getVerifyResult ( )

pure virtual

Retrieves verification result from output queue. Use hasVerifyResult() to know if there are available results.

Returns

VerifyStreamResult one verification result

Exceptions

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

hasVerifyResults()

virtual bool voicesdk::VoiceVerifyStreamOpus::hasVerifyResults ( ) const

pure virtual

Checks if there are available verification results in output queue.

Returns

true is there are results available, else otherwise.

reset()

virtual void voicesdk::VoiceVerifyStreamOpus::reset ( )

pure virtual

Resets stream state.