Functions | |
SOUND | sound.load (STRING path) |
Loads a sound for playing it later. More... | |
NIL | sound.play (SOUND snd) |
Play a sound object in specified channel (a free channel). More... | |
NIL | sound.play (SOUND snd, NUMBER channel) |
Play a sound object in specified channel. More... | |
NIL | sound.loop (SOUND snd) |
Apply/Remove the effect loop to an object type sound. More... | |
BOOLEAN | sound.looping (SOUND snd) |
It allows to know whether a type this sound in loop mode. More... | |
NIL | sound.pause (SOUND snd) |
Pause/Resume a sound object. More... | |
NIL | sound.pause (SOUND snd, NUMBER mode) |
Pause/Resume a sound object. More... | |
BOOLEAN | sound.playing (SOUND snd) |
It allows to know if a sound is playing. More... | |
NIL | sound.stop (SOUND snd) |
Stop a sound object. More... | |
BOOLEAN | sound.endstream (SOUND snd) |
It allows to know if a sound is finished. More... | |
NUMBER | sound.vol (SOUND snd) |
It allows to know the volume of a sound. More... | |
NIL | sound.vol (SOUND snd, NUMBER percentage) |
A sound volume allows to set. More... | |
TABLE | sound.getid3 (STRING path) |
Get ID3 info (only MP3 files) More... | |
BOOLEAN | sound.extractcover (STRING mp3, STRING path) |
Extract the image (cover) from a mp3 file. More... | |
TABLE | sound.vis (SOUND snd) |
Internal interface to display waveform. More... | |
Sound functions.
SOUND sound.load | ( | STRING | path | ) |
Loads a sound for playing it later.
path | Path of the file to load(mp3, s3m, bgm or wav). |
NIL sound.play | ( | SOUND | snd | ) |
Play a sound object in specified channel (a free channel).
snd | A sound object. |
NIL sound.play | ( | SOUND | snd, |
NUMBER | channel | ||
) |
Play a sound object in specified channel.
snd | A sound object. |
channel | Channel where the object will be played(8 channels numbered from 1 to 8). |
NIL sound.loop | ( | SOUND | snd | ) |
Apply/Remove the effect loop to an object type sound.
snd | A sound object. |
BOOLEAN sound.looping | ( | SOUND | snd | ) |
It allows to know whether a type this sound in loop mode.
snd | A sound object. |
NIL sound.pause | ( | SOUND | snd | ) |
Pause/Resume a sound object.
snd | A sound object. |
NIL sound.pause | ( | SOUND | snd, |
NUMBER | mode | ||
) |
Pause/Resume a sound object.
snd | A sound object. |
mode | Pause mode:
|
BOOLEAN sound.playing | ( | SOUND | snd | ) |
It allows to know if a sound is playing.
snd | A sound object. |
NIL sound.stop | ( | SOUND | snd | ) |
Stop a sound object.
snd | A sound object. |
BOOLEAN sound.endstream | ( | SOUND | snd | ) |
It allows to know if a sound is finished.
snd | A sound object. |
NUMBER sound.vol | ( | SOUND | snd | ) |
It allows to know the volume of a sound.
snd | A sound object. |
NIL sound.vol | ( | SOUND | snd, |
NUMBER | percentage | ||
) |
A sound volume allows to set.
snd | A sound object. |
percentage | A number with a value of 0 - 100% |
TABLE sound.getid3 | ( | STRING | path | ) |
Get ID3 info (only MP3 files)
path | Path to the MP3 file. |
BOOLEAN sound.extractcover | ( | STRING | mp3, |
STRING | path | ||
) |
Extract the image (cover) from a mp3 file.
mp3 | Path to the MP3 file. |
path | The Path where is going to extract the "cover" image. |
TABLE sound.vis | ( | SOUND | snd | ) |
Internal interface to display waveform.
snd | An object type sound. |