class Speaker::VoiceProfileClient

  • Article 
class Speaker::VoiceProfileClient
  : public std::enable_shared_from_this< VoiceProfileClient >

Class for VoiceProfileClient. This class creates voice profile client for creating, doing enrollment, deleting and reseting a voice profile. Added in version 1.12.0.

Members

Properties

Syntax: public PropertyCollection & Properties;

A collection of properties and their values defined for this VoiceProfileClient.

~VoiceProfileClient

Syntax: public inline virtual ~VoiceProfileClient ( );

Destructor.

CreateProfileAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfile > > CreateProfileAsync ( VoiceProfileType profileType , const std::string & locale );

Create a Voice Profile.

Parameters

  • profileType a VoiceProfile type.

  • locale a locale, e.g "en-us"

Returns

A smart pointer wrapped voice profile client object.

EnrollProfileAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfileEnrollmentResult > > EnrollProfileAsync ( std::shared_ptr< VoiceProfile > profile , std::shared_ptr< Audio::AudioConfig > audioInput );

Enroll a Voice Profile.

Parameters

  • profile a voice profile object.

  • audioInput an audio Input.

Returns

A smart pointer wrapped voice profile enrollment result object.

DeleteProfileAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfileResult > > DeleteProfileAsync ( std::shared_ptr< VoiceProfile > profile );

Delete a Voice Profile.

Parameters

  • profile a voice profile object.

Returns

A smart pointer wrapped voice profile result object.

ResetProfileAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfileResult > > ResetProfileAsync ( std::shared_ptr< VoiceProfile > profile );

Reset a Voice Profile.

Parameters

  • profile a voice profile object.

Returns

A smart pointer wrapped voice profile result object.

RetrieveEnrollmentResultAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfileEnrollmentResult > > RetrieveEnrollmentResultAsync ( const std::string & voiceProfileId , VoiceProfileType voiceProfileType );

Retrieve an enrollment result given the id and type of the Voice Profile.

Parameters

  • voiceProfileId The VoiceProfile Id.

  • voiceProfileType The VoiceProfileType.

Returns

A future of the retrieved VoiceProfileEnrollmentResult.

RetrieveEnrollmentResultAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfileEnrollmentResult > > RetrieveEnrollmentResultAsync ( constVoiceProfile & voiceProfile );

Retrieve an enrollment result given the Voice Profile.

Parameters

  • voiceProfile a voice profile object.

Returns

GetAllProfilesAsync

Syntax: public inline std::future< std::vector< std::shared_ptr< VoiceProfile > > > GetAllProfilesAsync ( VoiceProfileType voiceProfileType );

Get all profiles having the given type.

Parameters

  • voiceProfileType The VoiceProfileType.

Returns

A future of a vector of extant VoiceProfiles.

GetActivationPhrasesAsync

Syntax: public inline std::future< std::shared_ptr< VoiceProfilePhraseResult > > GetActivationPhrasesAsync ( VoiceProfileType voiceProfileType , const std::string & locale );

operator SPXVOICEPROFILECLIENTHANDLE

Syntax: public inline explicit operator SPXVOICEPROFILECLIENTHANDLE ( );

Internal. Explicit conversion operator.

Returns

A handle.

FromConfig

Syntax: public inline static std::shared_ptr< VoiceProfileClient > FromConfig ( std::shared_ptr< SpeechConfig > speechConfig );

Create a Voice Profile Client from a speech config.

Parameters

  • speechConfig Speech configuration.

Returns

A smart pointer wrapped voice profile client pointer.