CreateSound - Revision history

BlueMountains at 18:50, 14 December 2020

2020-12-14T18:50:48Z

← Older revision		Revision as of 18:50, 14 December 2020
Line 1:		Line 1:
	{{Info\|Function\|Client\|1.0}}		{{Info\|Function\|Client\|1.0}}

	{{FuncDescription\|Plays a local audio file or over http. Also supports playing .pls network streams.}}		{{FuncDescription\|Plays a local audio file or over http. Also supports playing .pls network streams.

			See [[packages]] what audio file types are supported.}}

	{{FuncSyntax\|CreateSound(SoundFile [, bLooping])}}		{{FuncSyntax\|CreateSound(SoundFile [, bLooping])}}

BlueMountains at 18:49, 14 December 2020

2020-12-14T18:49:48Z

← Older revision		Revision as of 18:49, 14 December 2020
Line 14:		Line 14:
	<syntaxhighlight lang="Lua">		<syntaxhighlight lang="Lua">
	-- Load sound from some package		-- Load sound from some package
	CreateSound("~~package~~/sounds/mysound.mp3")		CreateSound("testpackage/sounds/mysound.mp3")

	-- Load sound from current package		-- Load sound from current package
	CreateSound("sounds/mysound.mp3")		CreateSound("sounds/mysound.mp3")

			-- Play HTTP network stream
			CreateSound("http://us4.internet-radio.com:8258/listen.pls&t=.pls")
	</syntaxhighlight>		</syntaxhighlight>

	{{RelatedFunctions}}		{{RelatedFunctions}}
	{{SoundFunctions}}		{{SoundFunctions}}

BlueMountains at 13:56, 14 August 2020

2020-08-14T13:56:11Z

← Older revision		Revision as of 13:56, 14 August 2020
Line 3:		Line 3:
	{{FuncDescription\|Plays a local audio file or over http. Also supports playing .pls network streams.}}		{{FuncDescription\|Plays a local audio file or over http. Also supports playing .pls network streams.}}

	{{FuncSyntax\|CreateSound(SoundFile)}}		{{FuncSyntax\|CreateSound(SoundFile [, bLooping])}}

	{{FuncParameters}}		{{FuncParameters}}
	{{FuncParam\|SoundFile\|The path to the file to play. Or a HTTP network stream or file.}}		{{FuncParam\|SoundFile\|The path to the file to play. Or a HTTP network stream or file.}}
			{{FuncParamOptional\|bLooping\|Whether this sound should loop. Default: false.}}

	{{FuncReturnValue\|Returns the sound identifier. Returns '''false''' on error. Once the playback has finished the sound identifier will be destroyed automatically.}}		{{FuncReturnValue\|Returns the sound identifier. Returns '''false''' on error. Once the playback has finished the sound identifier will be destroyed automatically.}}
Line 12:		Line 13:
	== Example ==		== Example ==
	<syntaxhighlight lang="Lua">		<syntaxhighlight lang="Lua">
	CreateSound("~~link~~")		-- Load sound from some package
			CreateSound("package/sounds/mysound.mp3")
			-- Load sound from current package
			CreateSound("sounds/mysound.mp3")
	</syntaxhighlight>		</syntaxhighlight>

	{{RelatedFunctions}}		{{RelatedFunctions}}
	{{SoundFunctions}}		{{SoundFunctions}}

28days at 09:20, 14 December 2019

2019-12-14T09:20:04Z

← Older revision		Revision as of 09:20, 14 December 2019
Line 11:		Line 11:

	== Example ==		== Example ==
	~~__EDIT_ME__~~		<syntaxhighlight lang="Lua">
			CreateSound("link")
			</syntaxhighlight>

	{{RelatedFunctions}}		{{RelatedFunctions}}
	~~__EDIT_ME__~~		{{SoundFunctions}}

BlueMountains at 11:37, 23 October 2019

2019-10-23T11:37:32Z

← Older revision		Revision as of 11:37, 23 October 2019
Line 8:		Line 8:
	{{FuncParam\|SoundFile\|The path to the file to play. Or a HTTP network stream or file.}}		{{FuncParam\|SoundFile\|The path to the file to play. Or a HTTP network stream or file.}}

	{{FuncReturnValue\|Returns '''~~true~~''' on ~~success~~.}}		{{FuncReturnValue\|Returns the sound identifier. Returns '''false''' on error. Once the playback has finished the sound identifier will be destroyed automatically.}}

	== Example ==		== Example ==

BlueMountains at 11:35, 23 October 2019

2019-10-23T11:35:35Z

← Older revision		Revision as of 11:35, 23 October 2019
Line 1:		Line 1:
	{{Info\|Function\|Client\|1.0}}		{{Info\|Function\|Client\|1.0}}

	{{FuncDescription\|~~__EDIT_ME__~~}}		{{FuncDescription\|Plays a local audio file or over http. Also supports playing .pls network streams.}}

	{{FuncSyntax\|CreateSound(SoundFile)}}		{{FuncSyntax\|CreateSound(SoundFile)}}

	{{FuncParameters}}		{{FuncParameters}}
	{{FuncParam\|SoundFile \|~~__EDIT_ME__~~}}		{{FuncParam\|SoundFile\|The path to the file to play. Or a HTTP network stream or file.}}

	{{FuncReturnValue\|~~__EDIT_ME__~~}}		{{FuncReturnValue\|Returns '''true''' on success.}}

	== Example ==		== Example ==

BlueMountains at 14:29, 22 October 2019

2019-10-22T14:29:03Z

← Older revision		Revision as of 14:29, 22 October 2019
Line 3:		Line 3:
	{{FuncDescription\|__EDIT_ME__}}		{{FuncDescription\|__EDIT_ME__}}

	{{FuncSyntax\|CreateSound(SoundFile ~~[, bLoop]~~)}}		{{FuncSyntax\|CreateSound(SoundFile)}}

	{{FuncParameters}}		{{FuncParameters}}
	{{FuncParam\|SoundFile \|__EDIT_ME__}}		{{FuncParam\|SoundFile \|__EDIT_ME__}}
	~~{{FuncParamOptional\|bLoop\|__EDIT_ME__}}~~

	{{FuncReturnValue\|__EDIT_ME__}}		{{FuncReturnValue\|__EDIT_ME__}}

BlueMountains: Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME}} {{FuncSyntax|CreateSound(SoundFile [, bLoop])}} {{FuncParameters}} {{FuncParam|SoundFile |EDIT_ME__}} {{FuncP..."

2019-03-22T11:22:21Z

Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|CreateSound(SoundFile [, bLoop])}} {{FuncParameters}} {{FuncParam|SoundFile |__EDIT_ME__}} {{FuncP..."

New page

{{Info|Function|Client|1.0}}

{{FuncDescription|__EDIT_ME__}}

{{FuncSyntax|CreateSound(SoundFile [, bLoop])}}

{{FuncParameters}}
{{FuncParam|SoundFile |__EDIT_ME__}}
{{FuncParamOptional|bLoop|__EDIT_ME__}}

{{FuncReturnValue|__EDIT_ME__}}

== Example ==
__EDIT_ME__

{{RelatedFunctions}}
__EDIT_ME__