Interface DialWebRTCConf

Options required to dial a robot via WebRTC.

interface DialWebRTCConf {
    credentials?: Credential | AccessToken;
    dialTimeout?: number;
    dialTimeoutMs?: number;
    disableSessions?: boolean;
    extraHeaders?: Record<string, string>;
    host: string;
    iceServers?: ICEServer[];
    noReconnect?: boolean;
    priority?: number;
    reconnectAbortSignal?: { abort: boolean };
    reconnectMaxAttempts?: number;
    reconnectMaxWait?: number;
    serviceHost?: string;
    shouldRetryOnError?: () => boolean;
    signalingAddress: string;
}

Properties

credentials? dialTimeout? dialTimeoutMs? disableSessions? extraHeaders? host iceServers? noReconnect? priority? reconnectAbortSignal? reconnectMaxAttempts? reconnectMaxWait? serviceHost? shouldRetryOnError? signalingAddress

Properties

Optionalcredentials

credentials?: Credential | AccessToken

OptionaldialTimeout

dialTimeout?: number

Set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT. A value of 0 disables the timeout.

Deprecated

Use dialTimeoutMs instead.

OptionaldialTimeoutMs

dialTimeoutMs?: number

Set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT. A value of 0 disables the timeout.

OptionaldisableSessions

disableSessions?: boolean

OptionalextraHeaders

extraHeaders?: Record<string, string>

host

host: string

OptionaliceServers

iceServers?: ICEServer[]

OptionalnoReconnect

noReconnect?: boolean

Optionalpriority

priority?: number

OptionalreconnectAbortSignal

reconnectAbortSignal?: { abort: boolean }

OptionalreconnectMaxAttempts

reconnectMaxAttempts?: number

Default

10.

OptionalreconnectMaxWait

reconnectMaxWait?: number

Default

Number.POSITIVE_INFINITY

OptionalserviceHost

serviceHost?: string

OptionalshouldRetryOnError

shouldRetryOnError?: () => boolean

Called when a non-retryable error is encountered during reconnection. Return true to treat the error as retryable. Does not override reconnectMaxAttempts — retries are still bounded by that limit.

signalingAddress

signalingAddress: string

Settings

Member Visibility

On This Page

Properties