Skip to content

Commit

Permalink
Remove documentation for the RTCIceComponent enum (#6460)
Browse files Browse the repository at this point in the history
  • Loading branch information
queengooborg authored Jun 30, 2021
1 parent 8acca38 commit 44feafa
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 56 deletions.
1 change: 1 addition & 0 deletions files/en-us/_redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8350,6 +8350,7 @@
/en-US/docs/Web/API/RTCIceCandidatePairStats/contentRequestsSent /en-US/docs/Web/API/RTCIceCandidatePairStats/consentRequestsSent
/en-US/docs/Web/API/RTCIceCandidateStats/ip /en-US/docs/Web/API/RTCIceCandidateStats/address
/en-US/docs/Web/API/RTCIceCandidateType /en-US/docs/Web/API/RTCIceCandidate/type
/en-US/docs/Web/API/RTCIceComponent /en-US/docs/Web/API/RTCIceCandidate/component
/en-US/docs/Web/API/RTCIceConnectionState /en-US/docs/Web/API/RTCPeerConnection/iceConnectionState
/en-US/docs/Web/API/RTCIceGatheringState /en-US/docs/Web/API/RTCPeerConnection/iceGatheringState
/en-US/docs/Web/API/RTCInboundRtpStreamStats/lastPacketReceivedTimesta /en-US/docs/Web/API/RTCInboundRtpStreamStats/lastPacketReceivedTimestamp
Expand Down
6 changes: 0 additions & 6 deletions files/en-us/_wikihistory.json
Original file line number Diff line number Diff line change
Expand Up @@ -72276,12 +72276,6 @@
"Sheppy"
]
},
"Web/API/RTCIceComponent": {
"modified": "2020-10-15T22:06:08.263Z",
"contributors": [
"Sheppy"
]
},
"Web/API/RTCIceCredentialType": {
"modified": "2020-10-15T22:20:11.863Z",
"contributors": [
Expand Down
10 changes: 8 additions & 2 deletions files/en-us/web/api/rtcicecandidate/component/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,14 @@ <h2 id="Syntax">Syntax</h2>

<h3 id="Value">Value</h3>

<p>A {{domxref("DOMString")}} which is <code>"rtp"</code> for RTP (or RTP and RTCP
multiplexed together) candidates or <code>"rtcp"</code> for RTCP candidates.</p>
<p>A {{domxref("DOMString")}} which is one of the following:</p>

<dl>
<dt><code>"rtp"</code></dt>
<dd>Identifies an ICE transport which is being used for the <a href="/en-US/docs/Web/API/WebRTC_API/Intro_to_RTP">Real-time Transport Protocol</a> (RTP), or for RTP multiplexed with the RTP Control Protocol (RTCP). RTP is defined in {{RFC(3550)}}. This value corresponds to the component ID field in the <code>candidate</code> a-line with the value 1.</dd>
<dt><code>"rtcp"</code></dt>
<dd>Identifies an ICE transport being used for RTCP, which is defined in {{RFC(3550, "", 6)}}. This value corresponds to the component ID 2.</dd>
</dl>

<h2 id="Usage_notes">Usage notes</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/rtcicecandidate/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2 id="Properties">Properties</h2>
<dt>{{domxref("RTCIceCandidate.candidate", "candidate")}} {{readonlyInline}}</dt>
<dd>A {{domxref("DOMString")}} representing the transport address for the candidate that can be used for connectivity checks. The format of this address is a <code>candidate-attribute</code> as defined in {{RFC(5245)}}. This string is empty (<code>""</code>) if the <code>RTCIceCandidate</code> is an "end of candidates" indicator.</dd>
<dt>{{domxref("RTCIceCandidate.component", "component")}} {{ReadOnlyInline}}</dt>
<dd>A {{domxref("DOMString")}} which indicates whether the candidate is an RTP or an RTCP candidate; its value is either <code>"rtp"</code> or <code>"rtcp"</code>, and is derived from the  <code>"component-id"</code> field in the <code>candidate</code> a-line string. The permitted values are listed in the {{domxref("RTCIceComponent")}} enumerated type.</dd>
<dd>A {{domxref("DOMString")}} which indicates whether the candidate is an RTP or an RTCP candidate; its value is either <code>"rtp"</code> or <code>"rtcp"</code>, and is derived from the  <code>"component-id"</code> field in the <code>candidate</code> a-line string. The permitted values are listed in <a href="/en-US/docs/Web/API/RTCIceCandidate/component#Value"><code>RTCIceCandidate.component</code></a>.</dd>
<dt>{{domxref("RTCIceCandidate.foundation", "foundation")}} {{readonlyInline}}</dt>
<dd>Returns a {{domxref("DOMString")}} containing a unique identifier that is the same for any candidates of the same type, share the same base (the address from which the ICE agent sent the candidate), and come from the same {{Glossary("STUN")}} server. This is used to help optimize ICE performance while prioritizing and correlating candidates that appear on multiple {{domxref("RTCIceTransport")}} objects.</dd>
<dt>{{domxref("RTCIceCandidate/address", "ip")}} {{readonlyInline}}</dt>
Expand Down
43 changes: 0 additions & 43 deletions files/en-us/web/api/rtcicecomponent/index.html

This file was deleted.

5 changes: 1 addition & 4 deletions files/en-us/web/api/rtcicetransport/component/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,7 @@ <h2 id="Syntax">Syntax</h2>

<h3 id="Value">Value</h3>

<p>A {{domxref("DOMString")}} whose value comes from the enumerated type
{{domxref("RTCIceComponent")}}:</p>

<p>{{page("/en-US/docs/Web/API/RTCIceComponent", "Values")}}</p>
<p>A {{domxref("DOMString")}} whose value is specified in <a href="/en-US/docs/Web/API/RTCIceCandidate/component#Value"><code>RTCIceCandidate.component</code></a>.</p>

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

Expand Down

0 comments on commit 44feafa

Please sign in to comment.