OpenTTD Source  20241121-master-g67a0fccfad
MusicDriver_ExtMidi Class Reference
Inheritance diagram for MusicDriver_ExtMidi:
MusicDriver Driver

Public Member Functions

std::optional< std::string_view > Start (const StringList &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 (uint8_t vol) override
 Set the volume, if possible. More...
 
std::string_view GetName () const override
 Get the name of this driver. More...
 

Private Member Functions

void DoPlay ()
 
void DoStop ()
 

Private Attributes

std::vector< std::string > command_tokens
 
std::string song
 
pid_t pid
 

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

Definition at line 15 of file extmidi.h.

Member Function Documentation

◆ GetName()

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

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 36 of file extmidi.h.

Referenced by Start().

◆ IsSongPlaying()

bool MusicDriver_ExtMidi::IsSongPlaying ( )
overridevirtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

Definition at line 89 of file extmidi.cpp.

◆ PlaySong()

void MusicDriver_ExtMidi::PlaySong ( const MusicSongInfo song)
overridevirtual

Play a particular song.

Parameters
songThe information for the song to play.

Implements MusicDriver.

Definition at line 74 of file extmidi.cpp.

References MidiFile::GetSMFFile().

◆ SetVolume()

void MusicDriver_ExtMidi::SetVolume ( uint8_t  vol)
overridevirtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

Definition at line 98 of file extmidi.cpp.

References Debug.

◆ Start()

std::optional< std::string_view > MusicDriver_ExtMidi::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 38 of file extmidi.cpp.

References EXTERNAL_PLAYER, GetDriverParam(), SoundDriver::GetInstance(), VideoDriver::GetInstance(), GetName(), and StrEmpty().


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