1. References
  2. VoxEngine
  3. StreamingAgentEvents
Rate this page:

StreamingAgentEvents

Add the following line to your scenario code to use the events:

require(Modules.StreamingAgent);

Constants

AudioStreamCreated

Copy URL

Event is triggered when there is audio data in a stream.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamName:

    string

    Stream name of a streaming object that triggered the event.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

Connected

Copy URL

Event is triggered when a streaming object is connected to a streaming platform.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

ConnectionFailed

Copy URL

Event is triggered when connection to a streaming platform is failed.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

Disconnected

Copy URL

Event is triggered when a streaming object is disconnected from a streaming platform.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

Error

Copy URL

Event is triggered if a streaming object couldn't be created, e.g., due to incorrect serverUrl.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

StreamError

Copy URL

Event is triggered when a streaming object caused an error, e.g., due to a codec mismatch.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamName:

    string

    Stream name of a streaming object that triggered the event.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

StreamStarted

Copy URL

Event is triggered when a stream is successfully started.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamName:

    string

    Stream name of a streaming object that triggered the event.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

StreamStopped

Copy URL

Event is triggered when a stream is stopped.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamName:

    string

    Stream name of a streaming object that triggered the event.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.

VideoStreamCreated

Copy URL

Event is triggered when there is video data in a stream.

Parameters

  • reason:

    string

    Optional

    Event triggering details.

  • streamName:

    string

    Stream name of a streaming object that triggered the event.

  • streamingAgent:

    StreamingAgent

    Streaming object that triggered the event.