Class Room

constructor

• new Room(options?): Room

• Creates a new Room, the primary construct for a LiveKit session.

  Parameters

  • Optional options: RoomOptions

  Returns Room

activeSpeakers

isE2EEEnabled

localParticipant

options

remoteParticipants

state

canPlaybackAudio

• get canPlaybackAudio(): boolean

• Returns true if audio playback is enabled

  Returns boolean

canPlaybackVideo

• get canPlaybackVideo(): boolean

• Returns true if video playback is enabled

  Returns boolean

isRecording

• get isRecording(): boolean

• if the current room has a participant with recorder: true in its JWT grant

  Returns boolean

metadata

• get metadata(): undefined | string

• room metadata

  Returns undefined | string

name

• get name(): string

• user assigned name, derived from JWT token

  Returns string

numParticipants

• get numParticipants(): number

• Returns number

numPublishers

• get numPublishers(): number

• Returns number

connect

• connect(url, token, opts?): Promise<void>

• Parameters

  • url: string
  • token: string
  • Optional opts: RoomConnectOptions

  Returns Promise<void>

disconnect

• disconnect(stopTracks?): Promise<void>

• disconnects the room, emits [[RoomEvent.Disconnected]]

  Parameters

  • stopTracks: boolean = true

  Returns Promise<void>

emit

• emit<E>(event, ...args): boolean

• Type Parameters

  • E extends keyof RoomEventCallbacks

  Parameters

  • event: E
  • Rest ...args: Parameters<RoomEventCallbacks[E]>

  Returns boolean

getActiveDevice

• getActiveDevice(kind): undefined | string

• Parameters

  • kind: MediaDeviceKind

  Returns undefined | string

getParticipantByIdentity

• getParticipantByIdentity(identity): undefined | Participant

• retrieves a participant by identity

  Parameters

  • identity: string

  Returns undefined | Participant

getSid

• getSid(): Promise<string>

• server assigned unique room id. returns once a sid has been issued by the server.

  Returns Promise<string>

prepareConnection

• prepareConnection(url, token?): Promise<void>

• prepareConnection should be called as soon as the page is loaded, in order to speed up the connection attempt. This function will

  • perform DNS resolution and pre-warm the DNS cache
  • establish TLS connection and cache TLS keys

  With LiveKit Cloud, it will also determine the best edge data center for the current client to connect to if a token is provided.

  Parameters

  • url: string
  • Optional token: string

  Returns Promise<void>

setE2EEEnabled

• setE2EEEnabled(enabled): Promise<void>
• Experimental

  Parameters

  • enabled: boolean

  Returns Promise<void>

simulateParticipants

• simulateParticipants(options): Promise<void>
• Experimental

  Allows to populate a room with simulated participants. No actual connection to a server will be established, all state is

  Parameters

  • options: SimulationOptions

  Returns Promise<void>

startAudio

• startAudio(): Promise<void>

• Browsers have different policies regarding audio playback. Most requiring some form of user interaction (click/tap/etc). In those cases, audio will be silent until a click/tap triggering one of the following

  • startAudio
  • getUserMedia

  Returns Promise<void>

startVideo

• startVideo(): Promise<void>

• Returns Promise<void>

switchActiveDevice

• switchActiveDevice(kind, deviceId, exact?): Promise<boolean>

• Switches all active devices used in this room to the given device.

  Note: setting AudioOutput is not supported on some browsers. See setSinkId

  Parameters

  • kind: MediaDeviceKind

    use videoinput for camera track, audioinput for microphone track, audiooutput to set speaker for all incoming audio tracks
  • deviceId: string
  • exact: boolean = false

  Returns Promise<boolean>

Static getLocalDevices

• getLocalDevices(kind?, requestPermissions?): Promise<MediaDeviceInfo[]>

• getLocalDevices abstracts navigator.mediaDevices.enumerateDevices. In particular, it handles Chrome's unique behavior of creating default devices. When encountered, it'll be removed from the list of devices. The actual default device will be placed at top.

  Parameters

  • Optional kind: MediaDeviceKind
  • requestPermissions: boolean = true

  Returns Promise<MediaDeviceInfo[]>

  a list of available local devices