AudioManager Class Reference

#include <AudioManager.h>

Collaboration diagram for AudioManager:

Collaboration graph
[legend]
List of all members.

Detailed Description

Audio manager class.

Singleton class.

Definition at line 42 of file AudioManager.h.

Public Member Functions

 __declspec (dllexport) static void Initialise(void)
 Initialization function.

Static Public Member Functions

static void CleanUp (void)
 Clean up function.
static AudioDeviceInitialiseNextDevice (std::string id)
 Initializes an audio device.
static bool CloseDevice (std::string id)
 Closes an audio device.
static AudioDeviceGetAudioDevice (std::string id)
 Retrieves an audio device.
static uint8 GetAudioDeviceNum (void)
 Returns the number of the initialised audio devices.
static bool SetActiveDevice (std::string id)
 Sets an audio device to use for subsequent calls.


Member Function Documentation

AudioManager::__declspec ( dllexport   ) 

Initialization function.

This function must be called before using any other functions.

void AudioManager::CleanUp ( void   )  [static]

Clean up function.

Frees all resources.

Definition at line 98 of file AudioManager.cpp.

bool AudioManager::CloseDevice ( std::string  id  )  [static]

Closes an audio device.

Parameters:
id the identifier of the device which will be closed.

Definition at line 141 of file AudioManager.cpp.

AudioDevice * AudioManager::GetAudioDevice ( std::string  id  )  [static]

Retrieves an audio device.

Parameters:
id the identifier of the device which will be retrieved.

Definition at line 157 of file AudioManager.cpp.

uint8 AudioManager::GetAudioDeviceNum ( void   )  [static]

Returns the number of the initialised audio devices.

Definition at line 169 of file AudioManager.cpp.

AudioDevice * AudioManager::InitialiseNextDevice ( std::string  id  )  [static]

Initializes an audio device.

Parameters:
id the identifier of the device which will be initialized.

Definition at line 122 of file AudioManager.cpp.

bool AudioManager::SetActiveDevice ( std::string  id  )  [static]

Sets an audio device to use for subsequent calls.

Parameters:
id the identifier of the device

Definition at line 110 of file AudioManager.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 16 17:10:51 2007 for Micole by  doxygen 1.4.7