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

fakeSpeaker &	operator= (const fakeSpeaker &)=delete

fakeSpeaker &	operator= (fakeSpeaker &&)=delete

	~fakeSpeaker () override

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver. More...

bool	close () override
	Close the DeviceDriver. More...

virtual bool	startPlayback () override
	Start the playback. More...

virtual bool	stopPlayback () override
	Stop the playback. More...

virtual bool	renderSound (const yarp::sig::Sound &sound) override
	Render a sound using a device (i.e. More...

virtual bool	getPlaybackAudioBufferMaxSize (yarp::dev::AudioBufferSize &size) override

virtual bool	getPlaybackAudioBufferCurrentSize (yarp::dev::AudioBufferSize &size) override

virtual bool	resetPlaybackAudioBuffer () 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 DeviceDriver *	getImplementation ()
	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::IAudioRender
virtual	~IAudioRender ()
	Destructor. More...

Public Member Functions inherited from yarp::os::PeriodicThread
	PeriodicThread (double period, ShouldUseSystemClock useSystemClock=ShouldUseSystemClock::No)
	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 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...

Detailed Description

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

Documentation to be added

Definition at line 28 of file fakeSpeaker.h.

Constructor & Destructor Documentation

◆ fakeSpeaker() [1/3]

fakeSpeaker::fakeSpeaker ( )

Definition at line 32 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 37 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 70 of file fakeSpeaker.cpp.

◆ getPlaybackAudioBufferCurrentSize()

bool fakeSpeaker::getPlaybackAudioBufferCurrentSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioRender.

Definition at line 131 of file fakeSpeaker.cpp.

◆ getPlaybackAudioBufferMaxSize()

bool fakeSpeaker::getPlaybackAudioBufferMaxSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioRender.

Definition at line 124 of file fakeSpeaker.cpp.

◆ open()

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

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ renderSound()

bool fakeSpeaker::renderSound ( const yarp::sig::Sound & sound )

overridevirtual

Render a sound using a device (i.e.

send it to the speakers).

Parameters

sound the sound to be rendered

Returns: true/false upon success/failure

Implements yarp::dev::IAudioRender.

Definition at line 144 of file fakeSpeaker.cpp.

◆ resetPlaybackAudioBuffer()

bool fakeSpeaker::resetPlaybackAudioBuffer ( )

overridevirtual

Implements yarp::dev::IAudioRender.

Definition at line 138 of file fakeSpeaker.cpp.

◆ startPlayback()

bool fakeSpeaker::startPlayback ( )

overridevirtual

Start the playback.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioRender.

Definition at line 87 of file fakeSpeaker.cpp.

◆ stopPlayback()

bool fakeSpeaker::stopPlayback ( )

overridevirtual

Stop the playback.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioRender.

Definition at line 92 of file fakeSpeaker.cpp.

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

src/devices/fakeSpeaker/fakeSpeaker.h
src/devices/fakeSpeaker/fakeSpeaker.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fakeSpeaker() [1/3]

◆ fakeSpeaker() [2/3]

◆ fakeSpeaker() [3/3]

◆ ~fakeSpeaker()

Member Function Documentation

◆ close()

◆ getPlaybackAudioBufferCurrentSize()

◆ getPlaybackAudioBufferMaxSize()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ renderSound()

◆ resetPlaybackAudioBuffer()

◆ startPlayback()

◆ stopPlayback()