#include <SDL_Mixer.h>

Inheritance diagram for SDL_Mixer:

Public Member Functions
	SDL_Mixer ()
	~SDL_Mixer ()
void	playSound (Sound *sound)
void	stopSound ()
void	pauseSound ()
void	playMusic (Music *music)
void	stopMusic ()
void	pauseMusic ()
void	setSfxVolume (int level)
void	setMusVolume (int level)
void	toggleMute ()
void	musicFadeIn (int loops, int miliseconds)
void	musicFadeOut (int miliseconds)
void	stopAllAudio ()
Private Member Functions
	SDL_Mixer (const SDL_Mixer &)
SDL_Mixer &	operator= (const SDL_Mixer &)
void	init ()
Private Attributes
int	mMusVolume
int	mSfxVolume
bool	mIsMuted
bool	mActAsNull

Detailed Description

SDL Mixer.

Implements all Mixer functions with the SDL API.

Warning:: Ensure that the mixer is not playing any audio resources before clearing them. Not doing so results in crashes.

Constructor & Destructor Documentation

SDL_Mixer::SDL_Mixer ( )

SDL_Mixer::~SDL_Mixer ( )

SDL_Mixer::SDL_Mixer ( const SDL_Mixer & ) [private]

Member Function Documentation

void SDL_Mixer::init ( ) [private]

void SDL_Mixer::musicFadeIn	(	int	loops = `-1`,
		int	miliseconds = `400`
	)

Plays music track with fade in beginning.

Parameters:

	music	Music to fade.
	loops	Number of loops to play track. Defaults to loop forever.
	miliseconds	Time of fade in. Defaults to 4 seconds.

void SDL_Mixer::musicFadeOut ( int miliseconds = 400 )

Plays music track with fade out at the end.

Parameters:

miliseconds

Time to fade out. Defaults to 400.

SDL_Mixer& SDL_Mixer::operator= ( const SDL_Mixer & ) [private]

void SDL_Mixer::pauseMusic ( ) [virtual]

Pauses music.

Reimplemented from Mixer.

void SDL_Mixer::pauseSound ( ) [virtual]

Pauses all sound channels.

Reimplemented from Mixer.

void SDL_Mixer::playMusic ( Music * music ) [virtual]

Plays a music resource from memory.

Mix_PlayMusic(music, loops);

Parameters:

	music	Music resource to play.
	loops	Number of times to play the sound (1 + loops).

Reimplemented from Mixer.

void SDL_Mixer::playSound ( Sound * sound ) [virtual]

Plays a sound resource from memory.

Mix_PlayChannel(channel, sound, loops);

Parameters:

	channel	Channel to play, specify -1 to automatically assign a channel.
	sound	Sound resource to play.
	loops	Number of times to play the sound (1 + loops).

Reimplemented from Mixer.

void SDL_Mixer::setMusVolume ( int level )

Increases Music volume.

void SDL_Mixer::setSfxVolume ( int level )

Set SFX Volume.

void SDL_Mixer::stopAllAudio ( ) [virtual]

Stops all audio globally (including all sound channels and music)

Reimplemented from Mixer.

void SDL_Mixer::stopMusic ( ) [virtual]

Stops music.

Reimplemented from Mixer.

void SDL_Mixer::stopSound ( ) [virtual]