fakeMicrophone : fake device implementing the IAudioGrabberSound device interface to play sound More...

#include <fakeMicrophone/fakeMicrophone.h>

Inheritance diagram for fakeMicrophone:

Detailed Description

fakeMicrophone : fake device implementing the IAudioGrabberSound device interface to play sound

Definition at line 26 of file fakeMicrophone.h.

Public Member Functions
	fakeMicrophone ()

	fakeMicrophone (const fakeMicrophone &)=delete

	fakeMicrophone (fakeMicrophone &&)=delete

fakeMicrophone &	operator= (const fakeMicrophone &)=delete

fakeMicrophone &	operator= (fakeMicrophone &&)=delete

	~fakeMicrophone () override

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

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

virtual bool	getSound (yarp::sig::Sound &sound, size_t min_number_of_samples, size_t max_number_of_samples, double max_samples_timeout_s) override
	Get a sound from a device. More...

virtual bool	startRecording () override
	Start the recording. More...

virtual bool	stopRecording () override
	Stop the recording. More...

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

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

virtual bool	resetRecordingAudioBuffer () 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::IAudioGrabberSound
virtual	~IAudioGrabberSound ()
	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...

Constructor & Destructor Documentation

◆ fakeMicrophone() [1/3]

fakeMicrophone::fakeMicrophone ( )

Definition at line 38 of file fakeMicrophone.cpp.

◆ fakeMicrophone() [2/3]

fakeMicrophone::fakeMicrophone ( const fakeMicrophone & )

delete

◆ fakeMicrophone() [3/3]

fakeMicrophone::fakeMicrophone ( fakeMicrophone && )

delete

◆ ~fakeMicrophone()

fakeMicrophone::~fakeMicrophone ( )

override

Definition at line 52 of file fakeMicrophone.cpp.

Member Function Documentation

◆ close()

bool fakeMicrophone::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 103 of file fakeMicrophone.cpp.

◆ getRecordingAudioBufferCurrentSize()

bool fakeMicrophone::getRecordingAudioBufferCurrentSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 182 of file fakeMicrophone.cpp.

◆ getRecordingAudioBufferMaxSize()

bool fakeMicrophone::getRecordingAudioBufferMaxSize ( yarp::dev::AudioBufferSize & size )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 174 of file fakeMicrophone.cpp.

◆ getSound()

bool fakeMicrophone::getSound	(	yarp::sig::Sound &	sound,
		size_t	min_number_of_samples,
		size_t	max_number_of_samples,
		double	max_samples_timeout_s
	)

overridevirtual

Get a sound from a device.

Examples: getSound(s, 0, 100, 0.1); returns a sound whose size can vary between 0 and 100, with a maximum blocking time of 0.1 getSound(s, 100, 100, 0.0); returns a sound with exact size of 100. It may block forever (more specifically, until sound size is at least 100). getSound(s, 100, 100000, 0.0); returns a sound with a minimum size of 0, while trying to transfer all the internal buffer. It may block forever (more specifically, until sound size is at least 100).

Parameters

sound	the sound to be filled
min_number_of_samples.	The function will block until the driver is able to collect at least min_number_of_samples. If set to zero, the function may return empty sounds.
max_number_of_samples.	The function will block until the driver is either able to collect max_number_of_samples or the timeout expires.
max_samples_timeout_s.	The timeout (in seconds) to retrieve max_number_of_samples.

Returns: true upon success, false for an invalid set of parameters, such as max_number_of_samples<min_number_of_samples, etc.

Implements yarp::dev::IAudioGrabberSound.

Definition at line 198 of file fakeMicrophone.cpp.

◆ open()

bool fakeMicrophone::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 57 of file fakeMicrophone.cpp.

◆ operator=() [1/2]

fakeMicrophone& fakeMicrophone::operator= ( const fakeMicrophone & )

delete

◆ operator=() [2/2]

fakeMicrophone& fakeMicrophone::operator= ( fakeMicrophone && )

delete

◆ resetRecordingAudioBuffer()

bool fakeMicrophone::resetRecordingAudioBuffer ( )

overridevirtual

Implements yarp::dev::IAudioGrabberSound.

Definition at line 190 of file fakeMicrophone.cpp.

◆ startRecording()

bool fakeMicrophone::startRecording ( )

overridevirtual

Start the recording.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 150 of file fakeMicrophone.cpp.

◆ stopRecording()

bool fakeMicrophone::stopRecording ( )

overridevirtual

Stop the recording.

Returns: true/false upon success/failure

Implements yarp::dev::IAudioGrabberSound.

Definition at line 162 of file fakeMicrophone.cpp.

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

src/devices/fakeMicrophone/fakeMicrophone.h
src/devices/fakeMicrophone/fakeMicrophone.cpp

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ fakeMicrophone() [1/3]

◆ fakeMicrophone() [2/3]

◆ fakeMicrophone() [3/3]

◆ ~fakeMicrophone()

Member Function Documentation

◆ close()

◆ getRecordingAudioBufferCurrentSize()

◆ getRecordingAudioBufferMaxSize()

◆ getSound()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetRecordingAudioBuffer()

◆ startRecording()

◆ stopRecording()