Class AudioManager

Class Documentation

class AudioManager

Audio system manager singleton.

Public Functions

void Initialize()

Initialize the audio system.

Note

This function is called by the engine during startup

Throws:

BadInitStateException – If the system was already initialized

void Terminate()

Terminate the audio system.

Note

This function is called by the engine during shutdown

Throws:

BadInitStateException – If the system was not initialized

bool IsInitialized()

Check if the system is initialized.

Returns:

Whether the audio system is initialized

void SetGlobalGain(float value)

Set the global gain value.

Parameters:

value – The new global gain value, which must be positive

Throws:

BadValueException – If the provided value was not positive

float GetGlobalGain()

Get the global gain value.

Returns:

The current global gain value,

Public Static Functions

static AudioManager &Get()

Get the instance and create one if there isn’t one.

Returns:

The instance