Sound Class Reference

Sound playback and mixing handling module. More...

List of all members.

Public Member Functions

 Sound (const std::string Filename)
 ~Sound ()
void Play (int Loops=0)
 play this sound. Loops = -1 -> plays infinitely, Loops = 0 -> plays 1 time.
int GetVolume ()
void SetVolume (int Volume=MIX_MAX_VOLUME)
void Mute ()

Static Public Member Functions

static void Pause ()
 pause all samples playback
static void Resume ()
 resume playback on all previously active channels
static void Stop ()
 halt playback on all channels


Detailed Description

Sound playback and mixing handling module.

Constructor & Destructor Documentation

Sound::Sound ( const std::string  Filename  )  [inline]

load a sound file (WAVE, AIFF, RIFF, OGG, and VOC supported)

Sound::~Sound (  )  [inline]


Member Function Documentation

int Sound::GetVolume (  )  [inline]

void Sound::Mute (  )  [inline]

static void Sound::Pause (  )  [inline, static]

pause all samples playback

void Sound::Play ( int  Loops = 0  )  [inline]

play this sound. Loops = -1 -> plays infinitely, Loops = 0 -> plays 1 time.

static void Sound::Resume (  )  [inline, static]

resume playback on all previously active channels

void Sound::SetVolume ( int  Volume = MIX_MAX_VOLUME  )  [inline]

static void Sound::Stop (  )  [inline, static]

halt playback on all channels


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

Generated on Tue May 12 09:01:35 2009 for libmSDL by  doxygen 1.5.9