Interface ClientConfigObject

Represents the configuration object for the client.

The ClientConfig class provides a convenient way to configure the client by specifying various properties. These properties control different aspects of the client's behavior, such as API URLs, media reoffer, and WebSocket settings.

Example

[[include:snippet_SetClientConfig.txt]]
interface ClientConfigObject {
    apiUrl?: Nullable<string>;
    autoReconnectMedia?: Nullable<boolean>;
    region?: null | CoreClientConfigRegionJS | "AP" | "EU" | "US";
    rtcStatsTelemetry?: Nullable<boolean>;
    websocketPath?: Nullable<string>;
    websocketUrl?: Nullable<string>;
}

Properties

apiUrl?: Nullable<string>

The API URL of your chosen datacenter, if set overrides default from region

autoReconnectMedia?: Nullable<boolean>

Allow the sdk to automatically reconnect media when network interface changes

region?: null | CoreClientConfigRegionJS | "AP" | "EU" | "US"

The Vonage datacenter to use

rtcStatsTelemetry?: Nullable<boolean>

Allow users to enable RTCStats

websocketPath?: Nullable<string>

The Path component appended to the Websocket URL

websocketUrl?: Nullable<string>

The WebSocket URL of your chosen datacenter, if set overrides default from region