http://wiki.spheredev.org/index.php?action=history&feed=atom&title=Legacy%3AFunctions%2FSounds 2026-04-27T21:33:43Z Revision history for this page on the wiki MediaWiki 1.29.0 http://wiki.spheredev.org/index.php?title=Legacy:Functions/Sounds&diff=9992&oldid=prev 2017-06-19T09:11:24Z

<p>Changed API to Legacy</p> <table class="diff diff-contentalign-left" data-mw="interface"> <col class='diff-marker' /> <col class='diff-content' /> <col class='diff-marker' /> <col class='diff-content' /> <tr style='vertical-align: top;' lang='en'> <td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td> <td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 09:11, 19 June 2017</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l1" >Line 1:</td> <td colspan="2" class="diff-lineno">Line 1:</td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>== Sounds ==</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>== Sounds ==</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<del class="diffchange diffchange-inline">API</del>:Sound|Sound]] object: Holds a sound or piece of music that can be played.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound|Sound]] object: Holds a sound or piece of music that can be played.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<del class="diffchange diffchange-inline">API</del>:SoundEffect|SoundEffect]] object: Holds a sound that can be played. This powerful object is designed mainly for sound effects.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect|SoundEffect]] object: Holds a sound that can be played. This powerful object is designed mainly for sound effects.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:LoadSound|LoadSound]](''filename'' [, ''streaming'']): Load a sound from ''filename'', ''streaming'' from disk optional.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:LoadSound|LoadSound]](''filename'' [, ''streaming'']): Load a sound from ''filename'', ''streaming'' from disk optional.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound object ===</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound object ===</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/play|Sound.play]](''repeat''): Play the sound, loop if ''repeat'' is true.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/play|Sound.play]](''repeat''): Play the sound, loop if ''repeat'' is true.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/pause|Sound.pause]](): Pause playback of the sound. Call [[<del class="diffchange diffchange-inline">API</del>:Sound/play|Sound.play]]() to resume.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/pause|Sound.pause]](): Pause playback of the sound. Call [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/play|Sound.play]]() to resume.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/stop|Sound.stop]](): Stop playback of the sound.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/stop|Sound.stop]](): Stop playback of the sound.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/reset|Sound.reset]](): Resets playback. No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/reset|Sound.reset]](): Resets playback. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/setRepeat|Sound.setRepeat]](repeat): Sets if the sound should be repeated.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/setRepeat|Sound.setRepeat]](repeat): Sets if the sound should be repeated.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getRepeat|Sound.getRepeat]](): Returns true if sound is set to repeat, otherwise false.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getRepeat|Sound.getRepeat]](): Returns true if sound is set to repeat, otherwise false.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/isPlaying|Sound.isPlaying]](): Check if the sound is currently playing.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/isPlaying|Sound.isPlaying]](): Check if the sound is currently playing.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/isSeekable|Sound.isSeekable]](): Returns true if the sound is seekable. Not all sound types are seekable, Ogg is.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/isSeekable|Sound.isSeekable]](): Returns true if the sound is seekable. Not all sound types are seekable, Ogg is.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getLength|Sound.getLength]](): Gets the length of the sound.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getLength|Sound.getLength]](): Gets the length of the sound.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/clone|Sound.clone]](): Returns a copy of the sound object.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/clone|Sound.clone]](): Returns a copy of the sound object.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getPosition|Sound.getPosition]](): Returns the position of the sound, zero if the sound isn't seekable.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getPosition|Sound.getPosition]](): Returns the position of the sound, zero if the sound isn't seekable.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/setPosition|Sound.setPosition]](''position''): Sets the position of the sound. Does nothing if the sound isn't seekable.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/setPosition|Sound.setPosition]](''position''): Sets the position of the sound. Does nothing if the sound isn't seekable.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getVolume|Sound.getVolume]](): Get the volume of the sound (0-255). No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getVolume|Sound.getVolume]](): Get the volume of the sound (0-255). No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/setVolume|Sound.setVolume]](''volume''): Set the volume of the sound (0-255). No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/setVolume|Sound.setVolume]](''volume''): Set the volume of the sound (0-255). No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/setPan|Sound.setPan]](pan): Pan can be from -255 to 255.&#160; -255 = left, 255 = right. No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/setPan|Sound.setPan]](pan): Pan can be from -255 to 255.&#160; -255 = left, 255 = right. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getPan|Sound.getPan]](): Returns the current pan of the sound. No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getPan|Sound.getPan]](): Returns the current pan of the sound. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/setPitch|Sound.setPitch]](''pitch''): Sets the pitch for a sound. No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/setPitch|Sound.setPitch]](''pitch''): Sets the pitch for a sound. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:Sound/getPitch|Sound.getPitch]](): Returns the current pitch. No effect on MIDIs.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:Sound/getPitch|Sound.getPitch]](): Returns the current pitch. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound Effect object ===</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound Effect object ===</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<del class="diffchange diffchange-inline">API</del>:SoundEffect|SoundEffect]] object</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* Sphere [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect|SoundEffect]] object</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:LoadSoundEffect|LoadSoundEffect]](filename [, type]): returns a [[<del class="diffchange diffchange-inline">API</del>:SoundEffect|SoundEffect]] object from 'filename'. If Sphere is unable to open the file, the engine will give an error message and exit. There are two types of sound effects: SE_SINGLE and SE_MULTIPLE.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:LoadSoundEffect|LoadSoundEffect]](filename [, type]): returns a [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect|SoundEffect]] object from 'filename'. If Sphere is unable to open the file, the engine will give an error message and exit. There are two types of sound effects: SE_SINGLE and SE_MULTIPLE.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** SE_SINGLE sound effects only allow the sound to be played once at a time.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** SE_SINGLE sound effects only allow the sound to be played once at a time.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** SE_MULTIPLE sound effects always open a new stream to the audio device for each time it is played (cleaning up or reusing old streams if possible).</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** SE_MULTIPLE sound effects always open a new stream to the audio device for each time it is played (cleaning up or reusing old streams if possible).</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/play|SoundEffect.play]](): plays the sound effect.</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/play|SoundEffect.play]](): plays the sound effect.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound effect is of type SE_SINGLE, this plays the sound if it isn't playing yet, and starts it again if it is.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound effect is of type SE_SINGLE, this plays the sound if it isn't playing yet, and starts it again if it is.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound effect is of type SE_MULTIPLE, play() simply starts playing the sound again.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound effect is of type SE_MULTIPLE, play() simply starts playing the sound again.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/stop|SoundEffect.stop]](): stops playback</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/stop|SoundEffect.stop]](): stops playback</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound is of type SE_SINGLE, stop the sound.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If the sound is of type SE_SINGLE, stop the sound.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If it is of type SE_MULTIPLE, stop all playing instances of the sound.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>** If it is of type SE_MULTIPLE, stop all playing instances of the sound.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/setVolume|SoundEffect.setVolume]](volume): sets the volume for the sound effect (0-255)</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/setVolume|SoundEffect.setVolume]](volume): sets the volume for the sound effect (0-255)</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/getVolume|SoundEffect.getVolume]](): returns the sound effect's volume (0-255)</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/getVolume|SoundEffect.getVolume]](): returns the sound effect's volume (0-255)</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/setPan|SoundEffect.setPan]](pan): pan ranges from -255 to 255.&#160; -255 = left, 255 = right. pan defaults to 0 (center).</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/setPan|SoundEffect.setPan]](pan): pan ranges from -255 to 255.&#160; -255 = left, 255 = right. pan defaults to 0 (center).</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/getPan|SoundEffect.getPan]](): returns the current pan of the sound effect</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/getPan|SoundEffect.getPan]](): returns the current pan of the sound effect</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/setPitch|SoundEffect.setPitch]](pitch): pitch ranges from 0.5 to 2.0.&#160; 0.5 is an octave down (and half as fast) while 2.0 is an octave up (and twice as fast). pitch defaults to 1.0</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/setPitch|SoundEffect.setPitch]](pitch): pitch ranges from 0.5 to 2.0.&#160; 0.5 is an octave down (and half as fast) while 2.0 is an octave up (and twice as fast). pitch defaults to 1.0</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>* [[<del class="diffchange diffchange-inline">API</del>:SoundEffect/getPitch|SoundEffect.getPitch]](): returns the current pitch</div></td><td class='diff-marker'>+</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>* [[<ins class="diffchange diffchange-inline">Legacy</ins>:SoundEffect/getPitch|SoundEffect.getPitch]](): returns the current pitch</div></td></tr> </table>

DaVince http://wiki.spheredev.org/index.php?title=Legacy:Functions/Sounds&diff=487&oldid=prev 2013-05-22T17:38:28Z

<p>space</p> <table class="diff diff-contentalign-left" data-mw="interface"> <col class='diff-marker' /> <col class='diff-content' /> <col class='diff-marker' /> <col class='diff-content' /> <tr style='vertical-align: top;' lang='en'> <td colspan='2' style="background-color: white; color:black; text-align: center;">← Older revision</td> <td colspan='2' style="background-color: white; color:black; text-align: center;">Revision as of 17:38, 22 May 2013</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l28" >Line 28:</td> <td colspan="2" class="diff-lineno">Line 28:</td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>* [[API:Sound/setPitch|Sound.setPitch]](''pitch''): Sets the pitch for a sound. No effect on MIDIs.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>* [[API:Sound/setPitch|Sound.setPitch]](''pitch''): Sets the pitch for a sound. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>* [[API:Sound/getPitch|Sound.getPitch]](): Returns the current pitch. No effect on MIDIs.</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>* [[API:Sound/getPitch|Sound.getPitch]](): Returns the current pitch. No effect on MIDIs.</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color:black; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div><del style="font-weight: bold; text-decoration: none;"></del></div></td><td colspan="2">&#160;</td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound Effect object ===</div></td><td class='diff-marker'>&#160;</td><td style="background-color: #f9f9f9; color: #333333; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #e6e6e6; vertical-align: top; white-space: pre-wrap;"><div>=== Sound Effect object ===</div></td></tr> </table>

Apollolux http://wiki.spheredev.org/index.php?title=Legacy:Functions/Sounds&diff=479&oldid=prev 2013-05-22T17:32:12Z

<p>created</p> <p><b>New page</b></p><div>== Sounds ==<br /> <br /> * Sphere [[API:Sound|Sound]] object: Holds a sound or piece of music that can be played.<br /> * Sphere [[API:SoundEffect|SoundEffect]] object: Holds a sound that can be played. This powerful object is designed mainly for sound effects.<br /> * [[API:LoadSound|LoadSound]](''filename'' [, ''streaming'']): Load a sound from ''filename'', ''streaming'' from disk optional.<br /> <br /> === Sound object ===<br /> <br /> * [[API:Sound/play|Sound.play]](''repeat''): Play the sound, loop if ''repeat'' is true.<br /> * [[API:Sound/pause|Sound.pause]](): Pause playback of the sound. Call [[API:Sound/play|Sound.play]]() to resume.<br /> * [[API:Sound/stop|Sound.stop]](): Stop playback of the sound.<br /> <br /> * [[API:Sound/reset|Sound.reset]](): Resets playback. No effect on MIDIs.<br /> * [[API:Sound/setRepeat|Sound.setRepeat]](repeat): Sets if the sound should be repeated.<br /> * [[API:Sound/getRepeat|Sound.getRepeat]](): Returns true if sound is set to repeat, otherwise false.<br /> <br /> * [[API:Sound/isPlaying|Sound.isPlaying]](): Check if the sound is currently playing.<br /> * [[API:Sound/isSeekable|Sound.isSeekable]](): Returns true if the sound is seekable. Not all sound types are seekable, Ogg is.<br /> * [[API:Sound/getLength|Sound.getLength]](): Gets the length of the sound.<br /> * [[API:Sound/clone|Sound.clone]](): Returns a copy of the sound object.<br /> * [[API:Sound/getPosition|Sound.getPosition]](): Returns the position of the sound, zero if the sound isn't seekable.<br /> * [[API:Sound/setPosition|Sound.setPosition]](''position''): Sets the position of the sound. Does nothing if the sound isn't seekable.<br /> <br /> * [[API:Sound/getVolume|Sound.getVolume]](): Get the volume of the sound (0-255). No effect on MIDIs.<br /> * [[API:Sound/setVolume|Sound.setVolume]](''volume''): Set the volume of the sound (0-255). No effect on MIDIs.<br /> * [[API:Sound/setPan|Sound.setPan]](pan): Pan can be from -255 to 255. -255 = left, 255 = right. No effect on MIDIs.<br /> * [[API:Sound/getPan|Sound.getPan]](): Returns the current pan of the sound. No effect on MIDIs.<br /> * [[API:Sound/setPitch|Sound.setPitch]](''pitch''): Sets the pitch for a sound. No effect on MIDIs.<br /> * [[API:Sound/getPitch|Sound.getPitch]](): Returns the current pitch. No effect on MIDIs.<br /> <br /> <br /> === Sound Effect object ===<br /> * Sphere [[API:SoundEffect|SoundEffect]] object<br /> * [[API:LoadSoundEffect|LoadSoundEffect]](filename [, type]): returns a [[API:SoundEffect|SoundEffect]] object from 'filename'. If Sphere is unable to open the file, the engine will give an error message and exit. There are two types of sound effects: SE_SINGLE and SE_MULTIPLE.<br /> ** SE_SINGLE sound effects only allow the sound to be played once at a time.<br /> ** SE_MULTIPLE sound effects always open a new stream to the audio device for each time it is played (cleaning up or reusing old streams if possible).<br /> * [[API:SoundEffect/play|SoundEffect.play]](): plays the sound effect.<br /> ** If the sound effect is of type SE_SINGLE, this plays the sound if it isn't playing yet, and starts it again if it is.<br /> ** If the sound effect is of type SE_MULTIPLE, play() simply starts playing the sound again.<br /> * [[API:SoundEffect/stop|SoundEffect.stop]](): stops playback<br /> ** If the sound is of type SE_SINGLE, stop the sound.<br /> ** If it is of type SE_MULTIPLE, stop all playing instances of the sound.<br /> * [[API:SoundEffect/setVolume|SoundEffect.setVolume]](volume): sets the volume for the sound effect (0-255)<br /> * [[API:SoundEffect/getVolume|SoundEffect.getVolume]](): returns the sound effect's volume (0-255)<br /> * [[API:SoundEffect/setPan|SoundEffect.setPan]](pan): pan ranges from -255 to 255. -255 = left, 255 = right. pan defaults to 0 (center).<br /> * [[API:SoundEffect/getPan|SoundEffect.getPan]](): returns the current pan of the sound effect<br /> * [[API:SoundEffect/setPitch|SoundEffect.setPitch]](pitch): pitch ranges from 0.5 to 2.0. 0.5 is an octave down (and half as fast) while 2.0 is an octave up (and twice as fast). pitch defaults to 1.0<br /> * [[API:SoundEffect/getPitch|SoundEffect.getPitch]](): returns the current pitch</div>

Apollolux