Interface DialWebRTCConf

Options required to dial a robot via WebRTC.

reconnectMaxAttempts value should be a positive int; default is 10.
reconnectMaxWait value should be a positive int; default is positive infinity.

interface DialWebRTCConf {
    authEntity?: string;
    credential?: Credential;
    dialTimeout?: number;
    disableSessions?: boolean;
    host: string;
    iceServers?: ICEServer[];
    noReconnect?: boolean;
    priority?: number;
    reconnectAbortSignal?: {
        abort: boolean;
    };
    reconnectMaxAttempts?: number;
    reconnectMaxWait?: number;
    signalingAddress: string;
}

Index

Properties

authEntity? credential? dialTimeout? disableSessions? host iceServers? noReconnect? priority? reconnectAbortSignal? reconnectMaxAttempts? reconnectMaxWait? signalingAddress

Properties

`Optional` authEntity

authEntity?: string

`Optional` credential

credential?: Credential

`Optional` dialTimeout

dialTimeout?: number

`Optional` disableSessions

disableSessions?: boolean

host

host: string

`Optional` iceServers

iceServers?: ICEServer[]

`Optional` noReconnect

noReconnect?: boolean

`Optional` priority

priority?: number

`Optional` reconnectAbortSignal

reconnectAbortSignal?: {
abort: boolean;
}

Type declaration

abort: boolean

`Optional` reconnectMaxAttempts

reconnectMaxAttempts?: number

`Optional` reconnectMaxWait

reconnectMaxWait?: number

signalingAddress

signalingAddress: string

Generated using TypeDoc