Legacy:Sound - Revision history

Apollolux: filled, cleanup

2013-05-30T22:38:53Z

filled, cleanup

Apollolux: Added categories

2013-05-20T18:38:02Z

Added categories

Apollolux: /* Notes */ fix link

2013-05-20T18:37:06Z

‎Notes: fix link

Apollolux: /* See also */ fix link

2013-05-20T18:36:48Z

‎See also: fix link

Apollolux: created from http://web.archive.org/web/20110731183131/http://www.spheredev.org/wiki/Object-Sound

2013-05-20T18:35:24Z

created from http://web.archive.org/web/20110731183131/http://www.spheredev.org/wiki/Object-Sound

New page

Holds a sound that can be played by Sphere.

__TOC__

==Initializers==
* [[API:LoadSound|LoadSound]]()

==Methods==
* [[API:Sound/play|Sound.play]]()
* [[API:Sound/pause|Sound.pause]]()
* [[API:Sound/stop|Sound.stop]]()
* [[API:Sound/isPlaying|Sound.isPlaying]]()
* [[API:Sound/getPan|Sound.getPan]]()
* [[API:Sound/setPan|Sound.setPan]]()
* [[API:Sound/getPitch|Sound.getPitch]]()
* [[API:Sound/setPitch|Sound.setPitch]]()
* [[API:Sound/getVolume|Sound.getVolume]]()
* [[API:Sound/setVolume|Sound.setVolume]]()

==Members==
None.

==Examples==
See the examples for [[API:Sound/play|Sound.play]]().

==Notes==
Sphere uses [http:/audiere.sf.net Audiere], a library that supports many sound formats. The sound formats supported include:

* Uncompressed WAV (seek supported)
* Uncompressed AIFF (seek supported)
* Ogg Vorbis (seek supported)
* FLAC (seek supported)
* MP3
* MOD, S3M, IT, XM (module music formats)
* MIDI

As mentioned above, streaming is only supported for certain kinds of audio files.

==See also==
* [http:/audiere.sf.net Audiere] sound library

← Older revision		Revision as of 18:38, 20 May 2013
Line 39:		Line 39:
	==See also==		==See also==
	* [http://audiere.sf.net Audiere] sound library		* [http://audiere.sf.net Audiere] sound library
		+
		+
		+	[[Category:Objects]][[Category:Functions]]

← Older revision		Revision as of 18:36, 20 May 2013
Line 38:		Line 38:

	==See also==		==See also==
−	* [http:/audiere.sf.net Audiere] sound library	+	* [http://audiere.sf.net Audiere] sound library

@@ Line 1: / Line 1: @@
-Holds a sound that can be played by Sphere.
+Holds a sound or piece of music that can be played by Sphere.
 __TOC__
 ==Initializers==
-*	[[API:LoadSound|LoadSound]]()
+*	[[API:LoadSound|LoadSound]](''filename'' [, ''streaming'']): Load a sound from ''filename'', ''streaming'' from disk optional.
 ==Methods==
-*	[[API:Sound/play|Sound.play]]()
+*	[[API:Sound/clone|Sound.clone]](): Returns a copy of the sound object.
-*	[[API:Sound/pause|Sound.pause]]()
+*	[[API:Sound/play|Sound.play]](''repeat''): Play the sound, loop if ''repeat'' is true.
-*	[[API:Sound/stop|Sound.stop]]()
+*	[[API:Sound/pause|Sound.pause]](): Pause playback of the sound. Call [[API:Sound/play|Sound.play]]() to resume.
-*	[[API:Sound/isPlaying|Sound.isPlaying]]()
+*	[[API:Sound/stop|Sound.stop]](): Stop playback of the sound.
-*	[[API:Sound/getPan|Sound.getPan]]()
-*	[[API:Sound/setPan|Sound.setPan]]()
+*	[[API:Sound/reset|Sound.reset]](): Resets playback. No effect on MIDIs.
-*	[[API:Sound/getPitch|Sound.getPitch]]()
+*	[[API:Sound/setRepeat|Sound.setRepeat]](repeat): Sets if the sound should be repeated.
-*	[[API:Sound/setPitch|Sound.setPitch]]()
+*	[[API:Sound/getRepeat|Sound.getRepeat]](): Returns true if sound is set to repeat, otherwise false.
 *	[[API:Sound/getVolume|Sound.getVolume]]()
-*	[[API:Sound/setVolume|Sound.setVolume]]()
+*	[[API:Sound/isPlaying|Sound.isPlaying]](): Check if the sound is currently playing.
 ==Members==
@@ Line 41: / Line 52: @@
-[[Category:Objects]][[Category:Functions]]
+{{API:Sound/navbox}}

@@ Line 25: / Line 25: @@
 ==Notes==
-Sphere uses [http:/audiere.sf.net Audiere], a library that supports many sound formats. The sound formats supported include:
+Sphere uses [http://audiere.sf.net Audiere], a library that supports many sound formats. The sound formats supported include:
 *	Uncompressed WAV (seek supported)