YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
GoogleSpeechTranscription Class Reference

googleSpeechTranscription: A yarp device for speech transcription using google cloud cpp libraries More...

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

+ Inheritance diagram for GoogleSpeechTranscription:

Public Member Functions

 GoogleSpeechTranscription ()
 
 GoogleSpeechTranscription (const GoogleSpeechTranscription &)=delete
 
 GoogleSpeechTranscription (GoogleSpeechTranscription &&) noexcept=delete
 
GoogleSpeechTranscriptionoperator= (const GoogleSpeechTranscription &)=delete
 
GoogleSpeechTranscriptionoperator= (GoogleSpeechTranscription &&) noexcept=delete
 
 ~GoogleSpeechTranscription () override=default
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool setLanguage (const std::string &language="auto") override
 Sets the language for speech transcription.
 
bool getLanguage (std::string &language) override
 Gets the current language set for speech transcription.
 
bool transcribe (const yarp::sig::Sound &sound, std::string &transcription, double &score) override
 Performs the speech transcription.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (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 DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from GoogleSpeechTranscription_ParamsParser
 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 ()
 
- Public Member Functions inherited from yarp::dev::ISpeechTranscription
virtual ~ISpeechTranscription ()
 

Additional Inherited Members

- Public Attributes inherited from GoogleSpeechTranscription_ParamsParser
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

googleSpeechTranscription: A yarp device for speech transcription using google cloud cpp libraries

googleSpeechTranscription

Parameters required by this device are described in class GoogleSpeechTranscription_ParamsParser

Definition at line 34 of file GoogleSpeechTranscription.h.

Constructor & Destructor Documentation

◆ GoogleSpeechTranscription() [1/3]

GoogleSpeechTranscription::GoogleSpeechTranscription ( )

Definition at line 27 of file GoogleSpeechTranscription.cpp.

◆ GoogleSpeechTranscription() [2/3]

GoogleSpeechTranscription::GoogleSpeechTranscription ( const GoogleSpeechTranscription )
delete

◆ GoogleSpeechTranscription() [3/3]

GoogleSpeechTranscription::GoogleSpeechTranscription ( GoogleSpeechTranscription &&  )
deletenoexcept

◆ ~GoogleSpeechTranscription()

GoogleSpeechTranscription::~GoogleSpeechTranscription ( )
overridedefault

Member Function Documentation

◆ close()

bool GoogleSpeechTranscription::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 51 of file GoogleSpeechTranscription.cpp.

◆ getLanguage()

bool GoogleSpeechTranscription::getLanguage ( std::string &  language)
overridevirtual

Gets the current language set for speech transcription.

Parameters
languagethe returned string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".
Returns
true on success

Implements yarp::dev::ISpeechTranscription.

Definition at line 69 of file GoogleSpeechTranscription.cpp.

◆ open()

bool GoogleSpeechTranscription::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis 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 32 of file GoogleSpeechTranscription.cpp.

◆ operator=() [1/2]

GoogleSpeechTranscription & GoogleSpeechTranscription::operator= ( const GoogleSpeechTranscription )
delete

◆ operator=() [2/2]

GoogleSpeechTranscription & GoogleSpeechTranscription::operator= ( GoogleSpeechTranscription &&  )
deletenoexcept

◆ setLanguage()

bool GoogleSpeechTranscription::setLanguage ( const std::string &  language = "auto")
overridevirtual

Sets the language for speech transcription.

Parameters
languagea string (code) representing the speech language (e.g. ita, eng...). Default value is "auto".
Returns
true on success

Implements yarp::dev::ISpeechTranscription.

Definition at line 56 of file GoogleSpeechTranscription.cpp.

◆ transcribe()

bool GoogleSpeechTranscription::transcribe ( const yarp::sig::Sound sound,
std::string &  transcription,
double score 
)
overridevirtual

Performs the speech transcription.

Parameters
soundthe audio data to transcribe
transcriptionthe returned transcription (it may be empty)
scorethe returned score/confidence value in the range (0-1.0). It may be not implemented.
Returns
true on success

Implements yarp::dev::ISpeechTranscription.

Definition at line 76 of file GoogleSpeechTranscription.cpp.


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