YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
GoogleSpeechSynthesizer_ParamsParser Class Reference

This class is the parameters parser for class GoogleSpeechSynthesizer. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/opt-modules/yarp-devices-google-cloud/src/devices/googleSpeechSynthesizer/GoogleSpeechSynthesizer_ParamsParser.h>

+ Inheritance diagram for GoogleSpeechSynthesizer_ParamsParser:

Classes

struct  parser_version_type
 

Public Member Functions

 GoogleSpeechSynthesizer_ParamsParser ()
 
 ~GoogleSpeechSynthesizer_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.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 
virtual bool getParamValue (const std::string &paramName, std::string &paramValue) const =0
 Return the value (represented as a string) of the requested parameter.
 
virtual std::string getConfiguration () const =0
 Return the configuration of the device.
 

Public Attributes

const std::string m_device_classname = {"GoogleSpeechSynthesizer"}
 
const std::string m_device_name = {"googleSpeechSynthesizer"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_language_code_defaultValue = {""}
 
const std::string m_voice_name_defaultValue = {""}
 
const std::string m_voice_speed_defaultValue = {"1"}
 
const std::string m_voice_pitch_defaultValue = {"0"}
 
std::string m_language_code = {}
 
std::string m_voice_name = {}
 
double m_voice_speed = {1}
 
double m_voice_pitch = {0}
 

Detailed Description

This class is the parameters parser for class GoogleSpeechSynthesizer.

These are the used parameters:

Group name Parameter name Type Units Default Value Required Description Notes
- language_code string - - 1 Language for speech synthesis (e.g. "ita", "eng") -
- voice_name string - - 0 The voice set for speech synthesis. If not set, the device will pick the first available voice for the selected language code (This page holds the complete list of the available voices: https://cloud.google.com/text-to-speech/docs/voices) -
- voice_speed double - 1 0 Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. -
- voice_pitch double - 0 0 Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. -

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device googleSpeechSynthesizer --language_code <mandatory_value> --voice_name <optional_value> --voice_speed 1 --voice_pitch 0
yarpdev --device googleSpeechSynthesizer --language_code <mandatory_value>

Definition at line 44 of file GoogleSpeechSynthesizer_ParamsParser.h.

Constructor & Destructor Documentation

◆ GoogleSpeechSynthesizer_ParamsParser()

GoogleSpeechSynthesizer_ParamsParser::GoogleSpeechSynthesizer_ParamsParser ( )

Definition at line 23 of file GoogleSpeechSynthesizer_ParamsParser.cpp.

◆ ~GoogleSpeechSynthesizer_ParamsParser()

GoogleSpeechSynthesizer_ParamsParser::~GoogleSpeechSynthesizer_ParamsParser ( )
overridedefault

Member Function Documentation

◆ getDeviceClassName()

std::string GoogleSpeechSynthesizer_ParamsParser::getDeviceClassName ( ) const
inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns
A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 72 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ getDeviceName()

std::string GoogleSpeechSynthesizer_ParamsParser::getDeviceName ( ) const
inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns
A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 73 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ getDocumentationOfDeviceParams()

std::string GoogleSpeechSynthesizer_ParamsParser::getDocumentationOfDeviceParams ( ) const
overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns
A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 136 of file GoogleSpeechSynthesizer_ParamsParser.cpp.

◆ getListOfParams()

std::vector< std::string > GoogleSpeechSynthesizer_ParamsParser::getListOfParams ( ) const
overridevirtual

Return a list of all params used by the device.

Returns
A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 28 of file GoogleSpeechSynthesizer_ParamsParser.cpp.

◆ parseParams()

bool GoogleSpeechSynthesizer_ParamsParser::parseParams ( const yarp::os::Searchable &  config)
overridevirtual

Parse the DeviceDriver parameters.

Returns
true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 39 of file GoogleSpeechSynthesizer_ParamsParser.cpp.

Member Data Documentation

◆ m_device_classname

const std::string GoogleSpeechSynthesizer_ParamsParser::m_device_classname = {"GoogleSpeechSynthesizer"}

Definition at line 51 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_device_name

const std::string GoogleSpeechSynthesizer_ParamsParser::m_device_name = {"googleSpeechSynthesizer"}

Definition at line 52 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_language_code

std::string GoogleSpeechSynthesizer_ParamsParser::m_language_code = {}

Definition at line 66 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_language_code_defaultValue

const std::string GoogleSpeechSynthesizer_ParamsParser::m_language_code_defaultValue = {""}

Definition at line 61 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_parser_is_strict

bool GoogleSpeechSynthesizer_ParamsParser::m_parser_is_strict = false

Definition at line 53 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_parser_version

const parser_version_type GoogleSpeechSynthesizer_ParamsParser::m_parser_version = {}

Definition at line 59 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_name

std::string GoogleSpeechSynthesizer_ParamsParser::m_voice_name = {}

Definition at line 67 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_name_defaultValue

const std::string GoogleSpeechSynthesizer_ParamsParser::m_voice_name_defaultValue = {""}

Definition at line 62 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_pitch

double GoogleSpeechSynthesizer_ParamsParser::m_voice_pitch = {0}

Definition at line 69 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_pitch_defaultValue

const std::string GoogleSpeechSynthesizer_ParamsParser::m_voice_pitch_defaultValue = {"0"}

Definition at line 64 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_speed

double GoogleSpeechSynthesizer_ParamsParser::m_voice_speed = {1}

Definition at line 68 of file GoogleSpeechSynthesizer_ParamsParser.h.

◆ m_voice_speed_defaultValue

const std::string GoogleSpeechSynthesizer_ParamsParser::m_voice_speed_defaultValue = {"1"}

Definition at line 63 of file GoogleSpeechSynthesizer_ParamsParser.h.

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