SpaceEvent

Events that are emitted by a Space instance.

Enumeration Members

`AudioInitialized`

When the audio renderer is ready.

Value

audioInitialized

`AudioObjectAdded`

A new audio object has been added to the space.

Value

audioObjectAdded

`AudioObjectRemoved`

An audio object has been removed from the space.

Value

audioObjectRemoved

`LocalTrackPublished`

A local track was published successfully. This event is helpful to know when to update your local UI with the newly published track.

Provides: (LocalTrackPublication, LocalParticipant, Room)

Value

localTrackPublished

`LocalTrackUnpublished`

A local track was unpublished. This event is helpful to know when to remove the local track from your UI.

When a user stops sharing their screen by pressing "End" on the browser UI, this event will also fire.

Provides: (LocalTrackPublication, LocalParticipant, Room)

Value

localTrackUnpublished

`ParticipantConnected`

When a RemoteParticipant joins after the local participant. It will not emit events for participants that are already in the room

Provides: (RemoteParticipant, Room)

Value

participantConnected

`ParticipantDisconnected`

When a RemoteParticipant leaves after the local participant has joined.

Provides: (RemoteParticipant, Room)

Value

participantDisconnected

`RoomAdded`

When a new room is added to the space.

Provides: (Room)

Value

roomAdded

`RoomConnected`

When the connection to the server has been established

Provides: (Room)

Value

roomConnected

`RoomDisconnected`

When disconnected from room. This fires when room.disconnect() is called or when an unrecoverable connection issue had occured

Provides: (Room)

Value

roomDisconnected

`RoomReconnected`

Fires when a reconnection has been successful.

Provides: (Room)

Value

roomReconnected

`RoomReconnecting`

When the connection to the server has been interrupted and it's attempting to reconnect.

Provides: (Room)

Value

roomReconnecting

`RoomRemoved`

When a room is removed from the space.

Provides: (Room)

Value

roomRemoved

`VideoPublished`

When a new video track is published to room after the local participant has joined. It will not fire for video tracks that are already published.

A video track published doesn't mean the participant has subscribed to it. It's simply reflecting the state of the room.

Provides: (RemoteTrackPublication, RemoteParticipant, Room)

Value

videoPublished

`VideoSubscribed`

The LocalParticipant has subscribed to a new video track. This event will always fire as long as new video tracks are ready for use.

Provides: (RemoteVideoTrack, RemoteTrackPublication, RemoteParticipant, Room)

Value

videoSubscribed

`VideoSubscriptionFailed`

Could not subscribe to a video track

Provides: (track sid, RemoteParticipant)

Value

videoSubscriptionFailed

`VideoUnpublished`

A RemoteParticipant has unpublished a video track

Provides: (RemoteTrackPublication, RemoteParticipant)

Value

videoUnpublished

`VideoUnsubscribed`

A subscribed video track is no longer available. Clients should listen to this event and ensure they detach tracks.

Provides: (RemoteVideoTrack, RemoteTrackPublication, RemoteParticipant)

Value

videoUnsubscribed

RoomEvent Track.Kind