OnClientSoundStream - Revision history

Zver-CR: Added error parameter

2018-11-20T23:56:46Z

Added error parameter

← Older revision		Revision as of 23:56, 20 November 2018
Line 5:		Line 5:
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool success, int length, string streamName		bool success, int length, string streamName, string errorMessage
	</syntaxhighlight>		</syntaxhighlight>

Line 11:		Line 11:
	*'''length''': The length of the stream in seconds. Always returns '''0''' for a live stream		*'''length''': The length of the stream in seconds. Always returns '''0''' for a live stream
	*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided		*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided
			*'''errorMessage''': A string containing the error message or an empty string if there was no error

	==Source==		==Source==

Tails: /* Example */

2016-12-29T05:42:12Z

Example

← Older revision		Revision as of 05:42, 29 December 2016
Line 16:		Line 16:

	==Example==		==Example==
	This example outputs to the chatbox (if it was a success) "thesoundname has finished in ... ~~milliseconds~~.", if it was not a success then it would output "thesoundname failed to start".		This example outputs to the chatbox (if it was a success) "thesoundname has finished in ... seconds.", if it was not a success then it would output "thesoundname failed to start".
	<syntaxhighlight lang="lua">addEventHandler("onClientSoundStream",root,function(suc,length,streamN)		<syntaxhighlight lang="lua">addEventHandler("onClientSoundStream",root,function(suc,length,streamN)
	if not suc then outputChatBox("Sound: "..streamN.." failed to start.",100,0,0) return end		if not suc then outputChatBox("Sound: "..streamN.." failed to start.",100,0,0) return end
	outputChatBox("The sound: "..streamN.." has finished in "..length.."ms.")		outputChatBox("The sound: "..streamN.." has finished in "..length.."secs.")
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>

Tails: /* Parameters */

2016-12-29T05:41:45Z

Parameters

← Older revision		Revision as of 05:41, 29 December 2016
Line 9:		Line 9:

	*'''success''': A [[boolean]] indicating whether the stream was a success or not		*'''success''': A [[boolean]] indicating whether the stream was a success or not
	*'''length''': The length of the stream in ~~milliseconds~~. Always returns '''0''' for a live stream		*'''length''': The length of the stream in seconds. Always returns '''0''' for a live stream
	*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided		*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided

Jaysds at 07:13, 28 June 2012

2012-06-28T07:13:13Z

← Older revision		Revision as of 07:13, 28 June 2012
Line 16:		Line 16:

	==Example==		==Example==
			This example outputs to the chatbox (if it was a success) "thesoundname has finished in ... milliseconds.", if it was not a success then it would output "thesoundname failed to start".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">addEventHandler("onClientSoundStream",root,function(suc,length,streamN)
	~~--TODO~~		if not suc then outputChatBox("Sound: "..streamN.." failed to start.",100,0,0) return end
			outputChatBox("The sound: "..streamN.." has finished in "..length.."ms.")
			end)
	</syntaxhighlight>		</syntaxhighlight>

Line 26:		Line 28:
	===Client event functions===		===Client event functions===
	{{Client_event_functions}}		{{Client_event_functions}}

	~~[[Category:Needs_Example]]~~

Gamesnert: Created page with 'NOTOC {{Client event}} This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done…'

2010-08-09T16:21:11Z

Created page with '__NOTOC__ {{Client event}} This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done…'

New page

__NOTOC__
{{Client event}}
This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done downloading yet. For live streams, this just means the stream will start playing. This event will also trigger when, for some reason, the streaming failed.

==Parameters==
<syntaxhighlight lang="lua">
bool success, int length, string streamName
</syntaxhighlight>

*'''success''': A [[boolean]] indicating whether the stream was a success or not
*'''length''': The length of the stream in milliseconds. Always returns '''0''' for a live stream
*'''streamName''': The name of the stream. Note that this isn't the filename. Also note that this isn't always provided

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] which either successfully streamed or failed to stream.

==Example==

<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
===Client player events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs_Example]]

OnClientSoundStream - Revision history

Zver-CR: Added error parameter

Tails: /* Example */

Tails: /* Parameters */

Jaysds at 07:13, 28 June 2012

Gamesnert: Created page with '__NOTOC__ {{Client event}} This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done…'

Gamesnert: Created page with 'NOTOC {{Client event}} This event is triggered when a sound has just finished initial streaming. For file streams, this means the sound will now start playing, but isn't done…'