A map of all audio tracks on this participant
A unique connection id generated every time a participant connects to a space
The display name of the participant
The unique participant id derived from the participant_id
field in the JWT
The role for this participant in the space. This can be specified by the role field in the JWT.
If none is specificed, the default is ParticipantRole.Publisher
A map of all video tracks on this participant
getAudioTracks returns all audio tracks for a participant
getTracks returns all (video and audio) tracks for a participant
getVideoTracks returns all video tracks for a participant
Publishes a string payload to the space. Emits SpaceEvent.ParticipantCustomEventPublished and ParticipantEvent.CustomEventPublished events upon successfully completing the publish request to the space.
publishTracks publishes an array of LocalTrack to the space
Sets the display name of the local particpant Emits SpaceEvent.ParticipantDisplayNameChanged and ParticipantEvent.DisplayNameChanged events upon successfully setting the display name.
unpublishAllTracks unpublishes all media for a LocalParticipant
Options for unpublishing tracks
Whether to stop tracks that are unpublished
unpublishTracks unpublishes a list of tracks from the space
Options for unpublishing tracks
Whether to stop tracks that are unpublished
updateTracks updates an array of LocalTrack based on TrackSource. This replaces the underlying media being sent to the space without the need to unpublish and republish tracks. This should be used with getDisplayMedia to update a camera or microphone input.
Note: If you pass a track source that isn't already published it will not be updated. For example, say you are publishing a Camera source but not a Microphone source. If you pass in a track with a source of TrackSource.Microphone nothing will happen.
all LocalTracks that were sucessfully updated
Generated using TypeDoc
A LocalParticipant is the local peer connected to the space. Local participants can emit ParticipantEvent to allow you to respond to state updates.