StreamingAgentEvents
Add the following line to your scenario code to use the events:
require(Modules.StreamingAgent);
Constants
AudioStreamCreated
Event is triggered when there is audio data in a stream.
Parameters
streamingAgent:
Streaming object that triggered the event.
trackId:
number
ID of an audio or video track. Equals to -1 if there's no track.
AudioSwitched
Event is triggered when an audio stream is switched.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
trackId:
number
ID of an audio or video track. Equals to -1 if there's no track.
Connected
Event is triggered when a streaming object is connected to a streaming platform.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
ConnectionFailed
Event is triggered when connection to a streaming platform is failed.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
Disconnected
Event is triggered when a streaming object is disconnected from a streaming platform.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
Error
Event is triggered if a streaming object couldn't be created, e.g., due to incorrect serverUrl.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
StreamError
Event is triggered when a streaming object caused an error, e.g., due to a codec mismatch.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamName:
string
Stream name of a streaming object that triggered the event.
streamingAgent:
Streaming object that triggered the event.
StreamStarted
Event is triggered when a stream is successfully started.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamName:
string
Stream name of a streaming object that triggered the event.
streamingAgent:
Streaming object that triggered the event.
StreamStopped
Event is triggered when a stream is stopped.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamName:
string
Stream name of a streaming object that triggered the event.
streamingAgent:
Streaming object that triggered the event.
VideoStreamCreated
Event is triggered when there is video data in a stream.
Parameters
streamingAgent:
Streaming object that triggered the event.
trackId:
number
ID of an audio or video track. Equals to -1 if there's no track.
VideoSwitched
Event is triggered when a video stream is switched.
Parameters
reason:
string
OptionalReason why the stream is switched. Possible values are: "New stream", "Set stream".
streamingAgent:
Streaming object that triggered the event.
trackId:
number
ID of an audio or video track. Equals to -1 if there's no track.