YARP
Yet Another Robot Platform

AudioPlayerWrapper: A Wrapper which receives audio streams from a network port and sends it to device for playback More...

#include <audioPlayerWrapper/AudioPlayerWrapper.h>

+ Inheritance diagram for AudioPlayerWrapper:

Public Member Functions

 AudioPlayerWrapper ()
 
 AudioPlayerWrapper (const AudioPlayerWrapper &)=delete
 
 AudioPlayerWrapper (AudioPlayerWrapper &&)=delete
 
AudioPlayerWrapperoperator= (const AudioPlayerWrapper &)=delete
 
AudioPlayerWrapperoperator= (AudioPlayerWrapper &&)=delete
 
 ~AudioPlayerWrapper () override
 
bool open (yarp::os::Searchable &params) override
 Open the DeviceDriver. More...
 
bool close () override
 Close the DeviceDriver. More...
 
bool attachAll (const yarp::dev::PolyDriverList &p) override
 Specify which sensor this thread has to read from. More...
 
bool detachAll () override
 Detach the object (you must have first called attach). More...
 
void attach (yarp::dev::IAudioRender *irend)
 
void detach ()
 
bool threadInit () override
 Initialization method. More...
 
void threadRelease () override
 Release method. More...
 
void run () override
 Loop function. 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...
 
- 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::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual Type getReadType () const
 

Additional Inherited Members

- Protected Member Functions inherited from yarp::os::PeriodicThread
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

AudioPlayerWrapper: A Wrapper which receives audio streams from a network port and sends it to device for playback

Description of input parameters

Parameters required by this device are:

Parameter name SubParameter Type Units Default Value Required Description Notes
name - string - /audioPlayerWrapper No full name of the port opened by the device MUST start with a '/' character, xxx/audio:i, xxx/rpc:i, xxx/status:o, ports are opened
period - int ms 20 No period of the internal thread, in ms default 20ms
debug - bool - - No developers use only
playback_network_buffer_size - float s 5.0 No size of the audio buffer in seconds, increasing this value to robustify the real-time audio stream (it will increase latency too) Audio playback will start when the buffer is full
start - bool - false No automatically activates the playback when the device is started if false, the playback is enabled via rpc port

See Audio in YARP for additional documentation on YARP audio.

Definition at line 53 of file AudioPlayerWrapper.h.

Constructor & Destructor Documentation

◆ AudioPlayerWrapper() [1/3]

AudioPlayerWrapper::AudioPlayerWrapper ( )

Definition at line 30 of file AudioPlayerWrapper.cpp.

◆ AudioPlayerWrapper() [2/3]

AudioPlayerWrapper::AudioPlayerWrapper ( const AudioPlayerWrapper )
delete

◆ AudioPlayerWrapper() [3/3]

AudioPlayerWrapper::AudioPlayerWrapper ( AudioPlayerWrapper &&  )
delete

◆ ~AudioPlayerWrapper()

AudioPlayerWrapper::~AudioPlayerWrapper ( )
override

Definition at line 37 of file AudioPlayerWrapper.cpp.

Member Function Documentation

◆ attach()

void AudioPlayerWrapper::attach ( yarp::dev::IAudioRender irend)

Definition at line 82 of file AudioPlayerWrapper.cpp.

◆ attachAll()

bool AudioPlayerWrapper::attachAll ( const yarp::dev::PolyDriverList p)
overridevirtual

Specify which sensor this thread has to read from.

Implements yarp::dev::IMultipleWrapper.

Definition at line 46 of file AudioPlayerWrapper.cpp.

◆ close()

bool AudioPlayerWrapper::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 344 of file AudioPlayerWrapper.cpp.

◆ detach()

void AudioPlayerWrapper::detach ( )

Definition at line 87 of file AudioPlayerWrapper.cpp.

◆ detachAll()

bool AudioPlayerWrapper::detachAll ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 72 of file AudioPlayerWrapper.cpp.

◆ open()

bool AudioPlayerWrapper::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 179 of file AudioPlayerWrapper.cpp.

◆ operator=() [1/2]

AudioPlayerWrapper& AudioPlayerWrapper::operator= ( AudioPlayerWrapper &&  )
delete

◆ operator=() [2/2]

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

◆ run()

void AudioPlayerWrapper::run ( )
overridevirtual

Loop function.

This is the thread itself. The thread calls the run() function every <period> ms. At the end of each run, the thread will sleep the amounth of time required, taking into account the time spent inside the loop function. Example: requested period is 10ms, the run() function take 3ms to be executed, the thread will sleep for 7ms.

Note: after each run is completed, the thread will call a yield() in order to facilitate other threads to run.

Implements yarp::os::PeriodicThread.

Definition at line 291 of file AudioPlayerWrapper.cpp.

◆ threadInit()

bool AudioPlayerWrapper::threadInit ( )
overridevirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::PeriodicThread.

Definition at line 174 of file AudioPlayerWrapper.cpp.

◆ threadRelease()

void AudioPlayerWrapper::threadRelease ( )
overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::PeriodicThread.

Definition at line 281 of file AudioPlayerWrapper.cpp.


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