The WebRTC API's RTCIceCandidateStats
dictionary provides statistics related to an RTCIceCandidate
.
The WebRTC API's RTCIceCandidateStats
dictionary provides statistics related to an RTCIceCandidate
.
RTCIceCandidateStats
is based upon the RTCStats
dictionary, so it includes those properties in addition to the ones below.
address
Optional
A string containing the address of the candidate. This value may be an IPv4 address, an IPv6 address, or a fully-qualified domain name. This property was previously named ip
and only accepted IP addresses.
candidateType
Optional
A string matching one of the values in RTCIceCandidate.type
, indicating what kind of candidate the object provides statistics for.
deleted
Optional
A Boolean value indicating whether or not the candidate has been released or deleted; the default value is false
. For local candidates, its value is true
if the candidate has been deleted or released. For host candidates, true
means that any network resources (usually a network socket) associated with the candidate have already been released. For TURN candidates, the TURN allocation is no longer active for deleted candidates. This property is not present for remote candidates.
port
Optional
The network port number used by the candidate.
priority
Optional
The candidate's priority, corresponding to RTCIceCandidate.priority
.
protocol
Optional
A string specifying the protocol (tcp
or udp
) used to transmit data on the port
.
relayProtocol
Optional
A string identifying the protocol used by the endpoint for communicating with the TURN server; valid values are tcp
, udp
, and tls
. Only present for local candidates.
transportId
Optional
A string uniquely identifying the transport object that was inspected in order to obtain the RTCTransportStats
associated with the candidate corresponding to these statistics.
url
Optional
For local candidates, the url
property is the URL of the ICE server from which the candidate was received. This URL matches the one included in the RTCPeerConnectionIceEvent
object representing the icecandidate
event that delivered the candidate to the local peer.
In this example, the candidate's type
is used to present a modified user interface for host candidates (those where the ip
refers directly to the remote peer, rather than an intermediary).
if (candidate.type === "host") { showHostControls(); } else { hideHostControls(); }
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
RTCIceCandidateStats |
No | No | 27 | No | No | 12.1 | No | No | 27 | No | 12.2 | No |
address |
No | No | 6527 | No | No | 12.1 | No | No | 6527 | No | 12.2 | No |
candidateType |
No | No | 27 | No | No | 12.1 | No | No | 27 | No | 12.2 | No |
componentId |
No | No | 29componentId is a Firefox-specific property and should not be used in production code. |
No | No | No | No | No | 29componentId is a Firefox-specific property and should not be used in production code. |
No | No | No |
deleted |
No | No | No | No | No | 12.1 | No | No | No | No | 12.2 | No |
port |
No | No | 27 | No | No | 12.1 | No | No | 27 | No | 12.2 | No |
priority |
No | No | No | No | No | 12.1 | No | No | No | No | 12.2 | No |
protocol |
No | No | 6431 | No | No | 12.1 | No | No | 6431 | No | 12.2 | No |
relayProtocol |
No | No | 6431 | No | No | No | No | No | 6431 | No | No | No |
transportId |
No | No | 31 | No | No | 12.1 | No | No | 31 | No | 12.2 | No |
url |
No | No | No | No | No | 12.1 | No | No | No | No | 12.2 | No |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidateStats