LiveKit JS Client SDK - v2.22.4
    Preparing search index...

    Interface RoomConnectOptions

    Options for Room.connect()

    interface RoomConnectOptions {
        autoSubscribe?: boolean;
        disableIceLite?: boolean;
        maxRetries?: number;
        peerConnectionTimeout?: number;
        rtcConfig?: RTCConfiguration;
        subscriberAllowPause?: boolean;
        websocketTimeout?: number;
    }

    Hierarchy

    • Partial<InternalRoomConnectOptions>
      • RoomConnectOptions
    Index
    autoSubscribe? disableIceLite? maxRetries? peerConnectionTimeout? rtcConfig? subscriberAllowPause? websocketTimeout?
    autoSubscribe?: boolean

    autosubscribe to room tracks after joining, defaults to true

    disableIceLite?: boolean

    when the server runs ICE lite, asks it to use a full ICE agent for this participant. this is a server-side setting that the server may ignore, defaults to false

    maxRetries?: number

    specifies how often an initial join connection is allowed to retry (only applicable if server is not reachable)

    peerConnectionTimeout?: number

    amount of time for PeerConnection to be established, defaults to 15s

    rtcConfig?: RTCConfiguration

    use to override any RTCConfiguration options.

    subscriberAllowPause?: boolean

    whether the SFU may pause subscribed video tracks when this participant's downstream connection is congested, so that other tracks can continue to stream smoothly. paused tracks resume automatically when conditions allow, and RoomEvent.TrackStreamStateChanged fires on each transition. when left undefined, the server's default applies (the project setting on LiveKit Cloud, or rtc.congestion_control.allow_pause when self-hosting)

    websocketTimeout?: number

    amount of time for Websocket connection to be established, defaults to 15s

    Settings
    Member Visibility

    On This Page
    Properties