RTCIceCandidate class
The interface—part of the WebRTC API—represents a candidate Interactive Connectivity Establishment (ICE) configuration which may be used to establish an RTCPeerConnection. An ICE candidate describes the protocols and routing needed for WebRTC to be able to communicate with a remote device. When starting a WebRTC peer connection, typically a number of candidates are proposed by each end of the connection, until they mutually agree upon one which describes the connection they decide will be best. WebRTC then uses that candidate's details to initiate the connection. For details on how the ICE process works, see Lifetime of a WebRTC session. The article WebRTC connectivity provides additional useful details.
- Available extensions
- Annotations
-
- @JS()
- @staticInterop
Constructors
- RTCIceCandidate([RTCIceCandidateInit? candidateInitDict])
-
factory
Properties
- address → String?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - candidate → String
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - component → RTCIceComponent?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - foundation → String?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- port → int?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - priority → int?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - protocol → RTCIceProtocol?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter -
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter -
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sdpMid → String?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - sdpMLineIndex → int?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - tcpType → RTCIceTcpCandidateType?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - type → RTCIceCandidateType?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter - usernameFragment → String?
-
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJSON(
) → RTCIceCandidateInit -
Available on RTCIceCandidate, provided by the PropsRTCIceCandidate extension
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited