This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for the proper prefixes to use in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the spec changes.

The RTCIceCandidate interface of the the WebRTC API represents a candidate internet connectivity establishment (ICE) server for establishing an RTCPeerConnection.


Creates an RTCIceCandidate object.


RTCIceCandidate.candidate Read only
Returns a transport address for the candidate that can be used for connectivity checks. The format of this address is a candidate-attribute as defined in RTC 5245.
RTCIceCandidate.foundation Read only
Returns a unique identifier that allows ICE to correlate candidates that appear on multiple RTCIceTransport objects.
RTCIceCandidate.ip Read only
Returns the IP address of the candidate.
RTCIceCandidate.port Read only
Returns the port of the candidate.
RTCIceCandidate.priority Read only
Returns the assigned priority of the candidate.
RTCIceCandidate.protocol Read only
Returns the protocol used by the candidate, either udp or tcp.
RTCIceCandidate.relatedAddress Read only
For a candidate that is derived from another, such as a relay or reflexive candidate, the relatedAddress is the IP address of the candidate that it is derived from. For host candidates, the relatedAddress is null.
RTCIceCandidate.relatedPort Read only
For a candidate that is derived from another, such as a relay or reflexive candidate, the relatedPort is the port of the candidate that it is derived from. For host candidates, the relatedPort is null.
RTCIceCandidate.sdpMid Read only
If not null, this contains the identifier of the "media stream identification" (as defined in RFC 5888) for the media component this candidate is associated with.
RTCIceCandidate.sdpMLineIndex Read only
If not null, this indicates the index (starting at zero) of the media description (as defined in RFC 4566) in the SDP this candidate is associated with.
RTCIceCandidate.tcpType Read only
If protocol is tcptcpType represents the type of TCP candidate. Otherwise, tcpType is null.
RTCIceCandidate.type Read only
One of host, srflx, prflx, or relay.


Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browser Working Draft Initial definition.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support (Yes)        
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support ? (Yes)           (Yes)


© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.

API Experimental Interface real time communications Reference RTCIceCandidate Web RTC WebRTC