#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-azure-openai/src/devices/ttsDevice/TtsDevice.h>

Inheritance diagram for TtsDevice:

Public Member Functions
	TtsDevice ()

	TtsDevice (const TtsDevice &)=delete

	TtsDevice (TtsDevice &&) noexcept=delete

TtsDevice &	operator= (const TtsDevice &)=delete

TtsDevice &	operator= (TtsDevice &&) noexcept=delete

	~TtsDevice () override=default

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

yarp::dev::ReturnValue	setLanguage (const std::string &language="auto") override
	Sets the language for speech synthesis.

yarp::dev::ReturnValue	getLanguage (std::string &language) override
	Gets the current language set for speech synthesis.

yarp::dev::ReturnValue	setVoice (const std::string &voice_name="auto") override
	Sets the voice set for speech synthesis.

yarp::dev::ReturnValue	getVoice (std::string &voice_name) override
	Gets the current voice set for speech synthesis.

yarp::dev::ReturnValue	setSpeed (const double speed=0) override
	Sets the voice speed for speech synthesis.

yarp::dev::ReturnValue	getSpeed (double &speed) override
	Gets the current voice speed.

yarp::dev::ReturnValue	setPitch (const double pitch) override
	Sets the pitch for speech synthesis.

yarp::dev::ReturnValue	getPitch (double &pitch) override
	Gets the current pitch set for speech synthesis.

yarp::dev::ReturnValue	synthesize (const std::string &text, yarp::sig::Sound &sound) override
	Performs the speech synthesis.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from yarp::dev::ISpeechSynthesizer
virtual	~ISpeechSynthesizer ()

Public Member Functions inherited from TtsDevice_ParamsParser
	TtsDevice_ParamsParser ()

	~TtsDevice_ParamsParser () override=default

bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.

std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.

std::string	getDeviceName () const override
	Get the name of the device (i.e.

std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.

std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.

bool	getParamValue (const std::string &paramName, std::string &paramValue) const override
	Return the value (represented as a string) of the requested parameter.

std::string	getConfiguration () const override
	Return the configuration of the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Additional Inherited Members
Public Attributes inherited from TtsDevice_ParamsParser
const std::string	m_device_classname = {"TtsDevice"}

const std::string	m_device_name = {"ttsDevice"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

std::string	m_provided_configuration

const std::string	m_ENVS_end_point_name_defaultValue = {"AZURE_ENDPOINT"}

const std::string	m_ENVS_deployment_id_name_defaultValue = {"DEPLOYMENT_TTS_ID"}

const std::string	m_ENVS_api_key_name_defaultValue = {"AZURE_API_KEY"}

const std::string	m_ENVS_api_version_name_defaultValue = {"AZURE_API_VERSION_TTS"}

std::string	m_ENVS_end_point_name = {"AZURE_ENDPOINT"}

std::string	m_ENVS_deployment_id_name = {"DEPLOYMENT_TTS_ID"}

std::string	m_ENVS_api_key_name = {"AZURE_API_KEY"}

std::string	m_ENVS_api_version_name = {"AZURE_API_VERSION_TTS"}

Detailed Description

Definition at line 39 of file TtsDevice.h.

Constructor & Destructor Documentation

◆ TtsDevice() [1/3]

TtsDevice::TtsDevice ( )

Definition at line 28 of file TtsDevice.cpp.

◆ TtsDevice() [2/3]

TtsDevice::TtsDevice ( const TtsDevice & )

delete

◆ TtsDevice() [3/3]

TtsDevice::TtsDevice ( TtsDevice && )

deletenoexcept

◆ ~TtsDevice()

TtsDevice::~TtsDevice ( )

overridedefault

Member Function Documentation

◆ close()

bool TtsDevice::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 66 of file TtsDevice.cpp.

◆ getLanguage()

ReturnValue TtsDevice::getLanguage ( std::string & language )

overridevirtual

Gets the current language set for speech synthesis.

Parameters

language the returned string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 78 of file TtsDevice.cpp.

◆ getPitch()

ReturnValue TtsDevice::getPitch ( double & voice )

overridevirtual

Gets the current pitch set for speech synthesis.

Parameters

pitch the current voice pitch.

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 124 of file TtsDevice.cpp.

◆ getSpeed()

ReturnValue TtsDevice::getSpeed ( double & speed )

overridevirtual

Gets the current voice speed.

Parameters

speed the current voice speed.

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 112 of file TtsDevice.cpp.

◆ getVoice()

ReturnValue TtsDevice::getVoice ( std::string & voice_name )

overridevirtual

Gets the current voice set for speech synthesis.

Parameters

voice_name the currently used voice (device dependent).

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 100 of file TtsDevice.cpp.

◆ open()

bool TtsDevice::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 33 of file TtsDevice.cpp.

◆ operator=() [1/2]

TtsDevice & TtsDevice::operator= ( const TtsDevice & )

delete

◆ operator=() [2/2]

TtsDevice & TtsDevice::operator= ( TtsDevice && )

deletenoexcept

◆ setLanguage()

ReturnValue TtsDevice::setLanguage ( const std::string & language = "auto" )

overridevirtual

Sets the language for speech synthesis.

Parameters

language a string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 72 of file TtsDevice.cpp.

◆ setPitch()

ReturnValue TtsDevice::setPitch ( const double pitch )

overridevirtual

Sets the pitch for speech synthesis.

Parameters

pitch the voice pitch.

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 118 of file TtsDevice.cpp.

◆ setSpeed()

ReturnValue TtsDevice::setSpeed ( const double speed = 0 )

overridevirtual

Sets the voice speed for speech synthesis.

Parameters

speed the voice speed.

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 106 of file TtsDevice.cpp.

◆ setVoice()

ReturnValue TtsDevice::setVoice ( const std::string & voice_name = "auto" )

overridevirtual

Sets the voice set for speech synthesis.

Parameters

voice_name the name of of the voice (device dependent).

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 84 of file TtsDevice.cpp.

◆ synthesize()

ReturnValue TtsDevice::synthesize	(	const std::string &	text,
		yarp::sig::Sound &	sound
	)

overridevirtual

Performs the speech synthesis.

Parameters

text	the text to synthesize
sound	the synthesized audio stream

Returns: a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechSynthesizer.

Definition at line 130 of file TtsDevice.cpp.

The documentation for this class was generated from the following files:

opt-modules/yarp-devices-azure-openai/src/devices/ttsDevice/TtsDevice.h
opt-modules/yarp-devices-azure-openai/src/devices/ttsDevice/TtsDevice.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TtsDevice() [1/3]

◆ TtsDevice() [2/3]

◆ TtsDevice() [3/3]

◆ ~TtsDevice()

Member Function Documentation

◆ close()

◆ getLanguage()

◆ getPitch()

◆ getSpeed()

◆ getVoice()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setLanguage()

◆ setPitch()

◆ setSpeed()

◆ setVoice()

◆ synthesize()