Interface ISDKOptions

Options to configure the SDK.

interface ISDKOptions {
    audioContext?: AudioContext;
    disableIntervalHack?: boolean;
    keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
    loggingConnectors?: ILoggingConnector[];
    maxBpp?: number;
    maxConnections?: number;
    maxDistance?: number;
    maxFps?: number;
    maxOutgoingSubscriptions?: number;
    minConnections?: number;
    objectStoreConnector?: ObjectStoreConnectorConstructor;
    peerConnectionConnector?: PeerConnectionConnectorConstructor;
}

Properties

audioContext? disableIntervalHack? keyValueDatabaseConnector? loggingConnectors? maxBpp? maxConnections? maxDistance? maxFps? maxOutgoingSubscriptions? minConnections? objectStoreConnector? peerConnectionConnector?

Properties

Optional audioContext

audioContext?: AudioContext

The audio context to use for audio processing.

Optional disableIntervalHack

disableIntervalHack?: boolean

The flag to disable the interval hack that ensures the intervals run at the correct time.

Optional keyValueDatabaseConnector

keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor

The custom key-value database connector to use for storing key-value pairs. If not provided, the default key-value database connector is IndexedDB.

Optional loggingConnectors

loggingConnectors?: ILoggingConnector[]

The custom logging connector to use for logging events.

Optional maxBpp

maxBpp?: number

The maximum bits per pixel to use for video.

Optional maxConnections

maxConnections?: number

The maximum number of connections a node can have.

Optional maxDistance

maxDistance?: number

The maximum distance allowed between two nodes in the network.

Optional maxFps

maxFps?: number

The maximum frame rate to use for video.

Optional maxOutgoingSubscriptions

maxOutgoingSubscriptions?: number

The maximum number of outgoing subscriptions.

Optional minConnections

minConnections?: number

The minimum number of initial connections.

Optional objectStoreConnector

objectStoreConnector?: ObjectStoreConnectorConstructor

The custom object store connector to use for storing objects. If not provided, the default object store connector is OPFS.

Optional peerConnectionConnector

peerConnectionConnector?: PeerConnectionConnectorConstructor

The custom peer connection connector to use for creating peer connections. If not provided, the default peer connection connector is WebRTC in browser.

Settings

Member Visibility

Theme

On This Page

audioContextdisableIntervalHackkeyValueDatabaseConnectorloggingConnectorsmaxBppmaxConnectionsmaxDistancemaxFpsmaxOutgoingSubscriptionsminConnectionsobjectStoreConnectorpeerConnectionConnector

Generated using TypeDoc