OnClientSoundStream: Difference between revisions
Jump to navigation
Jump to search
(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…') |
No edit summary |
||
| 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) | ||
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}} | ||
Revision as of 07:13, 28 June 2012
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 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 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 ... milliseconds.", 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.."ms.")
end)
See Also
Client player events
- onClientSoundBeat
- onClientSoundChangedMeta
- onClientSoundFinishedDownload
- onClientSoundStarted
- onClientSoundStopped
- onClientSoundStream
Client event functions
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled