dengine::AudioManager Class Reference

Manages the loading, unloading, and playing of sounds. More...

#include <AudioManager.h>

Public Member Functions
void	AddSound (std::string name, std::string filepath)
	Add a sound to audio manager. More...
void	LoadSounds ()
	Load added sounds to memory. More...
void	PlaySound (std::string name)
	Play a sound. More...
void	ClearSounds ()
	Clear all stored sounds. More...
void	RemoveSound (std::string name)
	Remove a single sound. More...
bool	HasSound (std::string name)
	Check if sound has been added. More...

Static Public Member Functions
static AudioManager &	GetInstance ()

Private Attributes
std::map< std::string, std::shared_ptr< Sound > >	audioCollection

Static Private Attributes
static AudioManager *	instance

Detailed Description

Manages the loading, unloading, and playing of sounds.

The audio manager is designed to be used by individual GameLevels to help manage sounds on a per level basis allowing only sounds for that level to be loaded at the loading screen

See also

Sound

Member Function Documentation

AddSound()

void AudioManager::AddSound	(	std::string	name,
		std::string	filepath
	)

Add a sound to audio manager.

Add a sound to the audio manager without loading it into memory

Parameters

filepath	Filepath to the wave file
name	The name of the sound

See also

LoadSounds

AudioManager::GetInstance().AddSound("background","./Assets/background.wav");

ClearSounds()

void AudioManager::ClearSounds

(

)

Clear all stored sounds.

Clear all currently added and loaded sounds freeing up previously allocated space

AudioManager::GetInstance().AddSound("background","./Assets/background.wav");
AudioManager::GetInstance().LoadSounds();
AudioManager::GetInstance().ClearSounds();

GetInstance()

AudioManager & AudioManager::GetInstance ( )

static

Returns an instance of the audio manager

HasSound()

bool AudioManager::HasSound

(

std::string

name

)

Check if sound has been added.

Checks if sound has been added to audiomanager

Parameters

name	Name of the sound

Returns

Whether sound currently exists in audiomanager or not

AudioManager::GetInstance().AddSound("background","./Assets/background.wav");
AudioManager::GetInstance().LoadSounds();
if(AudioManager::GetInstance().HasSound("background")){
 AudioManager::GetInstance().PlaySound("background");
}

LoadSounds()

void AudioManager::LoadSounds

(

)

Load added sounds to memory.

Loads all added sounds into memory

PlaySound()

void AudioManager::PlaySound

(

std::string

name

)

Play a sound.

Plays a sound through the default audio device

Parameters

name	The name of the sound

AudioManager::GetInstance().AddSound("background","./Assets/background.wav");
AudioManager::GetInstance().LoadSounds();
AudioManager::GetInstance().PlaySound("background");

RemoveSound()

void AudioManager::RemoveSound

(

std::string

name

)

Remove a single sound.

Removes a single sound by name from memory

Parameters

name	Name of sound to remove AudioManager::GetInstance().AddSound("background","./Assets/background.wav"); AudioManager::GetInstance().LoadSounds(); AudioManager::GetInstance().RemoveSound("background");

Member Data Documentation

audioCollection

std::map<std::string, std::shared_ptr<Sound> > dengine::AudioManager::audioCollection

private

Referenced by AddSound(), ClearSounds(), HasSound(), LoadSounds(), PlaySound(), and RemoveSound().

instance

AudioManager * AudioManager::instance

staticprivate

Referenced by GetInstance().