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

From FenixWiki

Revision as of 11:24, 31 July 2007 (edit) Sandman (Talk | contribs) m ← Previous diff		Revision as of 12:06, 19 September 2007 (edit) (undo) Sandman (Talk | contribs) m Next diff →
Line 39:		Line 39:
	</pre>		</pre>
	Used in example: [[play_song]]()		Used in example: [[play_song]]()
		+
		+	{{Funcbox
		+	| category=Sound
		+	}}

---

Revision as of 12:06, 19 September 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Example

Definition

INT load_song ( <STRING filename> )

Loads a song for later use with play_song().

There are multiple filetypes you can load using this function. Included are:

• OGG Vorbis (.ogg). Good quality for songs and doesn't take too much space (it's similar to *.mp3).
• MIDI (.mid). Takes very low space, but it's limited to samples of the soundcard.
• Modules (.xm, .it, .s3m, .mod). Like MIDI, but Modules also contain the samples themselves.

Parameters

STRING filename

- The music file to be loaded, including a possible path.

Returns

INT : SongID

-1	- Could not load music file (errormessage in console).
>=0	- The SongID.

Example

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

Used in example: play_song()

Sound Functions

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