client assigned identity, encoded in JWT token
if participant is currently speaking
client metadata, opaque to livekit
client assigned display name, encoded in JWT token
server assigned unique id
map of track sid => all published tracks
when participant joined the room
Creates a screen capture tracks with getDisplayMedia(). A LocalVideoTrack is always created and returned. If { audio: true }, and the browser supports audio capture, a LocalAudioTrack is also created.
Create local camera and/or microphone tracks
Publish both camera and microphone at the same time. This is useful for displaying a single Permission Dialog box to the end user.
Publish a new data payload to the room. Data will be forwarded to each participant in the room if the destination argument is empty
Uint8Array of the payload. To send string data, use TextEncoder.encode
whether to send this as reliable or lossy. For data that you need delivery guarantee (such as chat messages), use Reliable. For data that should arrive as quickly as possible, but you are ok with dropped packets, use Lossy.
the participants who will receive the message
Publish a new track to the room
Enable or disable a participant's camera track.
If a track has already published, it'll mute or unmute the track.
Enable or disable a participant's microphone track.
If a track has already published, it'll mute or unmute the track.
Start or stop sharing a participant's screen
Control who can subscribe to LocalParticipant's published tracks.
By default, all participants can subscribe. This allows fine-grained control over who is able to subscribe at a participant and track level.
Note: if access is given at a track-level (i.e. both [allParticipantsAllowed] and [ParticipantTrackPermission.allTracksAllowed] are false), any newer published tracks will not grant permissions to any participants and will require a subsequent permissions update to allow subscription.
Allows all participants to subscribe all tracks. Takes precedence over [[participantTrackPermissions]] if set to true. By default this is set to true.
Full list of individual permissions per participant/track. Any omitted participants will not receive any permissions.
Generated using TypeDoc
audio level between 0-1.0, 1 being loudest, 0 being softest