MusicDriver_DMusic Class Reference

Music player making use of DirectX. More...

#include <dmusic.h>

Inheritance diagram for MusicDriver_DMusic:

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...

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

Music player making use of DirectX.

Definition at line 16 of file dmusic.h.

Member Function Documentation

GetName()

std::string_view MusicDriver_DMusic::GetName ( ) const

inlineoverridevirtual

Get the name of this driver.

Returns

The name of the driver.

Implements Driver.

Definition at line 31 of file dmusic.h.

IsSongPlaying()

bool MusicDriver_DMusic::IsSongPlaying ( )

overridevirtual

Are we currently playing a song?

Returns

True if a song is being played.

Implements MusicDriver.

Definition at line 1233 of file dmusic.cpp.

PlaySong()

void MusicDriver_DMusic::PlaySong ( const MusicSongInfo &  song )

overridevirtual

Play a particular song.

Parameters

song	The information for the song to play.

Implements MusicDriver.

Definition at line 1211 of file dmusic.cpp.

References _thread_mutex, and lock.

SetVolume()

void MusicDriver_DMusic::SetVolume ( uint8_t  vol )

overridevirtual

Set the volume, if possible.

Parameters

vol	The new volume.

Implements MusicDriver.

Definition at line 1239 of file dmusic.cpp.

Start()

std::optional< std::string_view > MusicDriver_DMusic::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 1074 of file dmusic.cpp.

References _music.

---

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

• src/music/dmusic.h
• src/music/dmusic.cpp