- This wiki is out of date, use the continuation of this wiki instead
Unload song
From FenixWiki
(Difference between revisions)
Revision as of 11:55, 31 July 2007 (edit) Sandman (Talk | contribs) (I think stop_song() is not needed) ← Previous diff |
Current revision (13:10, 19 September 2007) (edit) (undo) Sandman (Talk | contribs) m |
||
(One intermediate revision not shown.) | |||
Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
{| | {| | ||
- | | '''INT''' SongID || - The [[SongID]] | + | | '''INT''' SongID || - The [[SongID]] of the song to unload. |
|} | |} | ||
Line 15: | Line 15: | ||
'''INT''' : Error. | '''INT''' : Error. | ||
{| | {| | ||
- | | -1 || - Error: sound inactive; invalid songID. | + | | -1 || - Error: sound inactive; invalid [[songID]]. |
|- | |- | ||
| 0 || - No error. | | 0 || - No error. | ||
|} | |} | ||
+ | |||
+ | {{Funcbox | ||
+ | | category=Sound | ||
+ | }} |
Current revision
[edit] Definition
INT unload_song ( <INT SongID> )
Frees the memory occupied by the song file, previously loaded with load_song().
[edit] Parameters
INT SongID | - The SongID of the song to unload. |
[edit] Returns
INT : Error.
-1 | - Error: sound inactive; invalid songID. |
0 | - No error. |
Sound Functions | |
• Is_playing_song() • Load_song() • Load_wav() • Pause_song() • Play_song() • Play_wav() • Resume_song() • Set_song_volume() • Unload_song() • |