matrix-js-sdk
    Preparing search index...

    Type Alias LivekitGetTokenRequest

    The body of a request to the LiveKit get_token endpoint (MSC4195).

    Declared as a type alias rather than an interface so that it can be passed to the widget API (MSC4533), which expects request data to be assignable to an index signature.

    type LivekitGetTokenRequest = {
        member: LivekitRtcMember;
        room_id: string;
        server_name?: string;
        slot_id: string;
        url: string;
    }
    Index
    member room_id server_name? slot_id url
    member: LivekitRtcMember

    The MatrixRTC membership to obtain a token for.

    room_id: string

    The room ID of the Matrix room the m.rtc.member event is in.

    server_name?: string

    The server name of the m.rtc.member event's sender. If omitted, the homeserver uses its own server name. This is what makes it possible to obtain a token for an SFU of a remote homeserver.

    slot_id: string

    The slot ID from the m.rtc.member event.

    url: string

    The WebSocket URL of the LiveKit SFU to obtain a token for.

    Settings
    Member Visibility

    On This Page
    Properties