Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SpaceEvent

Events are how spaces give you state updates. You can listen to these events and update your application state accordingly.

Here is how to listen for space events:

space.on(SpaceEvent.ParticipantJoined, (participant) => {})

Learn more about using events here

These are the events emitted by a Space:

Index

Enumeration Members

ActiveSpeakersChanged: "ActiveSpeakersChanged"

When the active speakers in the space has changed and contains all of the current active speakers and their speaking track

args: (Array<ActiveSpeaker>)

BroadcastStateChanged: "BroadcastStateChanged"

When the broadcast state of the space has changed. This is triggered when a broadcast is either started or stopped. True means the space is being broadcast while false means the broadcast has stopped.

args: (boolean)

ParticipantJoined: "ParticipantJoined"

When a new remote participant has joined the space

ParticipantLeft: "ParticipantLeft"

When a remote participant has left the space

ParticipantTrackMuted: "ParticipantTrackMuted"

When a remote participant mutes a track

ParticipantTrackPublished: "ParticipantTrackPublished"

When a remote partcipant has published a new track to the space.

Note: This does not mean you are recieving media yet see

args: (RemoteParticipant, RemoteTrack)

ParticipantTrackSubscribed: "ParticipantTrackSubscribed"

When you have subscribed to a remote participant's track. This means that you have begun receiving media from the associated participant track

ParticipantTrackUnmuted: "ParticipantTrackUnmuted"

When a remote participant unmutes a track

ParticipantTrackUnpublished: "ParticipantTrackUnpublished"

When a participant stops sending a media track. This is triggered when a remote participant stops publishing a track or a remote participant leaves the space.

ParticipantTrackUnsubscribed: "ParticipantTrackUnsubscribed"

When you have stopped receiving media from a remote participant's track. This is triggered when a remote participant stops publishing a track or a remote participant leaves the space.

Generated using TypeDoc