MusicDriver_Null Class Reference

The music player that does nothing. More...

#include <null_m.h>

Inheritance diagram for MusicDriver_Null:

Public Member Functions
std::optional< std::string_view >	Start (const StringList &) override
	Start this driver.
void	Stop () override
	Stop this driver.
void	PlaySong (const MusicSongInfo &) 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) 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 : uint8_t {   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 music player that does nothing.

Definition at line 16 of file null_m.h.

Member Function Documentation

GetName()

std::string_view MusicDriver_Null::GetName ( ) const

inlineoverridevirtual

Get the name of this driver.

Returns

The name of the driver.

Implements Driver.

Definition at line 29 of file null_m.h.

IsSongPlaying()

bool MusicDriver_Null::IsSongPlaying ( )

inlineoverridevirtual

Are we currently playing a song?

Returns

True if a song is being played.

Implements MusicDriver.

Definition at line 26 of file null_m.h.

PlaySong()

void MusicDriver_Null::PlaySong ( const MusicSongInfo &  song )

inlineoverridevirtual

Play a particular song.

Parameters

song	The information for the song to play.

Implements MusicDriver.

Definition at line 22 of file null_m.h.

SetVolume()

void MusicDriver_Null::SetVolume ( uint8_t  vol )

inlineoverridevirtual

Set the volume, if possible.

Parameters

vol	The new volume.

Implements MusicDriver.

Definition at line 28 of file null_m.h.

Start()

std::optional< std::string_view > MusicDriver_Null::Start ( const StringList &  parm )

inlineoverridevirtual

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 18 of file null_m.h.

Stop()

void MusicDriver_Null::Stop ( )

inlineoverridevirtual

Stop this driver.

Implements Driver.

Definition at line 20 of file null_m.h.

StopSong()

void MusicDriver_Null::StopSong ( )

inlineoverridevirtual

Stop playing the current song.

Implements MusicDriver.

Definition at line 24 of file null_m.h.

---

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

• src/music/null_m.h