Classes | |
| class | GameAudio |
| A singleton class for managing and interfacing with audio data. More... | |
| class | MusicDescriptor |
| class | SoundDescriptor |
| Manages sound data loaded from memory. More... | |
Namespaces | |
| namespace | private_audio |
Variables | |
| bool | AUDIO_DEBUG |
| Determines whether the code in the hoa_audio namespace should print debug statements or not. | |
| bool | AUDIO_DEBUG = false |
| Determines whether the code in the hoa_audio namespace should print debug statements or not. | |
| bool | AUDIO_DEBUG |
| GameAudio * | AudioManager |
| The singleton pointer responsible for all audio operations. | |
| GameAudio * | AudioManager = NULL |
| The singleton pointer responsible for all audio operations. | |
Audio Error Constants | |
Used to determine what, if any, errors occured during audio playback | |
| const uint32 | AUDIO_ERROR_NO_DATA = 0x00000001 |
| const uint32 | AUDIO_ERROR_NONE = 0x00000000 |
| const uint32 | AUDIO_ERROR_PLAY_FAILURE = 0x00000002 |
Audio Playback Property Constants | |
Used to alter the manner in which sounds or music is played. | |
| const int32 | AUDIO_LOOP_FOREVER = -1 |
| Pass this as the loop argument in an audio function and the music or sound will loop indefinitely. | |
| const int32 | AUDIO_LOOP_ONCE = 0 |
| Pass this as the loop argument in an audio function and the music or sound will play only once. | |
| const uint32 | AUDIO_NO_FADE = 0 |
| Pass this as the fade_time argument in an audio function for no fading in or out of the audio. | |
| const uint32 | AUDIO_STANDARD_FADE = 500 |
| The standard amount of time to fade in/out music (500ms). Pass this as the fade_time argument in an audio function. | |
Audio State Constants | |
Used to determine what state a sound or music piece is in. | |
| const uint8 | AUDIO_STATE_FADING_IN = 0x10 |
| const uint8 | AUDIO_STATE_FADING_OUT = 0x20 |
| const uint8 | AUDIO_STATE_PAUSED = 0x04 |
| const uint8 | AUDIO_STATE_PLAYING = 0x08 |
| const uint8 | AUDIO_STATE_STOPPED = 0x02 |
| const uint8 | AUDIO_STATE_UNLOADED = 0x01 |
| bool hoa_audio::AUDIO_DEBUG = false |
Definition at line 32 of file audio.cpp.
Referenced by hoa_main::EnableDebugging(), hoa_audio::GameAudio::GameAudio(), hoa_audio::GameAudio::SetMusicVolume(), hoa_audio::GameAudio::SetSoundVolume(), hoa_audio::GameAudio::SingletonInitialize(), hoa_audio::GameAudio::~GameAudio(), and hoa_audio::private_audio::MusicData::~MusicData().
| const uint32 hoa_audio::AUDIO_ERROR_NO_DATA = 0x00000001 |
Definition at line 84 of file audio.h.
Referenced by hoa_audio::private_audio::SoundData::DEBUG_PrintProperties(), hoa_audio::private_audio::MusicData::DEBUG_PrintProperties(), hoa_audio::MusicDescriptor::PauseMusic(), hoa_audio::SoundDescriptor::PauseSound(), hoa_audio::SoundDescriptor::PlaySound(), hoa_audio::MusicDescriptor::ResumeMusic(), hoa_audio::SoundDescriptor::ResumeSound(), hoa_audio::MusicDescriptor::RewindMusic(), hoa_audio::MusicDescriptor::SeekMusic(), hoa_audio::MusicDescriptor::StopMusic(), and hoa_audio::SoundDescriptor::StopSound().
| const uint32 hoa_audio::AUDIO_ERROR_NONE = 0x00000000 |
| const uint32 hoa_audio::AUDIO_ERROR_PLAY_FAILURE = 0x00000002 |
| const int32 hoa_audio::AUDIO_LOOP_FOREVER = -1 |
| const int32 hoa_audio::AUDIO_LOOP_ONCE = 0 |
| const uint32 hoa_audio::AUDIO_NO_FADE = 0 |
| const uint32 hoa_audio::AUDIO_STANDARD_FADE = 500 |
| const uint8 hoa_audio::AUDIO_STATE_FADING_IN = 0x10 |
Definition at line 61 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), and hoa_audio::SoundDescriptor::GetSoundState().
| const uint8 hoa_audio::AUDIO_STATE_FADING_OUT = 0x20 |
Definition at line 62 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), and hoa_audio::SoundDescriptor::GetSoundState().
| const uint8 hoa_audio::AUDIO_STATE_PAUSED = 0x04 |
Definition at line 59 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), and hoa_audio::SoundDescriptor::GetSoundState().
| const uint8 hoa_audio::AUDIO_STATE_PLAYING = 0x08 |
Definition at line 60 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), and hoa_audio::SoundDescriptor::GetSoundState().
| const uint8 hoa_audio::AUDIO_STATE_STOPPED = 0x02 |
Definition at line 58 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), hoa_audio::SoundDescriptor::GetSoundState(), hoa_audio::MusicDescriptor::PlayMusic(), and hoa_audio::GameAudio::Update().
| const uint8 hoa_audio::AUDIO_STATE_UNLOADED = 0x01 |
Definition at line 57 of file audio.h.
Referenced by hoa_audio::MusicDescriptor::GetMusicState(), and hoa_audio::SoundDescriptor::GetSoundState().
The singleton pointer responsible for all audio operations.
Definition at line 31 of file audio.cpp.
Referenced by hoa_boot::BootMode::_OnMusicLeft(), hoa_boot::BootMode::_OnMusicRight(), hoa_boot::BootMode::_OnSoundLeft(), hoa_boot::BootMode::_OnSoundRight(), hoa_boot::BootMode::_SaveSettingsFile(), hoa_boot::BootMode::_UpdateAudioOptions(), hoa_defs::BindEngineToLua(), hoa_audio::private_audio::MusicData::DEBUG_PrintProperties(), hoa_audio::private_audio::SoundData::DEBUG_PrintProperties(), InitializeEngine(), hoa_audio::MusicDescriptor::LoadMusic(), main(), hoa_audio::MusicDescriptor::PauseMusic(), hoa_audio::SoundDescriptor::PauseSound(), hoa_audio::MusicDescriptor::PlayMusic(), hoa_audio::SoundDescriptor::PlaySound(), hoa_main::PrintSystemInformation(), hoa_audio::MusicDescriptor::ResumeMusic(), hoa_audio::SoundDescriptor::ResumeSound(), hoa_audio::MusicDescriptor::RewindMusic(), hoa_audio::MusicDescriptor::SeekMusic(), hoa_system::GameSystem::SingletonInitialize(), hoa_audio::MusicDescriptor::StopMusic(), hoa_audio::SoundDescriptor::StopSound(), and hoa_battle::private_battle::FinishWindow::Update().
| GameAudio* hoa_audio::AudioManager = NULL |
The singleton pointer responsible for all audio operations.
Definition at line 31 of file audio.cpp.
Referenced by hoa_boot::BootMode::_OnMusicLeft(), hoa_boot::BootMode::_OnMusicRight(), hoa_boot::BootMode::_OnSoundLeft(), hoa_boot::BootMode::_OnSoundRight(), hoa_boot::BootMode::_SaveSettingsFile(), hoa_boot::BootMode::_UpdateAudioOptions(), hoa_defs::BindEngineToLua(), hoa_audio::private_audio::SoundData::DEBUG_PrintProperties(), hoa_audio::private_audio::MusicData::DEBUG_PrintProperties(), InitializeEngine(), hoa_audio::MusicDescriptor::LoadMusic(), main(), hoa_audio::MusicDescriptor::PauseMusic(), hoa_audio::SoundDescriptor::PauseSound(), hoa_audio::MusicDescriptor::PlayMusic(), hoa_audio::SoundDescriptor::PlaySound(), hoa_main::PrintSystemInformation(), hoa_audio::MusicDescriptor::ResumeMusic(), hoa_audio::SoundDescriptor::ResumeSound(), hoa_audio::MusicDescriptor::RewindMusic(), hoa_audio::MusicDescriptor::SeekMusic(), hoa_system::GameSystem::SingletonInitialize(), hoa_audio::MusicDescriptor::StopMusic(), hoa_audio::SoundDescriptor::StopSound(), and hoa_battle::private_battle::FinishWindow::Update().
1.5.1