OpenTTD
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) override
 Start this driver. More...
 
void Stop () override
 Stop this driver.
 
void PlaySong (const MusicSongInfo &song) override
 Play a particular song. More...
 
void StopSong () override
 Stop playing the current song.
 
bool IsSongPlaying () override
 Are we currently playing a song? More...
 
void SetVolume (byte vol) override
 Set the volume, if possible. More...
 
const char * GetName () const override
 Get the name of this driver. More...
 

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 16 of file os2_m.h.

Member Function Documentation

◆ GetName()

const char* MusicDriver_OS2::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 29 of file os2_m.h.

◆ IsSongPlaying()

bool MusicDriver_OS2::IsSongPlaying ( )
overridevirtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

Definition at line 76 of file os2_m.cpp.

◆ PlaySong()

void MusicDriver_OS2::PlaySong ( const MusicSongInfo song)
overridevirtual

Play a particular song.

Parameters
songThe information for the song to play.

Implements MusicDriver.

Definition at line 52 of file os2_m.cpp.

References MidiFile::GetSMFFile(), and MidiSendCommand().

◆ SetVolume()

void MusicDriver_OS2::SetVolume ( byte  vol)
overridevirtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

Definition at line 71 of file os2_m.cpp.

References MidiSendCommand().

◆ Start()

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

Start this driver.

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

Implements Driver.

Definition at line 83 of file os2_m.cpp.


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