Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add RTCIceTransport method to remove candidate pairs #3

Closed
wants to merge 4 commits into from
Closed

Add RTCIceTransport method to remove candidate pairs #3

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d5bfc3
Add removeCandidatePairs method.
sam-vi Sep 5, 2023
d8f0d90
Merge branch 'w3c:main' into samvi-170-removepairs
sam-vi Sep 22, 2023
2833e5b
Merge pull request #174 from sam-vi/samvi-171-setselected
aboba Oct 26, 2023
19529b1
Merge branch 'w3c:main' into samvi-170-removepairs
sam-vi Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,7 @@ <h3>
attribute EventHandler onicecandidatepairremove;
attribute EventHandler onicecandidatepairnominate;
undefined setSelectedCandidatePair(RTCIceCandidatePair candidatePair);
undefined removeCandidatePairs(sequence&lt;RTCIceCandidatePair&gt; candidatePairs);
};</pre>
<section id="rtcicetransport-attributes">
<h2>Attributes</h2>
Expand Down Expand Up @@ -975,6 +976,67 @@ <h2>Methods</h2>
selected candidate pair =].
</p>
</dd>
<dt>
<dfn>removeCandidatePairs</dfn>
</dt>
<dd>
<p>
The {{removeCandidatePairs}} method immediately removes the provided candidate pairs, making them unavailable to use
for transport. The [= ICE agent =] may free up candidates once all the associated candidate pairs have been removed.
</p>
<p>
When this method is invoked, the [= user agent =] MUST run the following steps:
</p>
<ol class="algorithm">
<li>
<p>
Let |connection:RTCPeerConnection| be the {{RTCPeerConnection}} object associated with this [= ICE agent =].
</p>
</li>
<li>
<p>
If <var>connection</var>.{{RTCPeerConnection/[[IsClosed]]}} is
<code>true</code>, [= exception/throw =] an
{{InvalidStateError}}.
</p>
</li>
<li>
<p>
Let |transport:RTCIceTransport| be the associated {{RTCIceTransport}} object.
</p>
</li>
<li>
<p>
If |transport|.{{RTCIceTransport/[[IceTransportState]]}} is either of
{{RTCIceTransportState/"new"}}, {{RTCIceTransportState/"failed"}} or {{RTCIceTransportState/"closed"}}, [=
exception/throw =]
an {{InvalidStateError}}.
</p>
</li>
<li>
<p>
If |transport|.{{RTCIceTransport/[[ProposalPending]]}} is <code>true</code>, [= exception/throw =] an
{{InvalidStateError}}.
</p>
</li>
<li>
<p>
Instruct the [= ICE agent =] to remove the candidate pairs indicated by |candidatePairs|, ignoring any unknown
or invalid candidate pairs.
</p>
</li>
<li>
<p>
For each valid |removedPair| in |candidatePairs| that was removed by the [= ICE agent =], [= fire an event =] named
{{RTCIceTransport/icecandidatepairremove}}
at |transport|, using {{RTCIceCandidatePairEvent}}, with the
{{Event/cancelable}} attribute initialized to <code>false</code>, and the {{RTCIceCandidatePairEvent/local}}
and {{RTCIceCandidatePairEvent/remote}} attributes initialized to the local and remote candidates, respectively,
of |removedPair|.
</p>
</li>
</ol>
</dd>
</dl>
</section>
<section>
Expand Down