OpenXcom::AdlibMusic Class Reference

Container for Adlib music tracks. More...

#include <AdlibMusic.h>

Inheritance diagram for OpenXcom::AdlibMusic:

Public Member Functions
	AdlibMusic (float volume=1.0f)
	Creates a blank music track. More...
	~AdlibMusic ()
	Cleans up the music track. More...
void	load (const std::string &filename)
	Loads music from the specified file. More...
void	load (const void *data, int size)
	Loads music from a chunk of memory. More...
void	play (int loop=-1) const
	Plays the music. More...
Public Member Functions inherited from OpenXcom::Music
	Music ()
	Creates a blank music track. More...
virtual	~Music ()
	Cleans up the music track. More...

Static Public Member Functions
static void	player (void *udata, Uint8 *stream, int len)
	Adlib music player. More...
Static Public Member Functions inherited from OpenXcom::Music
static void	stop ()
	Stops all music. More...
static void	pause ()
	Pauses all music. More...
static void	resume ()
	Resumes all music. More...
static bool	isPlaying ()
	Checks if music is playing. More...

Detailed Description

Container for Adlib music tracks.

Uses a custom YM3812 music player passed to SDL_mixer.

Constructor & Destructor Documentation

AdlibMusic()

OpenXcom::AdlibMusic::AdlibMusic

(

float

volume = 1.0f

)

Creates a blank music track.

Initializes a new music track.

Parameters

volume

Music volume modifier (1.0 = 100%).

~AdlibMusic()

OpenXcom::AdlibMusic::~AdlibMusic

(

)

Cleans up the music track.

Deletes the loaded music content.

Member Function Documentation

load() [1/2]

void OpenXcom::AdlibMusic::load ( const std::string &  filename )

virtual

Loads music from the specified file.

Loads a music file from a specified filename.

Parameters

filename

Filename of the music file.

Reimplemented from OpenXcom::Music.

load() [2/2]

void OpenXcom::AdlibMusic::load ( const void *  data, int  size  )

virtual

Loads music from a chunk of memory.

Loads a music file from a specified memory chunk.

Parameters

data	Pointer to the music file in memory
size	Size of the music file in bytes.

Reimplemented from OpenXcom::Music.

play()

void OpenXcom::AdlibMusic::play ( int  loop = -1 ) const

virtual

Plays the music.

Plays the contained music track.

Parameters

loop	Amount of times to loop the track. -1 = infinite

Reimplemented from OpenXcom::Music.

player()

void OpenXcom::AdlibMusic::player ( void *  udata, Uint8 *  stream, int  len  )

static

Adlib music player.

Custom audio player.

Parameters

udata	User data to send to the player.
stream	Raw audio to output.
len	Length of audio to output.

---

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

• AdlibMusic.h
• AdlibMusic.cpp