OpenTTD
Public Member Functions
MusicDriver_OS2 Class Reference

OS/2's music player. More...

#include <os2_m.h>

Inheritance diagram for MusicDriver_OS2:
MusicDriver Driver

Public Member Functions

const char * Start (const char *const *param)
 Start this driver.
void Stop ()
 Stop this driver.
void PlaySong (const char *filename)
 Play a particular song.
void StopSong ()
 Stop playing the current song.
bool IsSongPlaying ()
 Are we currently playing a song?
void SetVolume (byte vol)
 Set the volume, if possible.
const char * GetName () const
 Get the name of this 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...
- Static Public Member Functions inherited from MusicDriver
static MusicDriverGetInstance ()
 Get the currently active instance of the music driver.

Detailed Description

OS/2's music player.

Definition at line 18 of file os2_m.h.

Member Function Documentation

const char* MusicDriver_OS2::GetName ( ) const
inlinevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 31 of file os2_m.h.

bool MusicDriver_OS2::IsSongPlaying ( )
virtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

Definition at line 73 of file os2_m.cpp.

void MusicDriver_OS2::PlaySong ( const char *  filename)
virtual

Play a particular song.

Parameters
filenameThe name of file with the song to play.

Implements MusicDriver.

Definition at line 52 of file os2_m.cpp.

References MidiSendCommand().

void MusicDriver_OS2::SetVolume ( byte  vol)
virtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

Definition at line 68 of file os2_m.cpp.

References MidiSendCommand().

const char * MusicDriver_OS2::Start ( const char *const *  parm)
virtual

Start this driver.

Parameters
parmParameters passed to the driver.
Returns
NULL if everything went okay, otherwise an error message.

Implements Driver.

Definition at line 80 of file os2_m.cpp.


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