Difference between revisions of "OnClientSoundStream"

From Multi Theft Auto: Wiki
Jump to: navigation, search
(Parameters)
(Example)
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>

Revision as of 05:42, 29 December 2016

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

bool success, int length, string streamName
  • success: A boolean indicating whether the stream was a success or not
  • 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

Source

The source of this event is the sound which either successfully streamed or failed to stream.

Example

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".

addEventHandler("onClientSoundStream",root,function(suc,length,streamN)
	if not suc then outputChatBox("Sound: "..streamN.." failed to start.",100,0,0) return end
	outputChatBox("The sound: "..streamN.." has finished in "..length.."secs.")
end)

See Also

Client player events


Client event functions