MusicDriver_Win32 Class Reference

The Windows music player. More...

#include <win32_m.h>

Inheritance diagram for MusicDriver_Win32:
MusicDriver Driver

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 Windows music player.

Definition at line 18 of file win32_m.h.


Member Function Documentation

const char* MusicDriver_Win32::GetName (  )  const [inline, virtual]

Get the name of this driver.

Returns:
The name of the driver.

Implements Driver.

Definition at line 31 of file win32_m.h.

bool MusicDriver_Win32::IsSongPlaying (  )  [virtual]

Are we currently playing a song?

Returns:
True if a song is being played.

Implements MusicDriver.

Definition at line 49 of file win32_m.cpp.

References _midi.

void MusicDriver_Win32::PlaySong ( const char *  filename  )  [virtual]

Play a particular song.

Parameters:
filename The name of file with the song to play.

Implements MusicDriver.

Definition at line 31 of file win32_m.cpp.

References _midi, lastof, and strecpy().

void MusicDriver_Win32::SetVolume ( byte  vol  )  [virtual]

Set the volume, if possible.

Parameters:
vol The new volume.

Implements MusicDriver.

Definition at line 54 of file win32_m.cpp.

References _midi.

const char * MusicDriver_Win32::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 140 of file win32_m.cpp.

References _midi, and lengthof.


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

Generated on Sun Jun 5 04:21:06 2011 for OpenTTD by  doxygen 1.6.1