OpenTTD
MusicDriver_FluidSynth Class Reference

Music driver making use of FluidSynth. More...

#include <fluidsynth.h>

Inheritance diagram for MusicDriver_FluidSynth:
MusicDriver Driver

Public Member Functions

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

Music driver making use of FluidSynth.

Definition at line 18 of file fluidsynth.h.

Member Function Documentation

◆ GetName()

const char* MusicDriver_FluidSynth::GetName ( ) const
inlinevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 31 of file fluidsynth.h.

◆ IsSongPlaying()

bool MusicDriver_FluidSynth::IsSongPlaying ( )
virtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

Definition at line 142 of file fluidsynth.cpp.

References _midi.

◆ PlaySong()

void MusicDriver_FluidSynth::PlaySong ( const MusicSongInfo song)
virtual

Play a particular song.

Parameters
songThe information for the song to play.

Implements MusicDriver.

Definition at line 99 of file fluidsynth.cpp.

◆ SetVolume()

void MusicDriver_FluidSynth::SetVolume ( byte  vol)
virtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

Definition at line 149 of file fluidsynth.cpp.

References _midi, and DEBUG.

◆ Start()

const char * MusicDriver_FluidSynth::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 51 of file fluidsynth.cpp.

References _midi, DEBUG, default_sf, GetDriverParam(), and MxSetMusicSource().


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