LiveKit JS Client SDK - v2.11.1

    Interface RoomConnectOptions

    Options for Room.connect()

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

    Hierarchy

    • Partial<InternalRoomConnectOptions>
      • RoomConnectOptions
    Index

    Properties

    autoSubscribe? maxRetries? peerConnectionTimeout? rtcConfig? websocketTimeout?

    Properties

    autoSubscribe?: boolean

    autosubscribe to room tracks after joining, defaults to true

    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.

    websocketTimeout?: number

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

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR