Web/API/RTCIceCandidateType

The WebRTC API's RTCIceCandidateType enumerated type provides a set of DOMString values representing the types of ICE candidate that can arrive. These strings are taken directly from the candidate a-line in SDP.

Values

These candidate types are listed in order of priority; the higher in the list they are, the more efficient they are.

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.

Usage notes

The RTCIceCandidateType enumeration is used by the type property of RTCIceCandidate objects, as well as when reporting statistics on candidates using RTCIceCandidateStats.candidateType.

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCIceCandidateType' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
RTCIceCandidateType	Chrome No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	Edge No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	Firefox No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	IE No support No	Opera ?	Safari ?	WebView Android No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	Chrome Android No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	Firefox Android No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.	Opera Android ?	Safari iOS ?	Samsung Internet Android No support No Notes' No support No Notes' Notes' An RTCIceCandidate object's type is not maintained by this browser.

Legend

No support  

No support

Compatibility unknown  

Compatibility unknown

See implementation notes.'

See implementation notes.

RTCIceCandidateType by Mozilla Contributors is licensed under CC-BY-SA 2.5.