Difference between revisions of "Gksound"
m (added GeSHi) |
(→GKLoadSound: Added caveat to the filename param -- VO crashes if not done properly!) |
||
| Line 49: | Line 49: | ||
{ | { | ||
soundname = "soundeffect", | soundname = "soundeffect", | ||
| − | filename = "filename", | + | filename = "filename", -- must be a filepath relative to the Vendetta directory, e.g., "plugins/lies2/lies2.mov" |
samplerate = 44100, -- optional, defaults to 44100 KHz | samplerate = 44100, -- optional, defaults to 44100 KHz | ||
preload = boolean, -- optional, defaults to true, defines whether to load immediately or load when first played | preload = boolean, -- optional, defaults to true, defines whether to load immediately or load when first played | ||
| Line 66: | Line 66: | ||
<source lang="lua">gksound.GKLoadSound{soundname='fart',filename='sound/warp_1.ogg'}</source> | <source lang="lua">gksound.GKLoadSound{soundname='fart',filename='sound/warp_1.ogg'}</source> | ||
<br><br> | <br><br> | ||
| − | |||
=== GKPlaySound === | === GKPlaySound === | ||
Revision as of 03:47, 22 April 2008
Functions ot control audio playback. Audio files read from disk must be in ogg vorbis format.
Functions
GKPlaylist
Definition:
GKPlaylist(string playlist) -> nil
Description:
Play playlist file as background music.
Arguments:
playlist filename playlist file
Returns:
Example:
GKPlayMusic
Definition:
GKPlayMusic(string audiofile) -> nil
Description:
Playback the provided file as background music in a loop
Arguments:
audiofile filename of an audiofile
Returns:
Example:
GKLoadSound
Definition:
GKLoadSound() -> boolean
Description:
Load an audio file and assign it to a sound effect name to be played by GKPlaySound.
Files supported: wav, ogg, raw.
When loading raw files, be sure to specify valid channel size and count.
table: { soundname = "soundeffect", filename = "filename", -- must be a filepath relative to the Vendetta directory, e.g., "plugins/lies2/lies2.mov" samplerate = 44100, -- optional, defaults to 44100 KHz preload = boolean, -- optional, defaults to true, defines whether to load immediately or load when first played stream = boolean, -- optional, defaults to false. defines whether to load entire file or stream. channels = 2, -- optional, defaults to whatever is in the file. needed for raw files. biasdist = 3000, -- optional, defaults to 3000, attenuates to 0 volume when this far from the listener when played as a 3D sound. width = 0, -- optional, defaults to 0 which means to use whatever the file specifies. Otherwise either 8 or 16. defines how big each channel is. loop = nil, -- optional, defaults to no loop. defined loop point in number of samples. the sound will play the entire sound and then loop back to the loop -- point until it is stopped, which you can't stop right now, heh, so use at your own risk. }
Returns:
boolean true if load succeeded, false if load failed.
Example:
gksound.GKLoadSound{soundname='fart',filename='sound/warp_1.ogg'}
GKPlaySound
Definition:
GKPlaySound(string soundeffect, float volume) -> nil
Description:
Playback a soundeffect at the given volume
Arguments:
soundeffect name of a soundeffect
volume playback volume (0-1)
Returns:
Example:
GKPlaySound("explosion", 0.5) -> nil -- play explosion sound effect at half volume
GKStopMusic
Definition:
GKStopMusic() -> nil
Description:
Stop playing background music
Arguments:
Returns:
Example:
