MusicDriver_Allegro Class Reference

Allegro's music player. More...

#include <allegro_m.h>

Inheritance diagram for MusicDriver_Allegro:

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.
Public Member Functions inherited from Driver
virtual	~Driver ()=default
	Ensure the destructor of the sub classes are called as well.

Additional Inherited Members
Public Types inherited from Driver
enum class	Type : uint8_t {   Begin = 0 , Music = 0 , Sound , Video ,   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

Allegro's music player.

Definition at line 16 of file allegro_m.h.

Member Function Documentation

GetName()

std::string_view MusicDriver_Allegro::GetName ( ) const

inlineoverridevirtual

Get the name of this driver.

Returns

The name of the driver.

Implements Driver.

Definition at line 29 of file allegro_m.h.

IsSongPlaying()

bool MusicDriver_Allegro::IsSongPlaying ( )

overridevirtual

Are we currently playing a song?

Returns

True if a song is being played.

Implements MusicDriver.

PlaySong()

void MusicDriver_Allegro::PlaySong ( const MusicSongInfo & song )

overridevirtual

Play a particular song.

Parameters

song	The information for the song to play.

Implements MusicDriver.

SetVolume()

void MusicDriver_Allegro::SetVolume ( uint8_t vol )

overridevirtual

Set the volume, if possible.

Parameters

vol	The new volume.

Implements MusicDriver.

Start()

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

Stop()

void MusicDriver_Allegro::Stop ( )

overridevirtual

Stop this driver.

Implements Driver.

StopSong()

void MusicDriver_Allegro::StopSong ( )

overridevirtual

Stop playing the current song.

Implements MusicDriver.

---

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

• src/music/allegro_m.h