Class for creating and merging voice templates. More...

#include <voicesdk/verify/verify.h>

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

Public Member Functions
virtual VoiceTemplate::Ptr	createVoiceTemplate (const std::string &audioPath, const ChannelType &channelType=ChannelType::MIC) const =0
	Creates a voice template from the given audio file. More...

virtual VoiceTemplate::Ptr	createVoiceTemplate (const float *floatSamples, size_t numSamples, size_t sampleRate, const ChannelType &channelType=ChannelType::MIC) const =0
	Creates a voice template from the given float audio samples. More...

virtual VoiceTemplate::Ptr	createVoiceTemplate (const int16_t *pcm16Samples, size_t numSamples, size_t sampleRate, const ChannelType &channelType=ChannelType::MIC) const =0
	Creates a voice template from the given PCM16 audio samples. More...

virtual VoiceTemplate::Ptr	createVoiceTemplate (const uint8_t *pcm16Bytes, size_t numBytes, size_t sampleRate, const ChannelType &channelType=ChannelType::MIC) const =0
	Creates a voice template from the given byte representation of PCM16 audio samples. More...

virtual std::vector< VoiceTemplate::Ptr >	createVoiceTemplateBatch (const std::vector< VerifyFileBatchElement > &input_batch) const =0
	Creates a voice template from the given batch of WAV files. More...

virtual std::vector< VoiceTemplate::Ptr >	createVoiceTemplateBatch (const std::vector< VerifySamplesBatchElement< float >> &input_batch) const =0
	Creates a voice template from the given batch of float audio samples. More...

virtual std::vector< VoiceTemplate::Ptr >	createVoiceTemplateBatch (const std::vector< VerifySamplesBatchElement< int16_t >> &input_batch) const =0
	Creates a voice template from the given batch of PCM16 audio samples. More...

virtual std::vector< VoiceTemplate::Ptr >	createVoiceTemplateBatch (const std::vector< VerifySamplesBatchElement< uint8_t >> &input_batch) const =0
	Creates a voice template from the given batch of byte representation PCM16 audio samples. More...

virtual VoiceTemplate::Ptr	mergeVoiceTemplates (const std::vector< VoiceTemplate::Ptr > &voiceTemplates) const =0
	Merges multiple voice templates of a single speaker to a union voice template. More...

virtual const std::string &	getInitDataId () const =0
	Returns ID of the init data, which was used to create the factory. More...

virtual const size_t &	getMinimumAudioSampleRate () const =0
	Returns minimum supported input audio sampling frequency in Hz. More...

virtual	~VoiceTemplateFactory ()=default

Static Public Member Functions
static Ptr	create (const std::string &initPath)
	Factory method. More...

Detailed Description

Class for creating and merging voice templates.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ ~VoiceTemplateFactory()

virtual voicesdk::VoiceTemplateFactory::~VoiceTemplateFactory ( )

virtualdefault

Member Function Documentation

◆ create()

static Ptr voicesdk::VoiceTemplateFactory::create ( const std::string & initPath )

static

Factory method.

Parameters

initPath Path to the init data folder

Returns: Created VoiceTemplateFactory instance

Exceptions

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

◆ createVoiceTemplate() [1/4]

virtual VoiceTemplate::Ptr voicesdk::VoiceTemplateFactory::createVoiceTemplate	(	const float *	floatSamples,
		size_t	numSamples,
		size_t	sampleRate,
		const ChannelType &	channelType = `ChannelType::MIC`
	)		const

pure virtual

Creates a voice template from the given float audio samples.

Parameters

floatSamples	A buffer containing normalized (from -1 to 1) float audio samples
numSamples	Number of audio samples
sampleRate	Audio sampling rate in Hz
channelType	Audio record channel type

Returns: Created voice template

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

◆ createVoiceTemplate() [2/4]

virtual VoiceTemplate::Ptr voicesdk::VoiceTemplateFactory::createVoiceTemplate	(	const int16_t *	pcm16Samples,
		size_t	numSamples,
		size_t	sampleRate,
		const ChannelType &	channelType = `ChannelType::MIC`
	)		const

pure virtual

Creates a voice template from the given PCM16 audio samples.

Parameters

pcm16Samples	A buffer containing PCM16 audio samples
numSamples	Number of audio samples
sampleRate	Audio sampling rate in Hz
channelType	Audio record channel type

Returns: Created voice template

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

◆ createVoiceTemplate() [3/4]

virtual VoiceTemplate::Ptr voicesdk::VoiceTemplateFactory::createVoiceTemplate	(	const std::string &	audioPath,
		const ChannelType &	channelType = `ChannelType::MIC`
	)		const

pure virtual

Creates a voice template from the given audio file.

Parameters

audioPath	Path to audio file
channelType	Audio record channel type

Returns: Created voice template

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

◆ createVoiceTemplate() [4/4]

virtual VoiceTemplate::Ptr voicesdk::VoiceTemplateFactory::createVoiceTemplate	(	const uint8_t *	pcm16Bytes,
		size_t	numBytes,
		size_t	sampleRate,
		const ChannelType &	channelType = `ChannelType::MIC`
	)		const

pure virtual

Creates a voice template from the given byte representation of PCM16 audio samples.

Parameters

pcm16Bytes	A buffer containing byte representation of PCM16 audio samples
numBytes	Number of bytes
sampleRate	Audio sampling rate in Hz
channelType	Audio record channel type

Returns: Created voice template

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

◆ createVoiceTemplateBatch() [1/4]

virtual std::vector<VoiceTemplate::Ptr> voicesdk::VoiceTemplateFactory::createVoiceTemplateBatch ( const std::vector< VerifyFileBatchElement > & input_batch ) const

pure virtual

Creates a voice template from the given batch of WAV files.

Parameters

input_batch A vector of VerifyFileBatchElement

Returns: Created voice templates vector

Exceptions

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

◆ createVoiceTemplateBatch() [2/4]

virtual std::vector<VoiceTemplate::Ptr> voicesdk::VoiceTemplateFactory::createVoiceTemplateBatch ( const std::vector< VerifySamplesBatchElement< float >> & input_batch ) const

pure virtual

Creates a voice template from the given batch of float audio samples.

Parameters

input_batch A vector of VerifySamplesBatchElement<float>

Returns: Created voice templates vector

Exceptions

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

Note: float audio samples should be normalized (from -1 to 1)

◆ createVoiceTemplateBatch() [3/4]

virtual std::vector<VoiceTemplate::Ptr> voicesdk::VoiceTemplateFactory::createVoiceTemplateBatch ( const std::vector< VerifySamplesBatchElement< int16_t >> & input_batch ) const

pure virtual

Creates a voice template from the given batch of PCM16 audio samples.

Parameters

input_batch A vector of VerifySamplesBatchElement<int16_t>

Returns: Created voice templates vector

Exceptions

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

◆ createVoiceTemplateBatch() [4/4]

virtual std::vector<VoiceTemplate::Ptr> voicesdk::VoiceTemplateFactory::createVoiceTemplateBatch ( const std::vector< VerifySamplesBatchElement< uint8_t >> & input_batch ) const

pure virtual

Creates a voice template from the given batch of byte representation PCM16 audio samples.

Parameters

input_batch A vector of VerifySamplesBatchElement<uint8_t>

Returns: Created voice templates vector

Exceptions

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

◆ getInitDataId()

virtual const std::string& voicesdk::VoiceTemplateFactory::getInitDataId ( ) const

pure virtual

Returns ID of the init data, which was used to create the factory.

Returns: A string containing init data ID

◆ getMinimumAudioSampleRate()

virtual const size_t& voicesdk::VoiceTemplateFactory::getMinimumAudioSampleRate ( ) const

pure virtual

Returns minimum supported input audio sampling frequency in Hz.

Returns: A minimum sampling rate in Hz

◆ mergeVoiceTemplates()

virtual VoiceTemplate::Ptr voicesdk::VoiceTemplateFactory::mergeVoiceTemplates ( const std::vector< VoiceTemplate::Ptr > & voiceTemplates ) const

pure virtual

Merges multiple voice templates of a single speaker to a union voice template.

Parameters

voiceTemplates vector of speaker's voice templates

Returns: A union voice template

Exceptions

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

Note: All the templates should have the same init data ID as the factory instance

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~VoiceTemplateFactory()

Member Function Documentation

◆ create()

◆ createVoiceTemplate() [1/4]

◆ createVoiceTemplate() [2/4]

◆ createVoiceTemplate() [3/4]

◆ createVoiceTemplate() [4/4]

◆ createVoiceTemplateBatch() [1/4]

◆ createVoiceTemplateBatch() [2/4]

◆ createVoiceTemplateBatch() [3/4]

◆ createVoiceTemplateBatch() [4/4]

◆ getInitDataId()

◆ getMinimumAudioSampleRate()

◆ mergeVoiceTemplates()