Skip to main content
Version: v1.19.0

RemoteStageStreamEvents

A enumeration of RemoteStageStream events which can be provided to the stream.on or stream.off methods.

Enumeration Members

ADAPTION_CHANGED

ADAPTION_CHANGED: "ADAPTION_CHANGED"

The ADAPTION_CHANGED event is emitted whenever the server changes from dynamic to manual adaption. Dynamic adaption means that the server will choose the optimal layer for the device based on network conditions, whereas manual adaption is what the application chooses via StageStrategy.preferredLayerForStream.

Param

boolean


LAYER_SELECTED

LAYER_SELECTED: "LAYER_SELECTED"

The LAYER_SELECTED event is emitted when either the server selects a layer when in dynamic adaption mode, or when the application selects one via the StageStrategy.preferredLayerForStream.

To determine the source of the selection, refer to the ADAPTION_CHANGED event, or the RemoteStageStream.isAdapting getter.

Param

StageStreamLayer, StageStreamLayerSelectedReason


LAYERS_CHANGED

LAYERS_CHANGED: "LAYERS_CHANGED"

The LAYERS_CHANGED event is emitted any time the list of available StageStreamLayers changes. This could be the number of layers, or individual properties like whether a new layer has been selected.

This event can fire every couple of seconds if many selections are being made either from the application, or the publishers network is unreliable causing some layers to become inactive.

Param

StageStreamLayer[]