Class LocalParticipant

audioTrackPublications

trackPublications

videoTrackPublications

isE2EEEnabled

• get isE2EEEnabled(): boolean

• Returns boolean

isLocal

• get isLocal(): boolean

• Returns boolean

lastCameraError

• get lastCameraError(): undefined | Error

• Returns undefined | Error

lastMicrophoneError

• get lastMicrophoneError(): undefined | Error

• Returns undefined | Error

createScreenTracks

• createScreenTracks(options?): Promise<LocalTrack<Kind>[]>

• 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.

  Parameters

  • Optionaloptions: ScreenShareCaptureOptions

  Returns Promise<LocalTrack<Kind>[]>

createTracks

• createTracks(options?): Promise<LocalTrack<Kind>[]>

• Create local camera and/or microphone tracks

  Parameters

  • Optionaloptions: CreateLocalTracksOptions

  Returns Promise<LocalTrack<Kind>[]>

enableCameraAndMicrophone

• enableCameraAndMicrophone(): Promise<void>

• Publish both camera and microphone at the same time. This is useful for displaying a single Permission Dialog box to the end user.

  Returns Promise<void>

getTrackPublication

• getTrackPublication(source): undefined | LocalTrackPublication

• Finds the first track that matches the source filter, for example, getting the user's camera track with getTrackBySource(Track.Source.Camera).

  Parameters

  • source: Source

  Returns undefined | LocalTrackPublication

getTrackPublicationByName

• getTrackPublicationByName(name): undefined | LocalTrackPublication

• Finds the first track that matches the track's name.

  Parameters

  • name: string

  Returns undefined | LocalTrackPublication

publishData

• publishData(data, options?): Promise<void>

• Publish a new data payload to the room. Data will be forwarded to each participant in the room if the destination field in publishOptions is empty

  Parameters

  • data: Uint8Array

    Uint8Array of the payload. To send string data, use TextEncoder.encode
  • options: DataPublishOptions = {}

    optionally specify a reliable, topic and destination

  Returns Promise<void>

publishTrack

• publishTrack(track, options?): Promise<LocalTrackPublication>

• Publish a new track to the room

  Parameters

  • track: MediaStreamTrack | LocalTrack<Kind>
  • Optionaloptions: TrackPublishOptions

  Returns Promise<LocalTrackPublication>

republishAllTracks

• republishAllTracks(options?, restartTracks?): Promise<void>

• Parameters

  • Optionaloptions: TrackPublishOptions
  • restartTracks: boolean = true

  Returns Promise<void>

setAttributes

• setAttributes(attributes): Promise<void>

• Set or update participant attributes. It will make updates only to keys that are present in attributes, and will not override others. Note: this requires canUpdateOwnMetadata permission.

  Parameters

  • attributes: Record<string, string>

    attributes to update

  Returns Promise<void>

setCameraEnabled

• setCameraEnabled(enabled, options?, publishOptions?): Promise<undefined | LocalTrackPublication>

• Enable or disable a participant's camera track.

  If a track has already published, it'll mute or unmute the track. Resolves with a LocalTrackPublication instance if successful and undefined otherwise

  Parameters

  • enabled: boolean
  • Optionaloptions: VideoCaptureOptions
  • OptionalpublishOptions: TrackPublishOptions

  Returns Promise<undefined | LocalTrackPublication>

setMetadata

• setMetadata(metadata): Promise<void>

• Sets and updates the metadata of the local participant. Note: this requires canUpdateOwnMetadata permission. method will throw if the user doesn't have the required permissions

  Parameters

  • metadata: string

  Returns Promise<void>

setMicrophoneEnabled

• setMicrophoneEnabled(enabled, options?, publishOptions?): Promise<undefined | LocalTrackPublication>

• Enable or disable a participant's microphone track.

  If a track has already published, it'll mute or unmute the track. Resolves with a LocalTrackPublication instance if successful and undefined otherwise

  Parameters

  • enabled: boolean
  • Optionaloptions: AudioCaptureOptions
  • OptionalpublishOptions: TrackPublishOptions

  Returns Promise<undefined | LocalTrackPublication>

setName

• setName(name): Promise<void>

• Sets and updates the name of the local participant. Note: this requires canUpdateOwnMetadata permission. method will throw if the user doesn't have the required permissions

  Parameters

  • name: string

  Returns Promise<void>

setScreenShareEnabled

• setScreenShareEnabled(enabled, options?, publishOptions?): Promise<undefined | LocalTrackPublication>

• Start or stop sharing a participant's screen Resolves with a LocalTrackPublication instance if successful and undefined otherwise

  Parameters

  • enabled: boolean
  • Optionaloptions: ScreenShareCaptureOptions
  • OptionalpublishOptions: TrackPublishOptions

  Returns Promise<undefined | LocalTrackPublication>

setTrackSubscriptionPermissions

• setTrackSubscriptionPermissions(allParticipantsAllowed, participantTrackPermissions?): void

• 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.

  Parameters

  • allParticipantsAllowed: boolean

    Allows all participants to subscribe all tracks. Takes precedence over [[participantTrackPermissions]] if set to true. By default this is set to true.
  • participantTrackPermissions: ParticipantTrackPermission[] = []

    Full list of individual permissions per participant/track. Any omitted participants will not receive any permissions.

  Returns void

unpublishTrack

• unpublishTrack(track, stopOnUnpublish?): Promise<undefined | LocalTrackPublication>

• Parameters

  • track: MediaStreamTrack | LocalTrack<Kind>
  • OptionalstopOnUnpublish: boolean

  Returns Promise<undefined | LocalTrackPublication>

unpublishTracks

• unpublishTracks(tracks): Promise<LocalTrackPublication[]>

• Parameters

  • tracks: MediaStreamTrack[] | LocalTrack<Kind>[]

  Returns Promise<LocalTrackPublication[]>