Load song - Revision history

Sandman: /* Example */

2008-01-12T20:06:44Z

Example

←Older revision		Revision as of 20:06, 12 January 2008
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		{{Funcbox
	\| category=Sound		\| category=Sound
	}}		}}

Sandman at 12:06, 19 September 2007

2007-09-19T12:06:39Z

←Older revision		Revision as of 12:06, 19 September 2007
Line 39:		Line 39:
	</pre>		</pre>
	Used in example: [[play_song]]()		Used in example: [[play_song]]()
		+
		+	{{Funcbox
		+	\| category=Sound
		+	}}

Sandman at 11:24, 31 July 2007

2007-07-31T11:24:24Z

←Older revision		Revision as of 11:24, 31 July 2007
Line 14:		Line 14:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''STRING''' filename \|\| - The music file to be loaded, including a possible path	+	\| '''STRING''' filename \|\| - The music file to be loaded, including a possible path.
	\|}		\|}

Sandman: Afaik it doesn't play .wav

2007-07-31T11:22:13Z

Afaik it doesn't play .wav

←Older revision		Revision as of 11:22, 31 July 2007
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
	\|}		\|}

Sandman: /* Example */

2007-04-26T01:18:40Z

Example

←Older revision		Revision as of 01:18, 26 April 2007
Line 38:		Line 38:
	End		End
	</pre>		</pre>
		+	Used in example: [[play_song]]()

Sandman at 00:14, 26 April 2007

2007-04-26T00:14:59Z

←Older revision		Revision as of 00:14, 26 April 2007
Line 4:		Line 4:
	'''INT''' load_song ( <'''STRING''' path> )		'''INT''' load_song ( <'''STRING''' path> )

-	Loads a song for later use with [[play_song]]. ~~The delicious music file format~~ OGG ~~is the only one I know~~ of ~~that works with this~~ but ~~there may~~ be ~~others~~.	+	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 [[song]]s 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.
		+	* WAV (.wav). Uncompressed audio data, taking very much space.
		+
		+	== Parameters ==
		+	{\|
		+	\| '''STRING''' path \|\| - The [[path]] to the music file to be loaded.
		+	\|}
		+
		+	== Returns ==
		+	'''INT''' : [[SongID]]
		+	{\|
		+	\| -1 \|\| - Could not load music file (errormessage in console).
		+	\|-
		+	\| >=0 \|\| - The SongID.
		+	\|}
		+
		+	== Example ==
		+	<pre>
		+	Program example;
		+	Private
		+	int song;
		+	Begin
		+	song = load_song("my_song.ogg");
		+	play_song(song,0);
		+	Loop
		+	frame;
		+	End
		+	End
		+	</pre>

Sandman: Load Song moved to Load song

2007-04-25T23:58:58Z

Load Song moved to Load song

←Older revision

Revision as of 23:58, 25 April 2007

Woody at 15:12, 22 April 2007

2007-04-22T15:12:47Z

←Older revision		Revision as of 15:12, 22 April 2007
Line 1:		Line 1:
	[[Category:functions]]		[[Category:functions]]
		+	[[Category:sound]]

	'''INT''' load_song ( <'''STRING''' path> )		'''INT''' load_song ( <'''STRING''' path> )

	Loads a song for later use with [[play_song]]. The delicious music file format OGG is the only one I know of that works with this but there may be others.		Loads a song for later use with [[play_song]]. The delicious music file format OGG is the only one I know of that works with this but there may be others.

Woody at 13:52, 22 April 2007

2007-04-22T13:52:58Z

←Older revision		Revision as of 13:52, 22 April 2007
Line 1:		Line 1:
	[[Category:functions]]		[[Category:functions]]
-
-	==Definition==

	'''INT''' load_song ( <'''STRING''' path> )		'''INT''' load_song ( <'''STRING''' path> )

	Loads a song for later use with [[play_song]]. The delicious music file format OGG is the only one I know of that works with this but there may be others.		Loads a song for later use with [[play_song]]. The delicious music file format OGG is the only one I know of that works with this but there may be others.

Woody at 13:52, 22 April 2007

2007-04-22T13:52:44Z

New page

[[Category:functions]]

==Definition==

'''INT''' load_song ( <'''STRING''' path> )

Loads a song for later use with [[play_song]]. The delicious music file format OGG is the only one I know of that works with this but there may be others.