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

Play song

(Difference between revisions)

Current revision

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

Plays a 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 : Error.

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

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

 ==Definition==
+'''INT''' play_song ( <'''INT''' songID> , <'''INT''' repeats> )
-'''INT''' play_song ( <'''INT''' song> , <'''INT''' repeats> )
 Plays a song.
 == Parameters ==
 {|
-| '''INT''' song || - 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.
 |}
+== Returns ==
+'''INT''' : Error.
+{|
+| -1 || - Error: sound inactive; mixer error; invalid [[songID]].
+|-
+| 0 || - No error.
+|}
+== Errors ==
+{|
+| Sound inactive || - The sound is inactive.
+|-
+| Invalid songID || - The [[songID]] was invalid.
+|-
+| Other || - Some Mixer error.
+|}
+== Example ==
+<pre>
+Program example;
+Private
+    int song;
+Begin
+    song = load_song("my_song.ogg");
+    play_song(song,0);
+    Loop
+        frame;
+    End
+End
+</pre>
+Used in example: [[load_song]]()
+{{Funcbox
+  | category=Sound
+}}