Skip to main content
Version: v1.33.0

StageEvents

Stage events that can be listened to with stage.on and stage.off.

Enumeration Members​

ERROR​

ERROR: "error"

Indicates the stage has encountered an error.

Param​

StageError

STAGE_CONNECTION_STATE_CHANGED​

STAGE_CONNECTION_STATE_CHANGED: "stageConnectionStateChanged"

Invoked when the local connection to the stage has changed.

Param​

StageConnectionState

STAGE_LEFT​

STAGE_LEFT: "stageLeft"

Indicates the stage has been left by the client

Param​

StageLeftReason

STAGE_PARTICIPANT_JOINED​

STAGE_PARTICIPANT_JOINED: "stageParticipantJoined"

Indicates that a remote participant joined the stage.

Param​

StageParticipantInfo

STAGE_PARTICIPANT_LEFT​

STAGE_PARTICIPANT_LEFT: "stageParticipantLeft"

Indicates that a participant left the stage.

Param​

StageParticipantInfo

STAGE_PARTICIPANT_METADATA_CHANGED​

STAGE_PARTICIPANT_METADATA_CHANGED: "stageParticipantMetadataChanged"

Indicates that participant metadata (userId, attributes) has been updated. Fires for local participant after successful token exchange, and for remote participants when updated metadata is received from the server.

Param​

StageParticipantInfo

STAGE_PARTICIPANT_PUBLISH_STATE_CHANGED​

STAGE_PARTICIPANT_PUBLISH_STATE_CHANGED: "stageParticipantPublishStateChanged"

Indicates a change to participant publish state

Param​

StageParticipantInfo, StageParticipantPublishState

STAGE_PARTICIPANT_STREAMS_ADDED​

STAGE_PARTICIPANT_STREAMS_ADDED: "stageParticipantStreamsAdded"

Indicates that a stream(s) have been added for a participant.

Param​

StageParticipantInfo, StageStream[]

STAGE_PARTICIPANT_STREAMS_REMOVED​

STAGE_PARTICIPANT_STREAMS_REMOVED: "stageParticipantStreamsRemoved"

Indicates that a stream(s) have been removed for a participant.

Param​

StageParticipantInfo, StageStream[]

STAGE_PARTICIPANT_SUBSCRIBE_STATE_CHANGED​

STAGE_PARTICIPANT_SUBSCRIBE_STATE_CHANGED: "stageParticipantSubscribeStateChanged"

Indicates a change to participant subscribtion state

Param​

StageParticipantInfo, StageParticipantSubscribeState

STAGE_STREAM_ADAPTION_CHANGED​

STAGE_STREAM_ADAPTION_CHANGED: "stageStreamAdaptionChanged"

Indicates that a stream's adaption state has changed, and whether it will automatically adapt based on network conditions, or be controlled manually based on the preferredLayerForStream values.

Param​

StageParticipantInfo, StageStream, boolean

STAGE_STREAM_LAYER_SELECTED​

STAGE_STREAM_LAYER_SELECTED: "stageStreamLayerSelected"

Indicates that a stream layer has been selected based on the preferredLayerForStream strategy

Param​

StageParticipantInfo, StageStream, StageStreamLayer, StageStreamLayerSelectedReason

STAGE_STREAM_LAYERS_CHANGED​

STAGE_STREAM_LAYERS_CHANGED: "stageStreamLayersChanged"

Indicates that a stream's available layers state has been changed

Param​

StageParticipantInfo, StageStream, StageStreamLayer[]

STAGE_STREAM_MUTE_CHANGED​

STAGE_STREAM_MUTE_CHANGED: "stageStreamMuteChanged"

Indicates that a stream's mute state has changed

Param​

StageParticipantInfo, StageStream

STAGE_STREAM_SEI_MESSAGE_RECEIVED​

STAGE_STREAM_SEI_MESSAGE_RECEIVED: "stageStreamSeiMessageReceived"

Indicates an SEI message was received

Param​

SeiMessage

STAGE_SUBSCRIBER_COUNT_CHANGED​

STAGE_SUBSCRIBER_COUNT_CHANGED: "stageSubscriberCountChanged"

Beta

Indicates that the subscriber count has changed

Param​

number

Last updated on