MusicDriver_LibTimidity Class Reference

Music driver making use of libtimidity. More...

#include <libtimidity.h>

Inheritance diagram for MusicDriver_LibTimidity:

Public Member Functions
const char *	Start (const char *const *param)
	Start this driver. More...
void	Stop ()
	Stop this driver.
void	PlaySong (const MusicSongInfo &song)
	Play a particular song. More...
void	StopSong ()
	Stop playing the current song.
bool	IsSongPlaying ()
	Are we currently playing a song? More...
void	SetVolume (byte vol)
	Set the volume, if possible. More...
const char *	GetName () const
	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 driver making use of libtimidity.

Definition at line 18 of file libtimidity.h.

Member Function Documentation

GetName()

const char* MusicDriver_LibTimidity::GetName ( ) const

inlinevirtual

Get the name of this driver.

Returns

The name of the driver.

Implements Driver.

Definition at line 31 of file libtimidity.h.

IsSongPlaying()

bool MusicDriver_LibTimidity::IsSongPlaying ( )

virtual

Are we currently playing a song?

Returns

True if a song is being played.

Implements MusicDriver.

Definition at line 112 of file libtimidity.cpp.

References _midi.

PlaySong()

void MusicDriver_LibTimidity::PlaySong ( const MusicSongInfo &  song )

virtual

Play a particular song.

Parameters

song	The information for the song to play.

Implements MusicDriver.

Definition at line 78 of file libtimidity.cpp.

SetVolume()

void MusicDriver_LibTimidity::SetVolume ( byte  vol )

virtual

Set the volume, if possible.

Parameters

vol	The new volume.

Implements MusicDriver.

Definition at line 125 of file libtimidity.cpp.

References _midi.

Start()

const char * MusicDriver_LibTimidity::Start ( const char *const *  parm )

virtual

Start this driver.

Parameters

parm	Parameters passed to the driver.

Returns

NULL if everything went okay, otherwise an error message.

Implements Driver.

Definition at line 49 of file libtimidity.cpp.

References _midi.

---

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

• src/music/libtimidity.h
• src/music/libtimidity.cpp