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

From FenixWiki

Revision as of 01:18, 26 April 2007 (edit) Sandman (Talk | contribs) m (→Example) ← Previous diff		Current revision (20:06, 12 January 2008) (edit) (undo) Sandman (Talk | contribs) m (→Example)
(3 intermediate revisions not shown.)
Line 2:		Line 2:
	[[Category:sound]]		[[Category:sound]]
-	'''INT''' load_song ( <'''STRING''' path> )	+	==Definition==
		+	'''INT''' load_song ( <'''STRING''' filename> )
	Loads a song for later use with [[play_song]]().		Loads a song for later use with [[play_song]]().
Line 10:		Line 11:
	* MIDI (.mid). Takes very low space, but it's limited to samples of the soundcard.		* 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.		* Modules (.xm, .it, .s3m, .mod). Like MIDI, but Modules also contain the samples themselves.
-	* WAV (.wav). Uncompressed audio data, taking very much space.
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''STRING''' path || - The [[path]] to the music file to be loaded.	+	| '''STRING''' filename || - The music file to be loaded, including a possible path.
	|}		|}
Line 33:		Line 33:
	song = load_song("my_song.ogg");		song = load_song("my_song.ogg");
	play_song(song,0);		play_song(song,0);
-	Loop	+	Repeat
	frame;		frame;
-	End	+	Until(key(_ESC))
		+	OnExit
		+	unload_song(song);
	End		End
	</pre>		</pre>
-	Used in example: [[play_song]]()	+	Used in example: [[play_song]](), [[key]](), [[unload_song]]()
		+
		+	{{Funcbox
		+	| category=Sound
		+	}}

---

Current revision

Contents 1 Definition 2 Parameters 3 Returns 4 Example

[edit] 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.

[edit] Parameters

STRING filename

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

[edit] Returns

INT : SongID

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

[edit] Example

Program example;
Private
    int song;
Begin
    song = load_song("my_song.ogg");
    play_song(song,0);
    Repeat
        frame;
    Until(key(_ESC))
OnExit
    unload_song(song);
End

Used in example: play_song(), key(), unload_song()

Sound Functions

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