@not3/sdk
    Preparing search index...

    Interface ClientOptions

    interface ClientOptions {
        baseUrl: string;
        password?: string;
        rtc?: RTCFactory;
        webSocket?: {
            CLOSED: 3;
            CLOSING: 2;
            CONNECTING: 0;
            OPEN: 1;
            prototype: WebSocket;
            new (url: string | URL, protocols?: string | string[]): WebSocket;
        };
    }
    Index
    baseUrl password? rtc? webSocket?
    baseUrl: string

    The base URL of the API with a trailing slash.

    'https://api.example.com/'
    password?: string

    The instance password of the api. Only required if the API runs in private mode.

    'password'

    undefined
    rtc?: RTCFactory

    A factory creating RTCPeerConnection instances, used by the P2P transfer classes. Defaults to the global RTCPeerConnection; supply your own in runtimes without one (for example node-datachannel in Node).

    (config) => new globalThis.RTCPeerConnection(config)
    webSocket?: {
        CLOSED: 3;
        CLOSING: 2;
        CONNECTING: 0;
        OPEN: 1;
        prototype: WebSocket;
        new (url: string | URL, protocols?: string | string[]): WebSocket;
    }

    The WebSocket constructor used to reach the signaling gateway. Defaults to the global WebSocket (native in browsers and Node >= 22).

    globalThis.WebSocket

    Settings
    Member Visibility

    On This Page
    Properties