OpenTTD Source 20241224-master-gee860a5c8e
MusicDriver_FluidSynth Class Reference

Music driver making use of FluidSynth. More...

#include <fluidsynth.h>

Inheritance diagram for MusicDriver_FluidSynth:
MusicDriver Driver

Public Member Functions

std::optional< std::string_view > Start (const StringList &param) override
 Start this driver.
 
void Stop () override
 Stop this driver.
 
void PlaySong (const MusicSongInfo &song) override
 Play a particular song.
 
void StopSong () override
 Stop playing the current song.
 
bool IsSongPlaying () override
 Are we currently playing a song?
 
void SetVolume (uint8_t vol) override
 Set the volume, if possible.
 
std::string_view GetName () const override
 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

Music driver making use of FluidSynth.

Definition at line 16 of file fluidsynth.h.

Member Function Documentation

◆ GetName()

std::string_view MusicDriver_FluidSynth::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 29 of file fluidsynth.h.

◆ IsSongPlaying()

bool MusicDriver_FluidSynth::IsSongPlaying ( )
overridevirtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

Definition at line 178 of file fluidsynth.cpp.

References _midi, and lock.

◆ PlaySong()

void MusicDriver_FluidSynth::PlaySong ( const MusicSongInfo song)
overridevirtual

Play a particular song.

Parameters
songThe information for the song to play.

Implements MusicDriver.

Definition at line 132 of file fluidsynth.cpp.

References _midi, Debug, MidiFile::GetSMFFile(), lock, and StopSong().

◆ SetVolume()

void MusicDriver_FluidSynth::SetVolume ( uint8_t  vol)
overridevirtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

Definition at line 186 of file fluidsynth.cpp.

References _midi, Debug, and lock.

◆ Start()

std::optional< std::string_view > MusicDriver_FluidSynth::Start ( const StringList parm)
overridevirtual

Start this driver.

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

Implements Driver.

Definition at line 61 of file fluidsynth.cpp.

References _midi, Debug, default_sf, GetDriverParam(), lock, and MxSetMusicSource().

◆ Stop()

void MusicDriver_FluidSynth::Stop ( )
overridevirtual

Stop this driver.

Implements Driver.

Definition at line 116 of file fluidsynth.cpp.

References _midi, lock, and MxSetMusicSource().

◆ StopSong()

void MusicDriver_FluidSynth::StopSong ( )
overridevirtual

Stop playing the current song.

Implements MusicDriver.

Definition at line 164 of file fluidsynth.cpp.

References _midi, and lock.

Referenced by PlaySong().


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