FakeSpeechTranscription Class Reference

FakeSpeechTranscription: A fake implementation of a speech transcriber plugin. More...

#include <fake/fakeSpeechTranscription/FakeSpeechTranscription.h>

Inheritance diagram for FakeSpeechTranscription:

Public Member Functions
	FakeSpeechTranscription ()
virtual	~FakeSpeechTranscription ()
	FakeSpeechTranscription (const FakeSpeechTranscription &)=delete
	FakeSpeechTranscription (FakeSpeechTranscription &&)=delete
FakeSpeechTranscription &	operator= (const FakeSpeechTranscription &)=delete
FakeSpeechTranscription &	operator= (FakeSpeechTranscription &&)=delete
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.
bool	close () override
	Close the DeviceDriver.
virtual yarp::dev::ReturnValue	setLanguage (const std::string &language) override
	Sets the language for speech transcription.
virtual yarp::dev::ReturnValue	getLanguage (std::string &language) override
	Gets the current language set for speech transcription.
virtual yarp::dev::ReturnValue	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
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::ISpeechTranscription
virtual	~ISpeechTranscription ()
Public Member Functions inherited from FakeSpeechTranscription_ParamsParser
	FakeSpeechTranscription_ParamsParser ()
	~FakeSpeechTranscription_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 FakeSpeechTranscription_ParamsParser
const std::string	m_device_classname = {"FakeSpeechTranscription"}
const std::string	m_device_name = {"fakeSpeechTranscription"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
std::string	m_provided_configuration
const std::string	m_language_defaultValue = {"auto"}
std::string	m_language = {"auto"}

Detailed Description

FakeSpeechTranscription: A fake implementation of a speech transcriber plugin.

Parameters required by this device are shown in class: FakeSpeechTranscription_ParamsParser

Definition at line 25 of file FakeSpeechTranscription.h.

Constructor & Destructor Documentation

FakeSpeechTranscription() [1/3]

FakeSpeechTranscription::FakeSpeechTranscription

(

)

Definition at line 22 of file FakeSpeechTranscription.cpp.

~FakeSpeechTranscription()

FakeSpeechTranscription::~FakeSpeechTranscription ( )

virtual

Definition at line 26 of file FakeSpeechTranscription.cpp.

FakeSpeechTranscription() [2/3]

FakeSpeechTranscription::FakeSpeechTranscription ( const FakeSpeechTranscription &  )

delete

FakeSpeechTranscription() [3/3]

FakeSpeechTranscription::FakeSpeechTranscription ( FakeSpeechTranscription &&  )

delete

Member Function Documentation

close()

bool FakeSpeechTranscription::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 38 of file FakeSpeechTranscription.cpp.

getLanguage()

yarp::dev::ReturnValue FakeSpeechTranscription::getLanguage ( std::string &  language )

overridevirtual

Gets the current language set for speech transcription.

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::ISpeechTranscription.

Definition at line 50 of file FakeSpeechTranscription.cpp.

open()

bool FakeSpeechTranscription::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 31 of file FakeSpeechTranscription.cpp.

operator=() [1/2]

FakeSpeechTranscription & FakeSpeechTranscription::operator= ( const FakeSpeechTranscription &  )

delete

operator=() [2/2]

FakeSpeechTranscription & FakeSpeechTranscription::operator= ( FakeSpeechTranscription &&  )

delete

setLanguage()

yarp::dev::ReturnValue FakeSpeechTranscription::setLanguage ( const std::string &  language )

overridevirtual

Sets the language for speech transcription.

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::ISpeechTranscription.

Definition at line 43 of file FakeSpeechTranscription.cpp.

transcribe()

yarp::dev::ReturnValue FakeSpeechTranscription::transcribe ( const yarp::sig::Sound &  sound, std::string &  transcription, double &  score  )

overridevirtual

Performs the speech transcription.

Parameters

sound	the audio data to transcribe
transcription	the returned transcription (it may be empty)
score	the returned score/confidence value in the range (0-1.0). It may be not implemented.

Returns

a ReturnValue, convertible to true/false

Implements yarp::dev::ISpeechTranscription.

Definition at line 56 of file FakeSpeechTranscription.cpp.

---

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

• src/devices/fake/fakeSpeechTranscription/FakeSpeechTranscription.h
• src/devices/fake/fakeSpeechTranscription/FakeSpeechTranscription.cpp