Audio Class
Layer which handles the Lua-facing side of loading and playing audio.
Method Index
- dumpSoundArchive(out_dir)
- findIndexOfCurrentTrack()
- init()
- initSpeech(speech_file)
- notifyJukebox()
- onMusicOver()
- pauseBackgroundTrack()
- playBackgroundTrack(index)
- playNextBackgroundTrack()
- playNextOrPreviousBackgroundTrack(direction)
- playPreviousBackgroundTrack()
- playRandomBackgroundTrack()
- playSound(name, where, is_announcement)
- playSoundEffects(play_effects)
- setAnnouncementVolume(volume)
- setBackgroundVolume(volume)
- setSoundVolume(volume)
- stopBackgroundTrack()
Member Index
- announcement_volume
- app
- background_music
- background_paused
- background_playlist
- bg_music_volume
- has_bg_music
- not_loaded
- old_bg_music_volume
- play_announcements
- play_sounds
- sound_archive
- sound_fx
- sound_volume
- speech_file_name
function Audio:Audio(app)
Parameters:
Name | Type | Description |
---|---|---|
app | ? | ? |
Declared on: line 32 of Lua/audio.lua.
function Audio:dumpSoundArchive(out_dir)
Parameters:
Name | Type | Description |
---|---|---|
out_dir | ? | ? |
Declared on: line 227 of Lua/audio.lua.
function Audio:init()
Declared on: line 56 of Lua/audio.lua.
function Audio:initSpeech(speech_file)
Parameters:
Name | Type | Description |
---|---|---|
speech_file | ? | ? |
Declared on: line 177 of Lua/audio.lua.
function Audio:notifyJukebox()
search for jukebox and notify it to update its play button
Declared on: line 443 of Lua/audio.lua.
function Audio:onMusicOver()
Declared on: line 406 of Lua/audio.lua.
function Audio:playBackgroundTrack(index)
Parameters:
Name | Type | Description |
---|---|---|
index | ? | ? |
Declared on: line 363 of Lua/audio.lua.
function Audio:playNextOrPreviousBackgroundTrack(direction)
Parameters:
Name | Type | Description |
---|---|---|
direction | ? | ? |
Declared on: line 287 of Lua/audio.lua.
function Audio:playSound(name, where, is_announcement)
Parameters:
Name | Type | Description |
---|---|---|
name | ? | ? |
where | ? | ? |
is_announcement | ? | ? |
Declared on: line 239 of Lua/audio.lua.
function Audio:playSoundEffects(play_effects)
Parameters:
Name | Type | Description |
---|---|---|
play_effects | ? | ? |
Declared on: line 431 of Lua/audio.lua.
function Audio:setAnnouncementVolume(volume)
Parameters:
Name | Type | Description |
---|---|---|
volume | ? | ? |
Declared on: line 439 of Lua/audio.lua.
function Audio:setBackgroundVolume(volume)
Parameters:
Name | Type | Description |
---|---|---|
volume | ? | ? |
Declared on: line 413 of Lua/audio.lua.
function Audio:setSoundVolume(volume)
Parameters:
Name | Type | Description |
---|---|---|
volume | ? | ? |
Declared on: line 422 of Lua/audio.lua.