Module::AudioInterface Class Reference

#include <AudioInterface.hpp>

Inheritance diagram for Module::AudioInterface:

Public Member Functions
	AudioInterface ()
virtual Sound *	playSound (SoundClip *)
virtual Sound *	playSound (SoundClip *, float, float)=0
virtual SoundClip *	loadSoundClip (const std::string &, const std::string &)
virtual void	unloadSoundClip (SoundClip *)=0
void	debugAudio ()

Protected Member Functions
void	start ()
void	run ()
virtual void	replaySound (Sound *)=0
virtual void	resumeSound (Sound *)=0
virtual void	pauseSound (Sound *)=0
virtual void	stopSound (Sound *)=0
virtual void	setDevice ()=0
virtual void	setListener (GameObject *)=0
virtual void	setFrequency (SoundClip *, unsigned int)

Protected Attributes
ModuleGame *	game
GameObject *	listener
Book< Sound >	sounds
Book< SoundClip >	clips

Friends
class	Sound
class	SoundClip
class	ModuleGame

Detailed Description

The AudioInterface is one of Module's four core interfaces, and handles its titular audio. It may be used to load and or play sounds.

Constructor & Destructor Documentation

AudioInterface::AudioInterface

(

)

Member Function Documentation

void AudioInterface::debugAudio

(

)

A debug method, which prints out information about the current state of game audio.

SoundClip * AudioInterface::loadSoundClip ( const std::string &  name, const std::string &  fileName  )

virtual

Loads a SoundClip into memory.

Parameters

name	The name of the SoundClip, ie: "explosion."
fileName	The name of the file to be loaded from.

Returns

A pointer to the loaded SoundClip.

virtual void Module::AudioInterface::pauseSound ( Sound *  )

protectedpure virtual

Sound * AudioInterface::playSound ( SoundClip *  clip )

virtual

Plays a Sound.

Parameters

clip	A pointer to the SoundClip that the Sound will be of.

Returns

A pointer to the Sound, which is currently playing.

virtual Sound* Module::AudioInterface::playSound ( SoundClip *  , float  , float    )

pure virtual

virtual void Module::AudioInterface::replaySound ( Sound *  )

protectedpure virtual

virtual void Module::AudioInterface::resumeSound ( Sound *  )

protectedpure virtual

void AudioInterface::run ( )

protectedvirtual

Overrides ThreadObject::run()

Implements Module::ThreadObject.

virtual void Module::AudioInterface::setDevice ( )

protectedpure virtual

void AudioInterface::setFrequency ( SoundClip *  soundClip, unsigned int  frequency  )

protectedvirtual

Sets the frequency of a SoundClip.

Parameters

soundClip	A pointer to the SoundClip.
frequency	The frequency of the clip, in Hertz.

virtual void Module::AudioInterface::setListener ( GameObject *  )

protectedpure virtual

void AudioInterface::start ( )

protected

Starts the thread for run.

virtual void Module::AudioInterface::stopSound ( Sound *  )

protectedpure virtual

virtual void Module::AudioInterface::unloadSoundClip ( SoundClip *  )

pure virtual

Friends And Related Function Documentation

friend class ModuleGame

friend

friend class Sound

friend

friend class SoundClip

friend

Member Data Documentation

Book<SoundClip> Module::AudioInterface::clips

protected

The collection of all loaded sounds

ModuleGame* Module::AudioInterface::game

protected

The game that this is a part of

GameObject* Module::AudioInterface::listener

protected

The listener GameObject

Book<Sound> Module::AudioInterface::sounds

protected

The collection of all playing sounds