yarp::dev::IAudioRender Class Reference

#include <yarp/dev/AudioGrabberInterfaces.h>

Inheritance diagram for yarp::dev::IAudioRender:

Detailed Description

Definition at line 78 of file AudioGrabberInterfaces.h.

Public Member Functions
virtual	~IAudioRender ()
	Destructor. More...
virtual bool	renderSound (const yarp::sig::Sound &sound)=0
	Render a sound using a device (i.e. More...
virtual bool	startPlayback ()=0
	Start the playback. More...
virtual bool	stopPlayback ()=0
	Stop the playback. More...
virtual bool	getPlaybackAudioBufferMaxSize (yarp::dev::AudioBufferSize &size)=0
virtual bool	getPlaybackAudioBufferCurrentSize (yarp::dev::AudioBufferSize &size)=0
virtual bool	resetPlaybackAudioBuffer ()=0

Constructor & Destructor Documentation

~IAudioRender()

virtual yarp::dev::IAudioRender::~IAudioRender ( )

inlinevirtual

Destructor.

Definition at line 84 of file AudioGrabberInterfaces.h.

Member Function Documentation

getPlaybackAudioBufferCurrentSize()

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

pure virtual

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

getPlaybackAudioBufferMaxSize()

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

pure virtual

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

renderSound()

virtual bool yarp::dev::IAudioRender::renderSound ( const yarp::sig::Sound &  sound )

pure virtual

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

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

resetPlaybackAudioBuffer()

virtual bool yarp::dev::IAudioRender::resetPlaybackAudioBuffer ( )

pure virtual

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

startPlayback()

virtual bool yarp::dev::IAudioRender::startPlayback ( )

pure virtual

Start the playback.

Returns

true/false upon success/failure

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

stopPlayback()

virtual bool yarp::dev::IAudioRender::stopPlayback ( )

pure virtual

Stop the playback.

Returns

true/false upon success/failure

Implemented in PortAudioDeviceDriver, PortAudioPlayerDeviceDriver, and fakeSpeaker.

---

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

• src/libYARP_dev/include/yarp/dev/AudioGrabberInterfaces.h