Class LiveKitRoomController

constructor

• new LiveKitRoomController(
      options?: LiveKitRoomControllerOptions,
  ): LiveKitRoomController

  Parameters

  • options: LiveKitRoomControllerOptions = {}

  Returns LiveKitRoomController

ReadonlyEvents

State

• get State(): LiveKitRoomState

  The current room-state snapshot (synchronous).

  Returns LiveKitRoomState

State$

• get State$(): Observable<LiveKitRoomState>

  The normalized room-state snapshot. Emits the current value on subscribe, then on every change.

  Returns Observable<LiveKitRoomState>

Status

• get Status(): LiveKitConnectionStatus

  The current connection status (synchronous convenience).

  Returns LiveKitConnectionStatus

ChangeScreenShare

• ChangeScreenShare(
      request?: DisplayCaptureSurface | DisplayCaptureOptions,
  ): Promise<void>

  Shares something else: stops the current share, then asks the browser's picker again, with request as for SetScreenShareEnabled. Others see the share end and start again; a user who cancels the picker is left not sharing. With no share running, it just starts one.

  Parameters

  • Optionalrequest: DisplayCaptureSurface | DisplayCaptureOptions

  Returns Promise<void>

Connect

• Connect(
      serverUrl: string,
      token: string,
      options?: LiveKitRoomConnectOptions,
  ): Promise<void>

  Connects to a LiveKit room and brings the local participant online with the requested media.

  Only the connection can fail the join: then it rejects, the status is 'error' and a connect error is emitted. The microphone and camera are turned on once connected, each on its own; one that fails (the browser refused it, or it is in use) is left off and reported as a device error, and the join goes on, so the user is in the room and can turn it on again. If the user leaves while a device starts (the browser's permission prompt can stay open a while), no other device starts and no connected is emitted.

  Parameters

  • serverUrl: string

    The LiveKit server URL (e.g. wss://livekit.myorg.com).

  • token: string

    The signed access token authorizing this participant to join a specific room.

  • options: LiveKitRoomConnectOptions = {}

    Initial media + display-name options.

  Returns Promise<void>

Disconnect

• Disconnect(userInitiated?: boolean): Promise<boolean>

  Disconnects from the room and releases all resources. Safe to call when not connected.

  Parameters

  • userInitiated: boolean = true

    Whether the user requested the leave (raises a cancelable beforeDisconnect). Internal reconnect cycles pass false to skip the veto hook. Defaults to true.

  Returns Promise<boolean>

  true if the disconnect proceeded, false if a beforeDisconnect handler canceled it.

Dispose

• Dispose(): void

  Disposes the controller, tears down the connection, and clears all subscribers.

  Returns void

GetActiveDeviceId

• GetActiveDeviceId(
      kind: "audioinput" | "videoinput" | "audiooutput",
  ): string | null

  Returns the deviceId of the currently-active device for a given kind, or null when no room is connected or the active device is unknown. Used by hosts to pre-select the active device in a device-picker UI.

  Parameters

  • kind: "audioinput" | "videoinput" | "audiooutput"

    The device kind to query.

  Returns string | null

  The active deviceId, or null if unavailable.

ListDevices

• ListDevices(
      kind: "audioinput" | "videoinput" | "audiooutput",
  ): Promise<LiveKitDevice[]>

  Enumerates available media devices of a given kind.

  Parameters

  • kind: "audioinput" | "videoinput" | "audiooutput"

    The device kind to enumerate.

  Returns Promise<LiveKitDevice[]>

  The available devices.

SendData

• SendData(text: string, topic?: string): Promise<boolean>

  Sends a text message on the LiveKit data channel (reliable publish to all participants).

  Parameters

  • text: string

    The message text.

  • Optionaltopic: string

    Optional topic to publish under (for routing on the receiving side).

  Returns Promise<boolean>

  true once LiveKit sent the message (while LiveKit reconnects, it holds the message and sends it when the session resumes); false when it was not sent: no room, a beforeSendData handler canceled it, or the publish failed, which is also raised as an error of kind data.

SetBackgroundEffect

• SetBackgroundEffect(effect: LiveKitBackgroundEffect): Promise<boolean>

  Applies a camera background effect (blur / virtual background), or clears it with { Kind: 'none' }.

  Parameters

  • effect: LiveKitBackgroundEffect

    The effect to apply.

  Returns Promise<boolean>

  true if applied; false if the SDK is unavailable or no camera track exists.

SetCameraEnabled

• SetCameraEnabled(enabled: boolean): Promise<void>

  Enables or disables the local camera.

  Parameters

  • enabled: boolean

  Returns Promise<void>

SetMicrophoneEnabled

• SetMicrophoneEnabled(enabled: boolean): Promise<void>

  Enables or disables the local microphone.

  Parameters

  • enabled: boolean

  Returns Promise<void>

SetNoiseFilterEnabled

• SetNoiseFilterEnabled(enabled: boolean): Promise<boolean>

  Enables/disables the Krisp noise filter on the local microphone (LiveKit Cloud).

  Parameters

  • enabled: boolean

    Whether the filter should be on.

  Returns Promise<boolean>

  true if applied; false if unsupported or the SDK is unavailable.

SetScreenShareEnabled

• SetScreenShareEnabled(
      enabled: boolean,
      request?: DisplayCaptureSurface | DisplayCaptureOptions,
  ): Promise<void>

  Starts or stops local screen sharing, through /media display capture published as this participant's screen share (capped at 1080p and 30 fps, as LiveKit's own capture is). request is the kind of surface the browser's picker offers first (Chromium reads it; the user can still pick another kind), or the share's options: one panel of the page to share alone (Panel, Chrome and Edge), with its name (PanelLabel). A picker the user closes shares nothing and is no error; a share the browser refuses is a device error.

  Parameters

  • enabled: boolean
  • Optionalrequest: DisplayCaptureSurface | DisplayCaptureOptions

  Returns Promise<void>

StartAudio

• StartAudio(): Promise<void>

  Resumes audio playback after a browser autoplay block (must be called from a user-gesture handler). Clears LiveKitRoomState.AudioPlaybackBlocked on success.

  Returns Promise<void>

SwitchDevice

• SwitchDevice(
      kind: "audioinput" | "videoinput" | "audiooutput",
      deviceId: string,
  ): Promise<void>

  Switches the active device for a given kind.

  Parameters

  • kind: "audioinput" | "videoinput" | "audiooutput"

    The device kind to switch.

  • deviceId: string

    The deviceId to switch to.

  Returns Promise<void>

ToggleCamera

• ToggleCamera(): Promise<boolean>

  Toggles the camera and returns the new state.

  Returns Promise<boolean>

ToggleMicrophone

• ToggleMicrophone(): Promise<boolean>

  Toggles the microphone and returns the new state.

  Returns Promise<boolean>

ToggleScreenShare

• ToggleScreenShare(): Promise<boolean>

  Toggles screen sharing and returns the new state.

  Returns Promise<boolean>