blob: 089c81246d55eeb28d1a9a9f206cfd512a5411ec (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
---
title: RTCPeerConnectionIceEvent
slug: Web/API/RTCPeerConnectionIceEvent
tags:
- API
- Experimental
- Interface
- NeedsTranslation
- RTCIceCandidateEvent
- Reference
- TopicStub
- WebRTC
translation_of: Web/API/RTCPeerConnectionIceEvent
---
<p>{{APIRef("WebRTC")}}</p>
<p><span class="seoSummary">The <strong><code>RTCPeerConnectionIceEvent</code></strong> interface represents events that occurs in relation to {{Glossary("ICE")}} candidates with the target, usually an {{domxref("RTCPeerConnection")}}.</span> Only one event is of this type: {{event("icecandidate")}}.</p>
<h2 id="Properties">Properties</h2>
<p><em>A {{domxref("RTCPeerConnectionIceEvent")}} being an {{domxref("Event")}}, this event also implements these properties</em>.</p>
<dl>
<dt>{{domxref("RTCPeerConnectionIceEvent.candidate")}} {{readOnlyInline}}</dt>
<dd>Contains the {{domxref("RTCIceCandidate")}} containing the candidate associated with the event, or <code>null</code> if this event indicates that there are no further candidates to come.</dd>
</dl>
<h2 id="Constructors">Constructors</h2>
<dl>
<dt>{{domxref("RTCPeerConnectionIceEvent.RTCPeerConnectionIceEvent()", "RTCPeerConnectionIceEvent()")}}</dt>
<dd>Returns a new <code>RTCPeerConnectionIceEvent</code>. It takes two parameters, the first being a {{domxref("DOMString")}} representing the type of the event; the second a dictionary containing the {{domxref("RTCIceCandidate")}} it refers to.</dd>
</dl>
<h2 id="Methods">Methods</h2>
<p><em>A {{domxref("RTCPeerConnectionIceEvent")}} being an {{domxref("Event")}}, this event also implements these properties</em>. <em>There is no specific <em>{{domxref("RTCDataChannelEvent")}}</em> method.</em></p>
<h2 id="Examples">Examples</h2>
<pre class="brush: js">pc.onicecandidate = function( ev ) {
alert("The ICE candidate (transport address: '" +
ev.candidate.candidate +
"') has been added to this connection.");
}
</pre>
<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', '#rtcpeerconnectioniceevent', 'RTCPeerConnectionIceEvent') }}</td>
<td>{{Spec2('WebRTC 1.0')}}</td>
<td>Initial definition.</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("api.RTCPeerConnectionIceEvent")}}</p>
<h2 id="See_also">See also</h2>
<ul>
<li><a href="/en-US/docs/Web/Guide/API/WebRTC" title="/en-US/docs/CSS/Using_CSS_animations">WebRTC</a></li>
<li>Its usual target: {{domxref("RTCPeerConnection")}}.</li>
</ul>
|
