Member Junction
    Preparing search index...

    Controls a single LiveKit room: connect/disconnect, local-media toggles, data messages, device switching, and a normalized observable state snapshot. One controller == one room connection.

    Index

    Constructors

    Properties

    The room's cancelable event bus (Before-events + notifications). Subscribe with Events.On(...); the Angular layer re-surfaces these as @Output() emitters. See LiveKitRoomEventBus.

    Accessors

    Methods

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

      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>

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

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

    • Enumerates available media devices of a given kind.

      Parameters

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

        The device kind to enumerate.

      Returns Promise<LiveKitDevice[]>

      The available devices.

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

    • Enables or disables the local camera.

      Parameters

      • enabled: boolean

      Returns Promise<void>

    • Enables or disables the local microphone.

      Parameters

      • enabled: boolean

      Returns Promise<void>

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

    • Starts or stops local screen sharing.

      Parameters

      • enabled: boolean

      Returns 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>

    • Toggles the microphone and returns the new state.

      Returns Promise<boolean>

    • Toggles screen sharing and returns the new state.

      Returns Promise<boolean>