YARP
Yet Another Robot Platform

fakeSpeaker : fake device implementing the IAudioRender device interface to play sound More...

#include <fakeSpeaker/fakeSpeaker.h>

+ Inheritance diagram for fakeSpeaker:

Public Member Functions

 fakeSpeaker ()
 
 fakeSpeaker (const fakeSpeaker &)=delete
 
 fakeSpeaker (fakeSpeaker &&)=delete
 
fakeSpeakeroperator= (const fakeSpeaker &)=delete
 
fakeSpeakeroperator= (fakeSpeaker &&)=delete
 
 ~fakeSpeaker () override
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
virtual bool setHWGain (double gain) override
 Sets the hardware gain of the playback device (if supported by the hardware) More...
 
virtual bool configureDeviceAndStart () override
 
virtual bool interruptDeviceAndClose () override
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 ~DeviceDriver () override=default
 Destructor. More...
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver. More...
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others. More...
 
- Public Member Functions inherited from yarp::os::IConfig
virtual ~IConfig ()
 Destructor. More...
 
virtual bool configure (Searchable &config)
 Change online parameters. More...
 
- Public Member Functions inherited from yarp::dev::AudioPlayerDeviceBase
virtual bool renderSound (const yarp::sig::Sound &sound) override
 Render a sound using a device (i.e. More...
 
virtual bool startPlayback () override
 Start the playback. More...
 
virtual bool stopPlayback () override
 Stop the playback. More...
 
virtual bool isPlaying (bool &playback_enabled) override
 Check if the playback has been enabled (e.g. More...
 
virtual bool getPlaybackAudioBufferMaxSize (yarp::dev::AudioBufferSize &size) override
 
virtual bool getPlaybackAudioBufferCurrentSize (yarp::dev::AudioBufferSize &size) override
 
virtual bool resetPlaybackAudioBuffer () override
 
virtual bool setSWGain (double gain) override
 Sets a software gain for the played audio. More...
 
virtual ~AudioPlayerDeviceBase ()
 
- Public Member Functions inherited from yarp::dev::IAudioRender
virtual ~IAudioRender ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::PeriodicThread
 PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No, PeriodicThreadClock clockAccuracy=PeriodicThreadClock::Relative)
 Constructor. More...
 
 PeriodicThread (double period, PeriodicThreadClock clockAccuracy)
 Constructor. More...
 
virtual ~PeriodicThread ()
 
bool start ()
 Call this to start the thread. More...
 
void step ()
 Call this to "step" the thread rather than starting it. More...
 
void stop ()
 Call this to stop the thread, this call blocks until the thread is terminated (and releaseThread() called). More...
 
void askToStop ()
 Stop the thread. More...
 
bool isRunning () const
 Returns true when the thread is started, false otherwise. More...
 
bool isSuspended () const
 Returns true when the thread is suspended, false otherwise. More...
 
bool setPeriod (double period)
 Set the (new) period of the thread. More...
 
double getPeriod () const
 Return the current period of the thread. More...
 
void suspend ()
 Suspend the thread, the thread keeps running by doLoop is never executed. More...
 
void resume ()
 Resume the thread if previously suspended. More...
 
void resetStat ()
 Reset thread statistics. More...
 
double getEstimatedPeriod () const
 Return estimated period since last reset. More...
 
void getEstimatedPeriod (double &av, double &std) const
 Return estimated period since last reset. More...
 
unsigned int getIterations () const
 Return the number of iterations performed since last reset. More...
 
double getEstimatedUsed () const
 Return the estimated duration of the run() function since last reset. More...
 
void getEstimatedUsed (double &av, double &std) const
 Return estimated duration of the run() function since last reset. More...
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that. More...
 
int getPriority () const
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy () const
 Query the current scheduling policy of the thread, if the OS supports that. More...
 

Additional Inherited Members

- Protected Types inherited from yarp::dev::AudioPlayerDeviceBase
enum  {
  RENDER_APPEND = 0 ,
  RENDER_IMMEDIATE = 1
}
 
- Protected Member Functions inherited from yarp::dev::AudioPlayerDeviceBase
virtual void waitUntilPlaybackStreamIsComplete ()
 
virtual bool immediateSound (const yarp::sig::Sound &sound)
 
virtual bool appendSound (const yarp::sig::Sound &sound)
 
bool configurePlayerAudioDevice (yarp::os::Searchable &config, std::string device_name)
 
- Protected Member Functions inherited from yarp::os::PeriodicThread
virtual void threadRelease ()
 Release method. More...
 
virtual void beforeStart ()
 Called just before a new thread starts. More...
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...
 
- Protected Attributes inherited from yarp::dev::AudioPlayerDeviceBase
bool m_enable_buffer_autoclear = false
 
bool m_playback_enabled = false
 
std::recursive_mutex m_mutex
 
yarp::dev::CircularAudioBuffer_16tm_outputBuffer = nullptr
 
AudioDeviceDriverSettings m_audioplayer_cfg
 
double m_sw_gain = 1.0
 
double m_hw_gain = 1.0
 
bool m_audiobase_debug = false
 
enum yarp::dev::AudioPlayerDeviceBase:: { ... }  m_renderMode = RENDER_APPEND
 

Detailed Description

fakeSpeaker : fake device implementing the IAudioRender device interface to play sound

This device driver derives from AudioPlayerDeviceBase base class. Please check its documentation for additional details.

Parameters used by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
AUDIO_BASE *** - - No For the documentation of AUDIO_BASE group, please refer to the documentation of the base class AudioPlayerDeviceBase
period - double s 0.010 No the period of processing thread A value of 10ms is recommended. Do to not modify it

See Audio in YARP for additional documentation on YARP audio.

Definition at line 32 of file fakeSpeaker.h.

Constructor & Destructor Documentation

◆ fakeSpeaker() [1/3]

fakeSpeaker::fakeSpeaker ( )

Definition at line 28 of file fakeSpeaker.cpp.

◆ fakeSpeaker() [2/3]

fakeSpeaker::fakeSpeaker ( const fakeSpeaker )
delete

◆ fakeSpeaker() [3/3]

fakeSpeaker::fakeSpeaker ( fakeSpeaker &&  )
delete

◆ ~fakeSpeaker()

fakeSpeaker::~fakeSpeaker ( )
override

Definition at line 33 of file fakeSpeaker.cpp.

Member Function Documentation

◆ close()

bool fakeSpeaker::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 68 of file fakeSpeaker.cpp.

◆ configureDeviceAndStart()

bool fakeSpeaker::configureDeviceAndStart ( )
overridevirtual

Implements yarp::dev::AudioPlayerDeviceBase.

Definition at line 128 of file fakeSpeaker.cpp.

◆ interruptDeviceAndClose()

bool fakeSpeaker::interruptDeviceAndClose ( )
overridevirtual

Implements yarp::dev::AudioPlayerDeviceBase.

Definition at line 134 of file fakeSpeaker.cpp.

◆ open()

bool fakeSpeaker::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 38 of file fakeSpeaker.cpp.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

fakeSpeaker& fakeSpeaker::operator= ( fakeSpeaker &&  )
delete

◆ setHWGain()

bool fakeSpeaker::setHWGain ( double  gain)
overridevirtual

Sets the hardware gain of the playback device (if supported by the hardware)

Parameters
gainthe audio gain (1.0 is the default value)
Returns
true/false upon success/failure

Implements yarp::dev::IAudioRender.

Definition at line 117 of file fakeSpeaker.cpp.


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