RTCIceCandidateStats.candidateType

The RTCIceCandidateStats interface's candidateType property is a string which indicates the type of ICE candidate the object represents.

Syntax

candidateType = rtcIceCandidateStats.candidateType;

Value

A DOMString whose value is one of the strings found in the RTCIceCandidateType enumerated type:

host
The candidate is a host candidate, whose IP address as specified in the RTCIceCandidate.ip property is in fact the true address of the remote peer.
srflx
The candidate is a server reflexive candidate; the ip indicates an intermediary address assigned by the STUN server to represent the candidate's peer anonymously.
prflx
The candidate is a peer reflexive candidate; the ip is an intermediary address assigned by the STUN server to represent the candidate's peer anonymously.
relay
The candidate is a relay candidate, obtained from a TURN server. The relay candidate's IP address is an address the TURN server uses to forward the media between the two peers.

Specifications

Specification Status Comment
Identifiers for WebRTC's Statistics API
The definition of 'RTCIceCandidateStats.candidateType' in that specification.
Candidate Recommendation Initial specification.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
candidateTypeChrome No support NoEdge No support NoFirefox Full support 27IE No support NoOpera ? Safari ? WebView Android No support NoChrome Android No support NoFirefox Android Full support 27Opera Android ? Safari iOS ? Samsung Internet Android No support No

Legend

Full support
Full support
No support
No support
Compatibility unknown
Compatibility unknown