OpenTTD Source: MusicDriver_Win32 Class Reference

OpenTTD Source 15.0-beta1

Public Member Functions
MusicDriver_Win32 Class Reference

The Windows music player. More...

`#include <win32_m.h>`

Inheritance diagram for MusicDriver_Win32:

## 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 MusicDriver * | GetInstance ()
| Get the currently active instance of the music driver.

## Detailed Description

The Windows music player.

Definition at line 16 of file win32_m.h.

## Member Function Documentation

## ◆ GetName()

std::string_view MusicDriver_Win32::GetName | ( |  | ) | const
| inlineoverridevirtual

Get the name of this driver.

Returns
  The name of the driver.

Implements Driver.

Definition at line 29 of file win32_m.h.

## ◆ IsSongPlaying()

bool MusicDriver_Win32::IsSongPlaying | ( |  | ) |
| overridevirtual

Are we currently playing a song?

Returns
  True if a song is being played.

Implements MusicDriver.

Definition at line 359 of file win32_m.cpp.

References _midi.

## ◆ PlaySong()

void MusicDriver_Win32::PlaySong | ( | const MusicSongInfo & | song | ) |
| overridevirtual

Play a particular song.

Parameters

  song | The information for the song to play.

Implements MusicDriver.

Definition at line 326 of file win32_m.cpp.

References _midi, Debug, MusicSongInfo::loop, MusicSongInfo::override_end, MusicSongInfo::override_start, and TimerCallback().

## ◆ SetVolume()

void MusicDriver_Win32::SetVolume | ( | uint8_t | vol | ) |
| overridevirtual

Set the volume, if possible.

Parameters

  vol | The new volume.

Implements MusicDriver.

Definition at line 364 of file win32_m.cpp.

References _midi.

## ◆ Start()

std::optional< std::string_view > MusicDriver_Win32::Start | ( | const StringList & | parm | ) |
| overridevirtual

Start this driver.

Parameters

  parm | Parameters passed to the driver.

Returns
  std::nullopt if everything went okay, otherwise an error message.

Implements Driver.

Definition at line 370 of file win32_m.cpp.

References _midi, Clamp(), convert_from_fs(), Debug, GetDriverParam(), GetDriverParamInt(), and lengthof.

## ◆ Stop()

void MusicDriver_Win32::Stop | ( |  | ) |
| overridevirtual

Stop this driver.

Implements Driver.

Definition at line 426 of file win32_m.cpp.

References _midi.

## ◆ StopSong()

void MusicDriver_Win32::StopSong | ( |  | ) |
| overridevirtual

Stop playing the current song.

Implements MusicDriver.

Definition at line 351 of file win32_m.cpp.

References _midi, and Debug.

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

- src/music/win32_m.h
- src/music/win32_m.cpp