Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 989025 of RTCIceCandidate

  • Revision slug: Web/API/RTCIceCandidate
  • Revision title: RTCIceCandidate
  • Revision id: 989025
  • Created:
  • Creator: jpmedley
  • Is current revision? No
  • Comment Add a property definition.

Revision Content

{{APIRef("WebRTC")}}{{SeeCompatTable}}

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

Constructors

{{domxref("RTCIceCandidate.RTCIceCandidate()","RTCIceCandidate()")}}
Creates an RTCIceCandidate object.

Properties

{{domxref("RTCIceCandidate.candidate")}}
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.
{{domxref("RTCIceCandidate.foundation")}}
Returns a unique identifier that allows ICE to correlate candidates that appear on multiple {{domxref("RTCIceTransport")}} objects.
{{domxref("RTCIceCandidate.ip")}}
Returns the IP address of the candidate.
{{domxref("RTCIceCandidate.port")}}
Returns the port of the candidate.
{{domxref("RTCIceCandidate.priority")}}
Returns the assigned priority of the candidate.
{{domxref("RTCIceCandidate.protocol")}}
TBD
{{domxref("RTCIceCandidate.relatedAddress")}}
TBD
{{domxref("RTCIceCandidate.relatedPort")}}
TBD
{{domxref("RTCIceCandidate.sdpMid")}}
TBD
{{domxref("RTCIceCandidate.sdpMLineIndex")}}
TB
{{domxref("RTCIceCandidate.tcpType")}}
TBD
{{domxref("RTCIceCandidate.type")}}
TBD

Specifications

Specification Status Comment
{{SpecName('WebRTC 1.0')}} {{Spec2('WebRTC 1.0')}} Initial definition.

Browser compatibility

{{CompatibilityTable}}
Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support          
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support                

Revision Source

<p>{{APIRef("WebRTC")}}{{SeeCompatTable}}</p>

<p>The <strong><code>RTCIceCandidate</code></strong> interface of the the <a href="/en-US/docs/Web/API/WebRTC_API">WebRTC API</a> represents a candidate internet connectivity establishment (ICE) server for establishing an {{domxref("RTCPeerConnection")}}.</p>

<h2 id="Constructors">Constructors</h2>

<dl>
 <dt>{{domxref("RTCIceCandidate.RTCIceCandidate()","RTCIceCandidate()")}}</dt>
 <dd>Creates an <code>RTCIceCandidate</code> object.</dd>
</dl>

<h2 id="Properties">Properties</h2>

<dl>
 <dt>{{domxref("RTCIceCandidate.candidate")}}</dt>
 <dd>Returns a transport address for the&nbsp;candidate that can be used for connectivity checks. The format of this address is a <code>candidate-attribute</code> as defined in <a href="https://tools.ietf.org/html/rfc5245">RTC 5245</a>.</dd>
 <dt>{{domxref("RTCIceCandidate.foundation")}}</dt>
 <dd>Returns a unique identifier that allows ICE to correlate candidates that appear on multiple {{domxref("RTCIceTransport")}} objects.</dd>
 <dt>{{domxref("RTCIceCandidate.ip")}}</dt>
 <dd>Returns the IP address of the candidate.</dd>
 <dt>{{domxref("RTCIceCandidate.port")}}</dt>
 <dd>Returns the port of the candidate.</dd>
 <dt>{{domxref("RTCIceCandidate.priority")}}</dt>
 <dd>Returns the assigned priority of the candidate.</dd>
 <dt>{{domxref("RTCIceCandidate.protocol")}}</dt>
 <dd>TBD</dd>
 <dt>{{domxref("RTCIceCandidate.relatedAddress")}}</dt>
 <dd>TBD</dd>
 <dt>{{domxref("RTCIceCandidate.relatedPort")}}</dt>
 <dd>TBD</dd>
 <dt>{{domxref("RTCIceCandidate.sdpMid")}}</dt>
 <dd>TBD</dd>
 <dt>{{domxref("RTCIceCandidate.sdpMLineIndex")}}</dt>
 <dd>TB</dd>
 <dt>{{domxref("RTCIceCandidate.tcpType")}}</dt>
 <dd>TBD</dd>
 <dt>{{domxref("RTCIceCandidate.type")}}</dt>
 <dd>TBD</dd>
</dl>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('WebRTC 1.0')}}</td>
   <td>{{Spec2('WebRTC 1.0')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<div>{{CompatibilityTable}}</div>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari (WebKit)</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Android Webview</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>Firefox OS</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
   <th>Chrome for Android</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
   <td>&nbsp;</td>
  </tr>
 </tbody>
</table>
</div>
Revert to this revision