GoogleSpeechTranscription_ParamsParser Class Reference

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

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

Inheritance diagram for GoogleSpeechTranscription_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	GoogleSpeechTranscription_ParamsParser ()
	~GoogleSpeechTranscription_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 = {"GoogleSpeechTranscription"}
const std::string	m_device_name = {"googleSpeechTranscription"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_language_code_defaultValue = {""}
const std::string	m_sample_rate_hertz_defaultValue = {"16000"}
std::string	m_language_code = {}
int	m_sample_rate_hertz = {16000}

Detailed Description

This class is the parameters parser for class GoogleSpeechTranscription.

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")	-
-	sample_rate_hertz	int	Hz	16000	0	The input audio sample rate	-

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

yarpdev --device googleSpeechTranscription --language_code <mandatory_value> --sample_rate_hertz 16000

yarpdev --device googleSpeechTranscription --language_code <mandatory_value>

Definition at line 42 of file GoogleSpeechTranscription_ParamsParser.h.

Constructor & Destructor Documentation

GoogleSpeechTranscription_ParamsParser()

GoogleSpeechTranscription_ParamsParser::GoogleSpeechTranscription_ParamsParser

(

)

Definition at line 23 of file GoogleSpeechTranscription_ParamsParser.cpp.

~GoogleSpeechTranscription_ParamsParser()

GoogleSpeechTranscription_ParamsParser::~GoogleSpeechTranscription_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string GoogleSpeechTranscription_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 66 of file GoogleSpeechTranscription_ParamsParser.h.

getDeviceName()

std::string GoogleSpeechTranscription_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 67 of file GoogleSpeechTranscription_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string GoogleSpeechTranscription_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 106 of file GoogleSpeechTranscription_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > GoogleSpeechTranscription_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 GoogleSpeechTranscription_ParamsParser.cpp.

parseParams()

bool GoogleSpeechTranscription_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 37 of file GoogleSpeechTranscription_ParamsParser.cpp.

Member Data Documentation

m_device_classname

const std::string GoogleSpeechTranscription_ParamsParser::m_device_classname = {"GoogleSpeechTranscription"}

Definition at line 49 of file GoogleSpeechTranscription_ParamsParser.h.

m_device_name

const std::string GoogleSpeechTranscription_ParamsParser::m_device_name = {"googleSpeechTranscription"}

Definition at line 50 of file GoogleSpeechTranscription_ParamsParser.h.

m_language_code

std::string GoogleSpeechTranscription_ParamsParser::m_language_code = {}

Definition at line 62 of file GoogleSpeechTranscription_ParamsParser.h.

m_language_code_defaultValue

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

Definition at line 59 of file GoogleSpeechTranscription_ParamsParser.h.

m_parser_is_strict

bool GoogleSpeechTranscription_ParamsParser::m_parser_is_strict = false

Definition at line 51 of file GoogleSpeechTranscription_ParamsParser.h.

m_parser_version

const parser_version_type GoogleSpeechTranscription_ParamsParser::m_parser_version = {}

Definition at line 57 of file GoogleSpeechTranscription_ParamsParser.h.

m_sample_rate_hertz

int GoogleSpeechTranscription_ParamsParser::m_sample_rate_hertz = {16000}

Definition at line 63 of file GoogleSpeechTranscription_ParamsParser.h.

m_sample_rate_hertz_defaultValue

const std::string GoogleSpeechTranscription_ParamsParser::m_sample_rate_hertz_defaultValue = {"16000"}

Definition at line 60 of file GoogleSpeechTranscription_ParamsParser.h.

---

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

• opt-modules/yarp-devices-google-cloud/src/devices/googleSpeechTranscription/GoogleSpeechTranscription_ParamsParser.h
• opt-modules/yarp-devices-google-cloud/src/devices/googleSpeechTranscription/GoogleSpeechTranscription_ParamsParser.cpp