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

From FenixWiki

Revision as of 11:08, 31 July 2007 (edit) Sandman (Talk | contribs) m (→Parameters) ← Previous diff		Revision as of 12:00, 31 July 2007 (edit) (undo) Sandman (Talk | contribs) m (→Returns) Next diff →
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.

---

Revision as of 12:00, 31 July 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Errors 5 Example

Definition

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

Plays a song.

Parameters

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

Returns

INT : Error.

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

Errors

Sound inactive	- The sound is inactive.
Invalid handle	- The song identifier was invalid.
Other	- Some Mixer error.

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()