Class LiveKitPreviewRoomController

constructor

• new LiveKitPreviewRoomController(
      options?: LiveKitPreviewRoomOptions,
  ): LiveKitPreviewRoomController

  Parameters

  • options: LiveKitPreviewRoomOptions = {}

  Returns LiveKitPreviewRoomController

ReadonlyEvents

State

• get State(): LiveKitRoomState

  The current room-state snapshot.

  Returns LiveKitRoomState

State$

• get State$(): Observable<LiveKitRoomState>

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

  Returns Observable<LiveKitRoomState>

Status

• get Status(): LiveKitConnectionStatus

  The current connection status.

  Returns LiveKitConnectionStatus

ChangeScreenShare

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

  Shares something else: stops the current share, then opens the browser's picker again, with request as above.

  Parameters

  • Optionalrequest: DisplayCaptureSurface | DisplayCaptureOptions

  Returns Promise<void>

Connect

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

  Joins the preview room: starts your microphone and camera as the options say, on the devices they name, then shows the simulated people, the first one speaking.

  Parameters

  • serverUrl: string

    Reported to beforeConnect handlers; nothing connects to it.

  • _token: string

    Ignored: there is no server to present it to.

  • options: LiveKitRoomConnectOptions = {}

    Your name, the media you start with, and the devices.

  Returns Promise<void>

Disconnect

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

  Leaves the room and frees your devices. A user-initiated leave raises a cancelable beforeDisconnect first.

  Parameters

  • userInitiated: boolean = true

  Returns Promise<boolean>

  false when a beforeDisconnect handler canceled it.

Dispose

• Dispose(): void

  Leaves the room, frees your devices, completes State$ and clears the event bus.

  Returns void

GetActiveDeviceId

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

  The microphone or camera in use (or chosen), or null for speakers and outside the room.

  Parameters

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

  Returns string | null

ListDevices

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

  Your microphones or cameras, while you are in the room. There are no speakers to pick: nothing plays.

  Parameters

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

  Returns Promise<LiveKitDevice[]>

SendData

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

  Raises the cancelable beforeSendData; nobody else is in the room to receive the message. Resolves true unless a handler canceled it or you are not in the room.

  Parameters

  • text: string
  • Optionaltopic: string

  Returns Promise<boolean>

SetAgentVision

• SetAgentVision(on: boolean): void

  Records whether you let agents see your camera and shared screen, as a meeting's server would, and raises localMediaChanged. Outside the room it does nothing.

  Parameters

  • on: boolean

  Returns void

SetBackgroundEffect

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

  Not available in the preview room.

  Parameters

  • _effect: LiveKitBackgroundEffect

  Returns Promise<boolean>

SetCameraEnabled

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

  Turns your camera on or off.

  Parameters

  • enabled: boolean

  Returns Promise<void>

SetMicrophoneEnabled

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

  Turns your microphone on or off.

  Parameters

  • enabled: boolean

  Returns Promise<void>

SetNoiseFilterEnabled

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

  Not available in the preview room.

  Parameters

  • _enabled: boolean

  Returns Promise<boolean>

SetScreenShareEnabled

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

  Starts or stops sharing. request is the kind of surface the browser's picker offers first, or the share's options: one panel of the page to share alone (Panel), with its name (PanelLabel).

  Parameters

  • enabled: boolean
  • Optionalrequest: DisplayCaptureSurface | DisplayCaptureOptions

  Returns Promise<void>

StartAudio

• StartAudio(): Promise<void>

  Nothing to do: the simulated people make no sound, so the browser never blocks it.

  Returns Promise<void>

SwitchDevice

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

  Moves your microphone or camera to another device; raises the cancelable beforeDeviceSwitch first.

  Parameters

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

  Returns Promise<void>

ToggleCamera

• ToggleCamera(): Promise<boolean>

  Toggles your camera and resolves the new state.

  Returns Promise<boolean>

ToggleMicrophone

• ToggleMicrophone(): Promise<boolean>

  Toggles your microphone and resolves the new state.

  Returns Promise<boolean>

ToggleScreenShare

• ToggleScreenShare(): Promise<boolean>

  Toggles sharing your screen and resolves the new state.

  Returns Promise<boolean>