NLS Engine  v0.1
The Next Logical Step in game engine design.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Defines
Classes | Typedefs | Functions | Variables
Sound Namespace Reference

Namespace to contain every item that is related to the sound engine. More...

Classes

class  SoundModule

Typedefs

typedef std::map< std::string,
IXACT3WaveBank * > 
wavebank_map
typedef std::pair< std::string,
IXACT3WaveBank * > 
wavebank_pair
typedef std::map< std::string,
IXACT3SoundBank * > 
soundbank_map
typedef std::pair< std::string,
IXACT3SoundBank * > 
soundbank_pair

Functions

void WINAPI XACTNotificationCallback (const XACT_NOTIFICATION *)
template<class T >
std::string to_string (const T &t)
template<class T >
std::string to_hex (const T &t)
template<typename T >
void HandleMessageSingleParam (boost::function< void(T)> setter, const int msgID, EnvelopeSPTR envelope)
template<typename A , typename B >
const A FindKeyByValue (std::map< A, B > map, B value)
 Finds a key in a map by the value.

Variables

const unsigned int ACK_MODULE_LOADED = 4001
 Message sent from the module to indicate that the it has loaded.
const unsigned int MSG_MODULE_START = 4002
 Message sent to the module to start it up.
const unsigned int ACK_MODULE_START = 4003
 Message sent from the module with a status indicator bool that indicate whether the module sucessfully loaded.
const unsigned int MSG_LOAD_XACT_SETTINGS_FILE = 4008
const unsigned int ACK_LOAD_XACT_SETTINGS_FILE = 4009
const unsigned int MSG_LOAD_IN_MEMORY_WAVEBANK = 4010
const unsigned int ACK_LOAD_IN_MEMORY_WAVEBANK = 4011
const unsigned int MSG_LOAD_STREAMING_WAVEBANK = 4012
const unsigned int ACK_LOAD_STREAMING_WAVEBANK = 4013
const unsigned int MSG_LOAD_SOUNDBANK = 4020
const unsigned int ACK_LOAD_SOUNDBANK = 4021
const unsigned int MSG_GET_CUE_KEY = 4100
const unsigned int ACK_GET_CUE_KEY = 4101
const unsigned int MSG_PREPARE_CUE = 4110
const unsigned int ACK_PREPARE_CUE = 4111
const unsigned int MSG_PREPARE_3D_CUE = 4112
const unsigned int ACK_PREPARE_3D_CUE = 4113
const unsigned int MSG_PLAY_CUE = 4120
const unsigned int MSG_PLAY_3D_CUE = 4122
const unsigned int MSG_PLAY_CUE_AT = 4124
const unsigned int MSG_STOP_CUE = 4190
const unsigned int ACK_STOP_CUE = 4191

Detailed Description

Namespace to contain every item that is related to the sound engine.


Function Documentation

template<typename A , typename B >
const A Sound::FindKeyByValue ( std::map< A, B >  map,
value 
)

Finds a key in a map by the value.

Only the first key found with the given value is returned. Note that multiple calls to this method may provide different answers, depending on how the std::map is implemented for your compiler. If the specified value is not found, a NULL is returned - this may not work with some types of A.

Definition at line 282 of file SoundModuleXACT.cpp.


Variable Documentation

const unsigned int Sound::ACK_MODULE_LOADED = 4001

Message sent from the module to indicate that the it has loaded.

Definition at line 16 of file Messages.h.

const unsigned int Sound::ACK_MODULE_START = 4003

Message sent from the module with a status indicator bool that indicate whether the module sucessfully loaded.

Definition at line 19 of file Messages.h.

const unsigned int Sound::MSG_MODULE_START = 4002

Message sent to the module to start it up.

Definition at line 18 of file Messages.h.