Difference between revisions of "Legacy:LoadSound"
From Spherical
(Created page with "{{subst:functemp}}") |
(→See also) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
==Usage== | ==Usage== | ||
| − | {{Usage | + | {{Usage|func=LoadSound|params=file, streaming}} |
| − | * ''' | + | * '''file''' String. Name of sound file. |
| − | * ''' | + | * '''streaming''' boolean. Will stream the file from disk instead of loading the full file into memory. Useful for cutting down loading times when you have large sound files. |
| − | |||
==Examples== | ==Examples== | ||
| − | ( | + | <syntaxhighlight> |
| + | var sound = LoadSound("sound_effect.ogg"); | ||
| + | var music = LoadSound("music.ogg", true); | ||
| + | sound.play(); //Play the sound effect. | ||
| + | music.play(true); //true makes the music loop. | ||
| + | </syntaxhighlight> | ||
==Notes== | ==Notes== | ||
| − | ( | + | |
| + | Supported filetypes are: | ||
| + | |||
| + | * Ogg | ||
| + | * WAV | ||
| + | * MP3 (not in minisphere) | ||
| + | * IT | ||
| + | * MOD | ||
| + | * Various other module tracker formats. | ||
| + | * MIDI (original Sphere only; use is discouraged) | ||
| + | |||
| + | Out of the first three, Ogg is the most recommended format as it's the most widely supported and provides the best size/quality ratio. | ||
| + | |||
| + | |||
| + | Streaming works only for streaming formats like wav, ogg and mp3. | ||
==See also== | ==See also== | ||
| − | * | + | * [[API:Sound/play|Sound.play]]() |
| − | |||
| − | |||
| − | |||
Latest revision as of 03:03, 20 December 2015
{{{preamble}}}
Contents
Usage
LoadSound(file, streaming);
- file String. Name of sound file.
- streaming boolean. Will stream the file from disk instead of loading the full file into memory. Useful for cutting down loading times when you have large sound files.
Examples
var sound = LoadSound("sound_effect.ogg");
var music = LoadSound("music.ogg", true);
sound.play(); //Play the sound effect.
music.play(true); //true makes the music loop.Notes
Supported filetypes are:
- Ogg
- WAV
- MP3 (not in minisphere)
- IT
- MOD
- Various other module tracker formats.
- MIDI (original Sphere only; use is discouraged)
Out of the first three, Ogg is the most recommended format as it's the most widely supported and provides the best size/quality ratio.
Streaming works only for streaming formats like wav, ogg and mp3.
