Difference between revisions of "Oolite JavaScript Reference: Sound"
m (Updated for 1.74.) |
|||
| Line 1: | Line 1: | ||
<small>'''Prototype:''' <code>Object</code></small><br /> |
<small>'''Prototype:''' <code>Object</code></small><br /> |
||
<small>'''Subtypes:''' none |
<small>'''Subtypes:''' none |
||
| − | |||
| − | {{Oolite-class-added|1.71}} |
||
The '''Sound''' class represents sound files. A <code>Sound</code> can be played through a <code>[[Oolite JavaScript Reference: SoundSource|SoundSource]]</code>. <code>Sound</code> also provides functions to start and stop music. |
The '''Sound''' class represents sound files. A <code>Sound</code> can be played through a <code>[[Oolite JavaScript Reference: SoundSource|SoundSource]]</code>. <code>Sound</code> also provides functions to start and stop music. |
||
Revision as of 15:38, 20 June 2010
Prototype: Object
Subtypes: none
The Sound class represents sound files. A Sound can be played through a SoundSource. Sound also provides functions to start and stop music.
Properties
name
name : String (read-only)
The file name of the sound file.
Static methods
load
function load(soundFile : String)
Loads a sound file, and returns the resulting Sound object. soundFile may be either a file name or a customsounds.plist key in square brackets.
playMusic
function playMusic(soundFile : String [, loop: Boolean])
Play the specified music file, optionally looped. This may have no effect depending on the player’s music settings.
stopMusic
function stopMusic([soundFile : String])
Stop music. If a name is specified, the music will only be stopped if that’s the name of the currently playing music. For example, if you start some music with Sound.playMusic("myoxp-exciting-music.ogg") and later want to stop it, call Sound.stopMusic("myoxp-exciting-music.ogg") to avoid stopping any other music that may have taken over in the meanwhile.
