OpenTTD Source
20241109-master-g5e4f8db7d6
|
Driver for all music playback. More...
#include <music_driver.hpp>
Public Member Functions | |
virtual void | PlaySong (const MusicSongInfo &song)=0 |
Play a particular song. More... | |
virtual void | StopSong ()=0 |
Stop playing the current song. | |
virtual bool | IsSongPlaying ()=0 |
Are we currently playing a song? More... | |
virtual void | SetVolume (uint8_t vol)=0 |
Set the volume, if possible. More... | |
Public Member Functions inherited from Driver | |
virtual std::optional< std::string_view > | Start (const StringList &parm)=0 |
Start this driver. More... | |
virtual void | Stop ()=0 |
Stop this driver. | |
virtual std::string_view | GetName () const =0 |
Get the name of this driver. More... | |
Static Public Member Functions | |
static MusicDriver * | GetInstance () |
Get the currently active instance of the music 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... | |
Driver for all music playback.
Definition at line 18 of file music_driver.hpp.
|
pure virtual |
Are we currently playing a song?
Implemented in MusicDriver_Win32, MusicDriver_Null, MusicDriver_FluidSynth, MusicDriver_ExtMidi, MusicDriver_DMusic, MusicDriver_Cocoa, MusicDriver_BeMidi, and MusicDriver_Allegro.
|
pure virtual |
Play a particular song.
song | The information for the song to play. |
Implemented in MusicDriver_Win32, MusicDriver_FluidSynth, MusicDriver_ExtMidi, MusicDriver_DMusic, MusicDriver_Cocoa, MusicDriver_BeMidi, MusicDriver_Allegro, and MusicDriver_Null.
|
pure virtual |
Set the volume, if possible.
vol | The new volume. |
Implemented in MusicDriver_Null, MusicDriver_Win32, MusicDriver_FluidSynth, MusicDriver_ExtMidi, MusicDriver_DMusic, MusicDriver_Cocoa, MusicDriver_BeMidi, and MusicDriver_Allegro.