DialWebRtcOptions class Viam SDK
Options specific for connecting over WebRTC
Constructors
Properties
- disable ↔ bool
-
Whether to disable WebRTC.
getter/setter pair
- disableTrickleIce ↔ bool
-
Whether TrickleICE should be disabled. If true, connection establishment may take longer.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- signalingAccessToken ↔ String?
-
Allows a pre-authenticated client to dial with an authorization header to the signaling server.
This skips the Authenticate() request to the signaling server or external auth but does not skip the
AuthenticateTo() request to retrieve the credentials at the external auth endpoint.
getter/setter pair
- signalingAuthEntity ↔ String?
-
The entity to authenticate as to the signaler.
getter/setter pair
- signalingCredentials ↔ Credentials?
-
Credentials used to authenticate the request to the signaling server.
getter/setter pair
- signalingExternalAuthAddress ↔ String?
-
The address to perform external auth at.
This is unlikely to be needed since the signaler is typically in the same
place where authentication happens.
getter/setter pair
- signalingExternalAuthToEntity ↔ String?
-
The entity to authenticate for after externally authenticating.
This is unlikely to be needed since the signaler is typically in the same
place where authentication happens.
getter/setter pair
- signalingServerAddress ↔ String?
-
The signaling server to contact on behalf of this client for WebRTC communications
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited