MusicDriver_Null Class Reference
The music player that does nothing.
More...
#include <null_m.h>
Public Member Functions |
const char * | Start (const char *const *param) |
| Start this driver.
|
void | Stop () |
| Stop this driver.
|
void | PlaySong (const char *filename) |
| Play a particular song.
|
void | StopSong () |
| Stop playing the current song.
|
bool | IsSongPlaying () |
| Are we currently playing a song?
|
void | SetVolume (byte vol) |
| Set the volume, if possible.
|
const char * | GetName () const |
| Get the name of this driver.
|
Detailed Description
The music player that does nothing.
Definition at line 18 of file null_m.h.
Member Function Documentation
const char* MusicDriver_Null::GetName |
( |
|
) |
const [inline, virtual] |
Get the name of this driver.
- Returns:
- The name of the driver.
Implements Driver.
Definition at line 31 of file null_m.h.
bool MusicDriver_Null::IsSongPlaying |
( |
|
) |
[inline, virtual] |
Are we currently playing a song?
- Returns:
- True if a song is being played.
Implements MusicDriver.
Definition at line 28 of file null_m.h.
void MusicDriver_Null::PlaySong |
( |
const char * |
filename |
) |
[inline, virtual] |
Play a particular song.
- Parameters:
-
| filename | The name of file with the song to play. |
Implements MusicDriver.
Definition at line 24 of file null_m.h.
void MusicDriver_Null::SetVolume |
( |
byte |
vol |
) |
[inline, virtual] |
const char* MusicDriver_Null::Start |
( |
const char *const * |
parm |
) |
[inline, 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 20 of file null_m.h.
The documentation for this class was generated from the following file: