Table of Contents
22. Table audio¶
Audio is an attempt to embed audio for multiple platform using the same interface in Lua by the engine.
Unfortunately, this is still time consuming and not every platform is easy to handle with a common built-in music library. The main focus of the engine is graphics, so, for now, we will keep those libraries. PortAudio
is a potential cross-platform API to be used however the codecs might demand some time to incorporate, so, for now, it is available over Linux
only.
For Windows it is used Audiere.
For Linux it is used PortAudio.
For Android it is used native audio.
Important
For Android only add audio in the asset folder. If you try to read audio from external device such as SD card, it has to modify the Java code for that.
22.1. audio Methods¶
22.1.1. audio new¶
- new(string file_name, boolean * in_memory, boolean * play, boolean * loop)¶
Create a new instance of a audio.
- Parameters
string – file name of sound.
boolean – in memory , default is
false
.boolean – play to play immediately, default is
false
.boolean – loop to keep in loop, default is
false
.
- Returns
audio table.
22.1.2. audio play¶
- play(boolean * loop)¶
- Parameters
boolean – loop to keep in loop, default is
false
.- Returns
boolean
result
- isPlaying¶
- Returns
boolean
result
22.1.4. audio stop¶
- stop¶
- Returns
boolean
result
22.1.5. audio volume¶
- setVolume(number volume)¶
- Parameters
number – volume of sound (usually 0 to 1).
- Returns
boolean
result
- getVolume¶
- Returns
number
volume
22.1.6. audio pitch¶
- setPitch(number pitch)¶
- Parameters
number – pitch of sound.
- Returns
boolean
result
- getPitch¶
- Returns
number
pitch
22.1.7. audio pan¶
- setPan(number pan)¶
- Parameters
number – pan of sound.
- Returns
boolean
result
- getPan¶
- Returns
number
pan
22.1.8. audio pan¶
- setPan(number pan)¶
- Parameters
number – pan of sound.
- Returns
boolean
result
- getPan¶
- Returns
number
pan
22.1.9. audio reset¶
- reset¶
- Returns
boolean
result
22.1.10. audio len¶
- getLen¶
- Returns
number
length of sound.
22.1.11. audio setPosition¶
- setPan(number position)¶
- Parameters
number – position of sound as
integer
.- Returns
boolean
result
22.1.12. audio pan¶
- setPan(number pan)¶
- Parameters
number – pan of sound.
- Returns
boolean
result
- getName¶
- Returns
string
name of sound.
22.1.13. audio persistent¶
- setPersistent(boolean persistent)¶
- Parameters
boolean – persistent.
- isPersistent¶
- Returns
boolean
persistent.
22.1.14. audio destroy¶
- destroy¶
22.1.15. audio onEnd¶
- onEnd(function callback)¶
- Parameters
function –
callback.
function onEndStream(audio tAudio,string name) end