OpenTTD
Public Member Functions | Static Public Member Functions
MusicDriver Class Reference

Driver for all music playback. More...

#include <music_driver.hpp>

Inheritance diagram for MusicDriver:
Driver MusicDriver_Allegro MusicDriver_BeMidi MusicDriver_Cocoa MusicDriver_DMusic MusicDriver_ExtMidi MusicDriver_LibTimidity MusicDriver_Null MusicDriver_OS2 MusicDriver_QtMidi MusicDriver_Win32

Public Member Functions

virtual void PlaySong (const char *filename)=0
 Play a particular song.
virtual void StopSong ()=0
 Stop playing the current song.
virtual bool IsSongPlaying ()=0
 Are we currently playing a song?
virtual void SetVolume (byte vol)=0
 Set the volume, if possible.
- Public Member Functions inherited from Driver
virtual const char * Start (const char *const *parm)=0
 Start this driver.
virtual void Stop ()=0
 Stop this driver.
virtual const char * GetName () const =0
 Get the name of this driver.

Static Public Member Functions

static MusicDriverGetInstance ()
 Get the currently active instance of the music driver.

Additional Inherited Members

- Public Types inherited from Driver
enum  Type {
  DT_BEGIN = 0, DT_MUSIC = 0, DT_SOUND, DT_VIDEO,
  DT_END
}
 The type of driver. More...

Detailed Description

Driver for all music playback.

Definition at line 18 of file music_driver.hpp.

Member Function Documentation

virtual bool MusicDriver::IsSongPlaying ( )
pure virtual
virtual void MusicDriver::PlaySong ( const char *  filename)
pure virtual

Play a particular song.

Parameters
filenameThe name of file with the song to play.

Implemented in MusicDriver_ExtMidi, MusicDriver_DMusic, MusicDriver_Allegro, MusicDriver_BeMidi, MusicDriver_LibTimidity, MusicDriver_Null, MusicDriver_OS2, MusicDriver_Win32, MusicDriver_Cocoa, and MusicDriver_QtMidi.

virtual void MusicDriver::SetVolume ( byte  vol)
pure virtual

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