sdl::audio::Audio Class Reference

#include <Audio.h>

List of all members.

Public Member Functions
	Audio (int freq, unsigned short format, unsigned char channels, unsigned char silence, unsigned short samples, unsigned int size)
	~Audio ()
bool	isPlaying ()
bool	isPaused ()
bool	isStopped ()
bool	play ()
Audio &	play (Wav &wav)
bool	pause ()
Audio &	lock ()
Audio &	unlock ()

---

Detailed Description

Definition at line 38 of file Audio.h.

---

Constructor & Destructor Documentation

sdl::audio::Audio::Audio	(	int	freq,
		unsigned short	format,
		unsigned char	channels,
		unsigned char	silence,
		unsigned short	samples,
		unsigned int	size
	)		[inline]

Opens the audio system.

Parameters:

freq	The audio frequenct in samples per second.
format	The audio data format.
channels	The number of audio channels.
silence	The audio buffer silence value.
samples	The audio buffer size in samples.
size	The audio buffer size in bytes.

Exceptions:

runtime_error

Throws a runtime_error if the audio could not be opened.

Definition at line 52 of file Audio.h.

sdl::audio::Audio::~Audio

(

)

[inline]

Closes the audio system.

Definition at line 72 of file Audio.h.

---

Member Function Documentation

bool sdl::audio::Audio::isPaused

(

)

[inline]

Determines if the audio playback is paused.

Returns:

True if paused, false otherwise.

Definition at line 86 of file Audio.h.

bool sdl::audio::Audio::isPlaying

(

)

[inline]

Determines if the audio playback is playing.

Returns:

True if playing, false otherwise.

Definition at line 79 of file Audio.h.

bool sdl::audio::Audio::isStopped

(

)

[inline]

Determines if the audio playback is stopped.

Returns:

True if stopped, false otherwise.

Definition at line 93 of file Audio.h.

Audio& sdl::audio::Audio::lock

(

)

[inline]

Locks an Audio.

Returns:

A reference to this Audio.

Definition at line 144 of file Audio.h.

bool sdl::audio::Audio::pause

(

)

[inline]

Pauses Audio playback.

Returns:

True is successful, false otherwise.

Definition at line 134 of file Audio.h.

bool sdl::audio::Audio::play

(

)

[inline]

Starts audio playback.

Returns:

True if successful, false otherwise.

Definition at line 100 of file Audio.h.

Audio& sdl::audio::Audio::play

(

Wav &

wav

)

[inline]

Plays a Wav.

Parameters:

wav	The Wav to play.

Returns:

A reference to this Audio.

Definition at line 112 of file Audio.h.

Audio& sdl::audio::Audio::unlock

(

)

[inline]

Unlocks an Audio.

Returns:

A reference to this Audio.

Definition at line 154 of file Audio.h.

---

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

• audio/Audio.h