AudioPlayer Class Reference

An audio playback object. More...

#include <AudioPlayer.hpp>

Public Member Functions
	~AudioPlayer ()
	Destructor. More...
void	start ()
	Start audio playback. More...
void	stop ()
	Stop audio playback. More...
void	pause ()
	Pause audio playback. More...
void	setVolume (int volumeMB)
	Set the player volume. More...
bool	enqueueData (byte_t *data, size_t length)
	Enqueue a buffer of audio data for playback. More...
void	clear ()
	Release all enequeued audio data buffers. More...
timespan_ms_t	getDuration ()
	Get the total duration of the currently enqueued audio data. More...
timespan_ms_t	getPosition ()
	Get the position within the currently enqueued audio data. More...
const AudioFormat &	getAudioFormat () const
	Get the AudioFormat for this player. More...
bool	isPlaying () const
	Test if this player is currently playing audio. More...

Detailed Description

An audio playback object.

Instances of this class are created using the AudioEngine. Each AudioPlayer represents an independent audio playback stream; all such streams are mixed to the audio device by the AudioEngine.

Author

Mark Lindner

Constructor & Destructor Documentation

~AudioPlayer()

~AudioPlayer

(

)

Destructor.

Member Function Documentation

clear()

void clear

(

)

Release all enequeued audio data buffers.

Exceptions

AudioException

If an error occurs.

enqueueData()

bool enqueueData	(	byte_t *	data,
		size_t	length
	)

Enqueue a buffer of audio data for playback.

Parameters

data	The buffer of audio data.
length	The length of the buffer, in bytes.

Exceptions

AudioException

If an error occurs.

getAudioFormat()

const AudioFormat& getAudioFormat ( ) const

inline

Get the AudioFormat for this player.

getDuration()

timespan_ms_t getDuration

(

)

Get the total duration of the currently enqueued audio data.

Returns

The duration, in milliseconds.

Exceptions

AudioException

If an error occurs.

getPosition()

timespan_ms_t getPosition

(

)

Get the position within the currently enqueued audio data.

Returns

The current position, in milliseconds. This position is relative to the beginning of the first buffer that was enqueued after the most recent clear() call.

Exceptions

AudioException

If an error occurs.

isPlaying()

bool isPlaying ( ) const

inline

Test if this player is currently playing audio.

pause()

void pause

(

)

Pause audio playback.

A subsequent call to start() will resume playback at the point where it was paused.

Exceptions

AudioException

If an error occurs.

setVolume()

void setVolume

(

int

volumeMB

)

Set the player volume.

Parameters

volumeMB

The new volume, in millibars.

Exceptions

AudioException

If an error occurs.

start()

void start

(

)

Start audio playback.

Exceptions

AudioException

If an error occurs.

stop()

void stop

(

)

Stop audio playback.

A subsequent call to start() will resume playback at the beginning.

Exceptions

AudioException

If an error occurs.

---

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

• AudioPlayer.hpp
• AudioPlayer.cpp