Wt::SDLMixer Class Reference

Wrapper class around the audio mixer. More...

#include <sdlmixer.h>

Inherits Wt::Audio.

List of all members.

Public Member Functions
virtual Audio::Chunk *	loadChunk (const std::string &filename) const
virtual int	allocateChannels (int channels)
virtual void	pause ()
	pause all channels
virtual void	resume ()
	resume all channels
virtual void	stop (int ms=0)
	stop all channels
virtual void	fadeOut (int ms)
virtual int	playingChannels () const
virtual int	pausedChannels () const
virtual bool	isAvailable () const
virtual Audio::Music *	loadMusic (const std::string &filename)
virtual void	playMusic (Audio::Music &)
	it blocks until any previously music fading out is done
virtual void	fadeInMusic (Audio::Music &, int ms)
virtual void	fadeOutMusic (int ms)
virtual void	setMusicVolume (int volume)
virtual void	pauseMusic ()
virtual void	rewindMusic ()
virtual bool	setMusicPosition (double start_sec)
virtual void	stopMusic ()
virtual bool	playingMusic () const
virtual bool	pausedMusic () const
virtual int	musicFading () const
Static Public Attributes
static Factory< Audio, SDLMixer >	factory
Protected Member Functions
	~SDLMixer ()
	SDLMixer ()
virtual int	minHWVolume () const
virtual int	maxHWVolume () const
Static Protected Member Functions
static Audio *	load ()
	try to load the instance
static void	onChannelFinish (int channel)
	callback called when a channel finishes
Friends
class	Singleton< Audio >
Classes
class	Channel
class	Chunk
	SDLMixer::Chunk implementation class. More...
class	Music

---

Detailed Description

Wrapper class around the audio mixer.

---

Constructor & Destructor Documentation

Wt::SDLMixer::~SDLMixer

(

)

[protected]

Wt::SDLMixer::SDLMixer

(

)

[protected]

---

Member Function Documentation

int Wt::SDLMixer::allocateChannels

(

int

channels

)

[virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::fadeInMusic	(	Audio::Music &	,
		int	ms
	)			[virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::fadeOut

(

int

ms

)

[virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::fadeOutMusic

(

int

ms

)

[virtual]

Reimplemented from Wt::Audio.

bool Wt::SDLMixer::isAvailable

(

)

const [virtual]

Reimplemented from Wt::Audio.

Audio * Wt::SDLMixer::load

(

)

[static, protected]

try to load the instance

if it fails return NULL if it succeeds must return the newly created object

Reimplemented from Wt::Audio.

Audio::Chunk * Wt::SDLMixer::loadChunk

(

const std::string &

filename

)

const [virtual]

Reimplemented from Wt::Audio.

Audio::Music * Wt::SDLMixer::loadMusic

(

const std::string &

filename

)

[virtual]

Reimplemented from Wt::Audio.

int Wt::SDLMixer::maxHWVolume

(

)

const [protected, virtual]

Reimplemented from Wt::Audio.

int Wt::SDLMixer::minHWVolume

(

)

const [protected, virtual]

Reimplemented from Wt::Audio.

int Wt::SDLMixer::musicFading

(

)

const [virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::onChannelFinish

(

int

channel

)

[static, protected]

callback called when a channel finishes

Reimplemented from Wt::Audio.

void Wt::SDLMixer::pause

(

)

[virtual]

pause all channels

Reimplemented from Wt::Audio.

int Wt::SDLMixer::pausedChannels

(

)

const [virtual]

Reimplemented from Wt::Audio.

bool Wt::SDLMixer::pausedMusic

(

)

const [virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::pauseMusic

(

)

[virtual]

Reimplemented from Wt::Audio.

int Wt::SDLMixer::playingChannels

(

)

const [virtual]

Reimplemented from Wt::Audio.

bool Wt::SDLMixer::playingMusic

(

)

const [virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::playMusic

(

Audio::Music &

)

[virtual]

it blocks until any previously music fading out is done

Reimplemented from Wt::Audio.

void Wt::SDLMixer::resume

(

)

[virtual]

resume all channels

Reimplemented from Wt::Audio.

void Wt::SDLMixer::rewindMusic

(

)

[virtual]

Reimplemented from Wt::Audio.

bool Wt::SDLMixer::setMusicPosition

(

double

start_sec

)

[virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::setMusicVolume

(

int

volume

)

[virtual]

Reimplemented from Wt::Audio.

void Wt::SDLMixer::stop

(

int

ms = 0

)

[virtual]

stop all channels

Reimplemented from Wt::Audio.

void Wt::SDLMixer::stopMusic

(

)

[virtual]

Reimplemented from Wt::Audio.

---

Friends And Related Function Documentation

friend class Singleton< Audio > [friend]

Reimplemented from Wt::Audio.

---

Member Data Documentation

Factory< Audio, SDLMixer > Wt::SDLMixer::factory [static]

Reimplemented from Wt::Audio.

---

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

• sdlmixer.h
• sdlmixer.cpp

---

Generated Fri Jul 28 19:22:38 2006.
Copyright © 1998-2003 by the respective authors.

This document is licensed under the terms of the GNU Free Documentation License and may be freely distributed under the conditions given by this license.