audioFromFileDevice : This device driver, wrapped by default by AudioRecorderWrapper, is used to read data from a file and stream it to the network. More...

#include <audioFromFileDevice/audioFromFileDevice.h>

Inheritance diagram for audioFromFileDevice:

Public Member Functions
	audioFromFileDevice ()

	audioFromFileDevice (const audioFromFileDevice &)=delete

	audioFromFileDevice (audioFromFileDevice &&)=delete

audioFromFileDevice &	operator= (const audioFromFileDevice &)=delete

audioFromFileDevice &	operator= (audioFromFileDevice &&)=delete

	~audioFromFileDevice () override

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

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

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::AudioRecorderDeviceBase
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

virtual	~AudioRecorderDeviceBase ()

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

Protected Attributes inherited from yarp::dev::AudioRecorderDeviceBase
bool	m_isRecording = false

std::mutex	m_mutex

yarp::dev::CircularAudioBuffer_16t *	m_inputBuffer = nullptr

AudioDeviceDriverSettings	m_audiorecorder_cfg

Detailed Description

audioFromFileDevice : This device driver, wrapped by default by AudioRecorderWrapper, is used to read data from a file and stream it to the network.

Parameters required by this device are:

Parameter name	SubParameter	Type	Units	Default Value	Required	Description	Notes
file_name	-	string	-	audio.wav	No	The name of the file opened by the module	Only .wav files supported
period	-	double	s	0.010	No	the period of thread which processes the file	On each iteration xxx samples are processed
samples	-	int	samples	512	No	the number of samples to process on each iteration of the thread	-

Definition at line 33 of file audioFromFileDevice.h.

Constructor & Destructor Documentation

◆ audioFromFileDevice() [1/3]

audioFromFileDevice::audioFromFileDevice ( )

Definition at line 34 of file audioFromFileDevice.cpp.

◆ audioFromFileDevice() [2/3]

audioFromFileDevice::audioFromFileDevice ( const audioFromFileDevice & )

delete

◆ audioFromFileDevice() [3/3]

audioFromFileDevice::audioFromFileDevice ( audioFromFileDevice && )

delete

◆ ~audioFromFileDevice()

audioFromFileDevice::~audioFromFileDevice ( )

override

Definition at line 39 of file audioFromFileDevice.cpp.

Member Function Documentation

◆ close()

bool audioFromFileDevice::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 98 of file audioFromFileDevice.cpp.

◆ open()

bool audioFromFileDevice::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 44 of file audioFromFileDevice.cpp.

◆ operator=() [1/2]

audioFromFileDevice& audioFromFileDevice::operator= ( audioFromFileDevice && )

delete

◆ operator=() [2/2]

audioFromFileDevice& audioFromFileDevice::operator= ( const audioFromFileDevice & )

delete

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

src/devices/audioFromFileDevice/audioFromFileDevice.h
src/devices/audioFromFileDevice/audioFromFileDevice.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ audioFromFileDevice() [1/3]

◆ audioFromFileDevice() [2/3]

◆ audioFromFileDevice() [3/3]

◆ ~audioFromFileDevice()

Member Function Documentation

◆ close()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]