OpenTTD Source 20241224-master-gf74b0cf984
MusicDriver_Cocoa Class Reference
Inheritance diagram for MusicDriver_Cocoa:
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

Definition at line 15 of file cocoa_m.h.

Member Function Documentation

◆ GetName()

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

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 28 of file cocoa_m.h.

◆ IsSongPlaying()

bool MusicDriver_Cocoa::IsSongPlaying ( )
overridevirtual

Are we currently playing a song?

Returns
True if a song is being played.

Implements MusicDriver.

◆ PlaySong()

void MusicDriver_Cocoa::PlaySong ( const MusicSongInfo song)
overridevirtual

Play a particular song.

Parameters
songThe information for the song to play.

Implements MusicDriver.

◆ SetVolume()

void MusicDriver_Cocoa::SetVolume ( uint8_t  vol)
overridevirtual

Set the volume, if possible.

Parameters
volThe new volume.

Implements MusicDriver.

◆ Start()

std::optional< std::string_view > MusicDriver_Cocoa::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.

◆ Stop()

void MusicDriver_Cocoa::Stop ( )
overridevirtual

Stop this driver.

Implements Driver.

◆ StopSong()

void MusicDriver_Cocoa::StopSong ( )
overridevirtual

Stop playing the current song.

Implements MusicDriver.


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