ISoundMusic Class Reference

Handle the music. More...

#include <isound.h>

Inherited by SoundMusic_Empty, and SoundMusic_SDL.

Inheritance diagram for ISoundMusic:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 ISoundMusic ()
virtual ~ISoundMusic ()
virtual void play (const char *file, bool loop)=0
 Start playing music file.
virtual void play (const std::string &file, bool loop)
 Start playing music file.
virtual void stop ()=0
 Stop playing music.
virtual bool isPlaying ()=0
 Get music status.

Detailed Description

Handle the music.

Definition at line 106 of file isound.h.


Constructor & Destructor Documentation

ISoundMusic::ISoundMusic  )  [inline]
 

Definition at line 110 of file isound.h.

virtual ISoundMusic::~ISoundMusic  )  [inline, virtual]
 

Definition at line 112 of file isound.h.


Member Function Documentation

virtual bool ISoundMusic::isPlaying  )  [pure virtual]
 

Get music status.

Returns:
true if the music is playing.

Implemented in SoundMusic_Empty, and SoundMusic_SDL.

Referenced by play(), and MusicManager::update().

virtual void ISoundMusic::play const std::string &  file,
bool  loop
[inline, virtual]
 

Start playing music file.

Equal to call play(file.c_str(), loop)

Definition at line 129 of file isound.h.

References isPlaying(), play(), and stop().

Here is the call graph for this function:

virtual void ISoundMusic::play const char *  file,
bool  loop
[pure virtual]
 

Start playing music file.

The file to play isn't searched in file system.

Parameters:
file name of file to play.
loop true if the music should loop forever

Implemented in SoundMusic_Empty, and SoundMusic_SDL.

Referenced by play(), and MusicManager::update().

virtual void ISoundMusic::stop  )  [pure virtual]
 

Stop playing music.

Implemented in SoundMusic_Empty, and SoundMusic_SDL.

Referenced by play(), and MusicManager::stop().


The documentation for this class was generated from the following file:
Generated on Wed Apr 12 14:18:29 2006 for bjs by  doxygen 1.4.5