This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 01:19, 26 April 2007 (edit) Sandman (Talk | contribs) m (→Example) ← Previous diff		Current revision (12:02, 19 September 2007) (edit) (undo) Sandman (Talk | contribs)
(4 intermediate revisions not shown.)
Line 9:		Line 9:
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''INT''' songID || - Identifier of the song loaded previously with [[load_song]].	+	| '''INT''' songID || - [[SongID]] of the song loaded previously with [[load_song]]().
	|-		|-
	| '''INT''' repeats || - Number of times to repeat the song. Use -1 for an infinite loop.		| '''INT''' repeats || - Number of times to repeat the song. Use -1 for an infinite loop.
Line 15:		Line 15:
	== Returns ==		== Returns ==
-	'''INT''' : Errorcode	+	'''INT''' : Error.
	{|		{|
-	| -1 || - Error.	+	| -1 || - Error: sound inactive; mixer error; invalid [[songID]].
	|-		|-
	| 0 || - No error.		| 0 || - No error.
	|}		|}
-	== Throws ==	+	== Errors ==
	{|		{|
	| Sound inactive || - The sound is inactive.		| Sound inactive || - The sound is inactive.
	|-		|-
-	| Invalid handle || - The song identifier was invalid.	+	| Invalid songID || - The [[songID]] was invalid.
	|-		|-
	| Other || - Some Mixer error.		| Other || - Some Mixer error.
Line 45:		Line 45:
	</pre>		</pre>
	Used in example: [[load_song]]()		Used in example: [[load_song]]()
		+
		+	{{Funcbox
		+	| category=Sound
		+	}}

---

Current revision

Contents 1 Definition 2 Parameters 3 Returns 4 Errors 5 Example

[edit] Definition

INT play_song ( <INT songID> , <INT repeats> )

Plays a song.

[edit] Parameters

INT songID	- SongID of the song loaded previously with load_song().
INT repeats	- Number of times to repeat the song. Use -1 for an infinite loop.

[edit] Returns

INT : Error.

-1	- Error: sound inactive; mixer error; invalid songID.
0	- No error.

[edit] Errors

Sound inactive	- The sound is inactive.
Invalid songID	- The songID was invalid.
Other	- Some Mixer error.

[edit] Example

Program example;
Private
    int song;
Begin
    song = load_song("my_song.ogg");
    play_song(song,0);
    Loop
        frame;
    End
End

Used in example: load_song()

Sound Functions

• Is_playing_song() • Load_song() • Load_wav() • Pause_song() • Play_song() • Play_wav() • Resume_song() • Set_song_volume() • Unload_song() •