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

speechTranscription_nwc_yarp: A network wrapper client that connects to a speechTranscription_nws_yarp to perform speech transcription. More...

#include <networkWrappers/speechTranscription_nwc_yarp/SpeechTranscription_nwc_yarp.h>

+ Inheritance diagram for SpeechTranscription_nwc_yarp:

Public Member Functions

 SpeechTranscription_nwc_yarp ()=default
 
 SpeechTranscription_nwc_yarp (const SpeechTranscription_nwc_yarp &)=delete
 
 SpeechTranscription_nwc_yarp (SpeechTranscription_nwc_yarp &&)=delete
 
SpeechTranscription_nwc_yarpoperator= (const SpeechTranscription_nwc_yarp &)=delete
 
SpeechTranscription_nwc_yarpoperator= (SpeechTranscription_nwc_yarp &&)=delete
 
virtual ~SpeechTranscription_nwc_yarp () override
 
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 yarp::dev::ISpeechTranscription
virtual ~ISpeechTranscription ()
 
- Public Member Functions inherited from SpeechTranscription_nwc_yarp_ParamsParser
 SpeechTranscription_nwc_yarp_ParamsParser ()
 
 ~SpeechTranscription_nwc_yarp_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 ()
 

Protected Attributes

yarp::os::Port m_thriftClientPort
 

Additional Inherited Members

- Public Attributes inherited from SpeechTranscription_nwc_yarp_ParamsParser
const std::string m_device_classname = {"SpeechTranscription_nwc_yarp"}
 
const std::string m_device_name = {"speechTranscription_nwc_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_local_defaultValue = {""}
 
const std::string m_remote_defaultValue = {""}
 
std::string m_local = {}
 
std::string m_remote = {}
 

Detailed Description

speechTranscription_nwc_yarp: A network wrapper client that connects to a speechTranscription_nws_yarp to perform speech transcription.

speechTranscription_nwc_yarp

Parameters required by this device are shown in class: SpeechTranscription_nwc_yarp_ParamsParser

Definition at line 36 of file SpeechTranscription_nwc_yarp.h.

Constructor & Destructor Documentation

◆ SpeechTranscription_nwc_yarp() [1/3]

SpeechTranscription_nwc_yarp::SpeechTranscription_nwc_yarp ( )
default

◆ SpeechTranscription_nwc_yarp() [2/3]

SpeechTranscription_nwc_yarp::SpeechTranscription_nwc_yarp ( const SpeechTranscription_nwc_yarp )
delete

◆ SpeechTranscription_nwc_yarp() [3/3]

SpeechTranscription_nwc_yarp::SpeechTranscription_nwc_yarp ( SpeechTranscription_nwc_yarp &&  )
delete

◆ ~SpeechTranscription_nwc_yarp()

SpeechTranscription_nwc_yarp::~SpeechTranscription_nwc_yarp ( )
overridevirtual

Definition at line 16 of file SpeechTranscription_nwc_yarp.cpp.

Member Function Documentation

◆ close()

bool SpeechTranscription_nwc_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 21 of file SpeechTranscription_nwc_yarp.cpp.

◆ getLanguage()

bool SpeechTranscription_nwc_yarp::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 76 of file SpeechTranscription_nwc_yarp.cpp.

◆ open()

bool SpeechTranscription_nwc_yarp::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 26 of file SpeechTranscription_nwc_yarp.cpp.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

SpeechTranscription_nwc_yarp & SpeechTranscription_nwc_yarp::operator= ( SpeechTranscription_nwc_yarp &&  )
delete

◆ setLanguage()

bool SpeechTranscription_nwc_yarp::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 65 of file SpeechTranscription_nwc_yarp.cpp.

◆ transcribe()

bool SpeechTranscription_nwc_yarp::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 90 of file SpeechTranscription_nwc_yarp.cpp.

Member Data Documentation

◆ m_thriftClientPort

yarp::os::Port SpeechTranscription_nwc_yarp::m_thriftClientPort
protected

Definition at line 67 of file SpeechTranscription_nwc_yarp.h.


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