Interface RoomConnectOptions

Options for Room.connect()

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

Hierarchy

  • Partial<InternalRoomConnectOptions>
    • RoomConnectOptions

Properties

autoSubscribe? maxRetries? peerConnectionTimeout? rtcConfig? websocketTimeout?

Properties

Optional autoSubscribe

autoSubscribe?: boolean

autosubscribe to room tracks after joining, defaults to true

Optional maxRetries

maxRetries?: number

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

Optional peerConnectionTimeout

peerConnectionTimeout?: number

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

Optional rtcConfig

rtcConfig?: RTCConfiguration

use to override any RTCConfiguration options.

Optional websocketTimeout

websocketTimeout?: number

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

Settings

Member Visibility

Theme

On This Page

autoSubscribemaxRetriespeerConnectionTimeoutrtcConfigwebsocketTimeout

Generated using TypeDoc