Labyrinth
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | List of all members
LxS::Audio::Audio Class Reference

global object for managing sound system. While it's not implemented as a singleton, it by design should be More...

#include <audio.hpp>

Collaboration diagram for LxS::Audio::Audio:
Collaboration graph

Public Member Functions

bool IsInitialized ()
 is soundsystem initialized?
 
void Initialize ()
 initialize sound system
 
void Play ()
 start playing sounds
 
float GetGlobalVolume ()
 global volume multiplier for sound system
 
void SetGlobalVolume (float volume)
 how loud?
 
void UnloadResources ()
 uninitialize sound system
 
void SetPlaylist (std::string playlist_name, bool transition)
 
void AddToPlaylist (std::string file_name)
 append track to current BGM
 
void SetBGMVolumeMultiplier (float m)
 volume multiplier for background music;
 
std::string & GetNowPlaying ()
 return track that is currently being played
 
void PlaySFX (std::string file_name)
 play sound effect
 
void PlayUISFX (std::string file_name)
 play UI soundeffect
 
bool IsPlaying ()
 is soundtrack being played
 

Detailed Description

global object for managing sound system. While it's not implemented as a singleton, it by design should be

Member Function Documentation

void Audio::SetPlaylist ( std::string  playlist_name,
bool  transition 
)

select bgm playlist

Parameters
playlist_name- filename of BGM file to start new playlist with
transition- fade out/in if true; rapid soundtrack switch if false

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