SoundManager Class Reference

The Sound Manager is the central interface point to all sound related functions of this program. More...

List of all members.

Public Member Functions
	SoundManager ()
	Constructor.
	~SoundManager ()
	Deconstructor.
void	init ()
	Initialise the SoundManager.
void	clear ()
	Clears the SoundManager.
void	refAdd ()
	Increases the reference counter.
void	refRelease ()
	Decreases the reference counter.
f32	getGlobalVolume () const
	Gets the current global volume of all sounds.
sf::SoundBuffer *	getSoundBuffer (const std::string &fileName)
	Gets the sound buffer with the given filename.
bool	loadSoundBuffer (const std::string &fileName)
	Creates a sound buffer from the given file.
void	removeAll ()
	Removes all sound buffers.
bool	removeSoundBuffer (const std::string &fileName)
	Removes the sound buffer with the given filename.
void	setGlobalVolume (f32 volume)
	Sets the global volume of all sounds.

---

Detailed Description

The Sound Manager is the central interface point to all sound related functions of this program.

Definition at line 25 of file SoundManager.h.

---

Constructor & Destructor Documentation

SoundManager::SoundManager

(

)

Constructor.

Definition at line 24 of file SoundManager.cpp.

SoundManager::~SoundManager

(

)

Deconstructor.

Definition at line 30 of file SoundManager.cpp.

---

Member Function Documentation

void SoundManager::clear

(

)

Clears the SoundManager.

Definition at line 41 of file SoundManager.cpp.

f32 SoundManager::getGlobalVolume

(

)

const

Gets the current global volume of all sounds.

Definition at line 59 of file SoundManager.cpp.

sf::SoundBuffer * SoundManager::getSoundBuffer

(

const std::string &

fileName

)

Gets the sound buffer with the given filename.

Parameters:

fileName

Name of the buffer to retrieve.

Returns:

Returns the sound buffer on success, else NULL.

Definition at line 65 of file SoundManager.cpp.

void SoundManager::init

(

)

Initialise the SoundManager.

Definition at line 36 of file SoundManager.cpp.

bool SoundManager::loadSoundBuffer

(

const std::string &

fileName

)

Creates a sound buffer from the given file.

Parameters:

fileName

Filename where the buffer should be loaded from.

Definition at line 76 of file SoundManager.cpp.

void SoundManager::refAdd

(

)

Increases the reference counter.

Note:

For internal use only!

Definition at line 47 of file SoundManager.cpp.

void SoundManager::refRelease

(

)

Decreases the reference counter.

Note:

For internal use only!

Definition at line 53 of file SoundManager.cpp.

void SoundManager::removeAll

(

)

Removes all sound buffers.

Definition at line 116 of file SoundManager.cpp.

bool SoundManager::removeSoundBuffer

(

const std::string &

fileName

)

Removes the sound buffer with the given filename.

Parameters:

fileName

Name of the buffer to remove.

Definition at line 126 of file SoundManager.cpp.

void SoundManager::setGlobalVolume

(

f32

volume

)

Sets the global volume of all sounds.

Parameters:

volume

New global volume.

Definition at line 146 of file SoundManager.cpp.

---

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

• sound/SoundManager.h
• sound/SoundManager.cpp