Skip to content

Commit 9757b3c

Browse files
committed
Fix typo in property name and improve bikeshed markup
1 parent 3ece5d9 commit 9757b3c

File tree

2 files changed

+38
-24
lines changed

2 files changed

+38
-24
lines changed

index.bs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -135,27 +135,27 @@ argument, ensure that the codec is disabled and produces no output.
135135
### Stream creation ### {#stream-creation}
136136

137137
Let the {{RTCRtpSender}} or {{RTCRtpReceiver}} have an internal slot,
138-
[[\Streams]], initialized to null.
138+
`[[Streams]]`, initialized to null.
139139

140140
When {{RTCRtpSender/createEncodedStreams}}() is
141141
called, run the following steps:
142142

143143
* If the {{RTCPeerConnection}}'s configuration does not have {{RTCConfiguration/encodedInsertableStreams}} set to "true", throw an {{InvalidStateError}} and abort these steps.
144144
* If the data source does not permit access, throw an {{InvalidAccessError}} and abort these steps.
145-
* If [[\Streams]] is not null, throw an {{InvalidStateError}}.
146-
* Create an {{RTCInsertableStreams}} object 's'.
147-
* Set s.readable to a ReadableStream representing the encoded data source.
148-
* Set s.writable to a WritableStream representing the encoded data sink.
145+
* If `[[Streams]]` is not null, throw an {{InvalidStateError}}.
146+
* Create an {{RTCInsertableStreams}} object |s|.
147+
* Set |s|.{{RTCInsertableStreams/readable}} to a {{ReadableStream}} representing the encoded data source.
148+
* Set |s|.{{RTCInsertableStreams/writable}} to a {{WritableStream}} representing the encoded data sink.
149149
* Enable the encoded data source.
150-
* Store 's' in the internal slot [[\Streams]].
151-
* Return 's'
150+
* Store |s| in the internal slot `[[Streams]]`.
151+
* Return |s|
152152

153153
### Stream processing ### {#stream-processing}
154154

155155
When a frame is produced from the encoded data source, place it on the
156-
[[\Streams]].readableStream'.
156+
`[[Streams]]`.{{RTCInsertableStreams/readable}}.
157157

158-
When a frame appears on the [[\Streams]].writable, do the following:
158+
When a frame appears on the `[[Streams]]`.{{RTCInsertableStreams/writable}}, do the following:
159159
* Check that the frame is a a valid frame that has been created by the encoded data source; if it is not, discard it. A processor cannot create frames, or move frames between streams.
160160
* Check that the frame's {{RTCEncodedVideoFrame/timestamp}} is equal to or larger than any previously received frame. A processor cannot reorder frames, although it may delay them or drop them.
161161
* Process the frame as if it came directly from the encoded data source.
@@ -175,6 +175,6 @@ otherwise unavailable, which allows some fingerprinting surface.
175175

176176
# Examples # {#examples}
177177

178-
See the explainer document.
178+
See the [explainer document](https://github.com/w3c/webrtc-insertable-streams/blob/master/explainer.md#code-examples).
179179

180180

index.html

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1586,8 +1586,8 @@ <h2 class="heading settled" data-level="3" id="specification"><span class="secno
15861586
insert the processing into the pipeline.</p>
15871587
<pre class="idl highlight def">// New dictionary.
15881588
<c- b>dictionary</c-> <dfn class="dfn-paneled idl-code" data-dfn-type="dictionary" data-export id="dictdef-rtcinsertablestreams"><code><c- g>RTCInsertableStreams</c-></code></dfn> {
1589-
<a class="n" data-link-type="idl-name" href="https://streams.spec.whatwg.org/#readablestream" id="ref-for-readablestream"><c- n>ReadableStream</c-></a> <dfn class="idl-code" data-dfn-for="RTCInsertableStreams" data-dfn-type="dict-member" data-export data-type="ReadableStream " id="dom-rtcinsertablestreams-readable"><code><c- g>readable</c-></code><a class="self-link" href="#dom-rtcinsertablestreams-readable"></a></dfn>;
1590-
<a class="n" data-link-type="idl-name" href="https://streams.spec.whatwg.org/#writablestream" id="ref-for-writablestream"><c- n>WritableStream</c-></a> <dfn class="idl-code" data-dfn-for="RTCInsertableStreams" data-dfn-type="dict-member" data-export data-type="WritableStream " id="dom-rtcinsertablestreams-writable"><code><c- g>writable</c-></code><a class="self-link" href="#dom-rtcinsertablestreams-writable"></a></dfn>;
1589+
<a class="n" data-link-type="idl-name" href="https://streams.spec.whatwg.org/#readablestream" id="ref-for-readablestream"><c- n>ReadableStream</c-></a> <dfn class="dfn-paneled idl-code" data-dfn-for="RTCInsertableStreams" data-dfn-type="dict-member" data-export data-type="ReadableStream " id="dom-rtcinsertablestreams-readable"><code><c- g>readable</c-></code></dfn>;
1590+
<a class="n" data-link-type="idl-name" href="https://streams.spec.whatwg.org/#writablestream" id="ref-for-writablestream"><c- n>WritableStream</c-></a> <dfn class="dfn-paneled idl-code" data-dfn-for="RTCInsertableStreams" data-dfn-type="dict-member" data-export data-type="WritableStream " id="dom-rtcinsertablestreams-writable"><code><c- g>writable</c-></code></dfn>;
15911591
};
15921592

15931593
// New enum for video frame types. Will eventually re-use the equivalent defined
@@ -1650,8 +1650,7 @@ <h3 class="heading settled" data-level="3.1" id="operation"><span class="secno">
16501650
<p>At the time when a codec is initialized as part of the encoder, and the
16511651
corresponding flag is set in the <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcpeerconnection" id="ref-for-dom-rtcpeerconnection②">RTCPeerConnection</a></code>'s <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcconfiguration" id="ref-for-dom-rtcconfiguration①">RTCConfiguration</a></code> argument, ensure that the codec is disabled and produces no output.</p>
16521652
<h4 class="heading settled" data-level="3.1.1" id="stream-creation"><span class="secno">3.1.1. </span><span class="content">Stream creation</span><a class="self-link" href="#stream-creation"></a></h4>
1653-
<p>Let the <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcrtpsender" id="ref-for-dom-rtcrtpsender②">RTCRtpSender</a></code> or <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcrtpreceiver" id="ref-for-dom-rtcrtpreceiver②">RTCRtpReceiver</a></code> have an internal slot,
1654-
[[\Streams]], initialized to null.</p>
1653+
<p>Let the <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcrtpsender" id="ref-for-dom-rtcrtpsender②">RTCRtpSender</a></code> or <code class="idl"><a data-link-type="idl" href="https://www.w3.org/TR/webrtc/#dom-rtcrtpreceiver" id="ref-for-dom-rtcrtpreceiver②">RTCRtpReceiver</a></code> have an internal slot, <code>[[Streams]]</code>, initialized to null.</p>
16551654
<p>When <code class="idl"><a data-link-type="idl" href="#dom-rtcrtpsender-createencodedstreams" id="ref-for-dom-rtcrtpsender-createencodedstreams">createEncodedStreams</a></code>() is
16561655
called, run the following steps:</p>
16571656
<ul>
@@ -1660,24 +1659,23 @@ <h4 class="heading settled" data-level="3.1.1" id="stream-creation"><span class=
16601659
<li data-md>
16611660
<p>If the data source does not permit access, throw an <code class="idl"><a data-link-type="idl" href="https://heycam.github.io/webidl/#invalidaccesserror" id="ref-for-invalidaccesserror">InvalidAccessError</a></code> and abort these steps.</p>
16621661
<li data-md>
1663-
<p>If [[\Streams]] is not null, throw an <code class="idl"><a data-link-type="idl" href="https://heycam.github.io/webidl/#invalidstateerror" id="ref-for-invalidstateerror①">InvalidStateError</a></code>.</p>
1662+
<p>If <code>[[Streams]]</code> is not null, throw an <code class="idl"><a data-link-type="idl" href="https://heycam.github.io/webidl/#invalidstateerror" id="ref-for-invalidstateerror①">InvalidStateError</a></code>.</p>
16641663
<li data-md>
1665-
<p>Create an <code class="idl"><a data-link-type="idl" href="#dictdef-rtcinsertablestreams" id="ref-for-dictdef-rtcinsertablestreams②">RTCInsertableStreams</a></code> object 's'.</p>
1664+
<p>Create an <code class="idl"><a data-link-type="idl" href="#dictdef-rtcinsertablestreams" id="ref-for-dictdef-rtcinsertablestreams②">RTCInsertableStreams</a></code> object <var>s</var>.</p>
16661665
<li data-md>
1667-
<p>Set s.readable to a ReadableStream representing the encoded data source.</p>
1666+
<p>Set <var>s</var>.<code class="idl"><a data-link-type="idl" href="#dom-rtcinsertablestreams-readable" id="ref-for-dom-rtcinsertablestreams-readable">readable</a></code> to a <code class="idl"><a data-link-type="idl" href="https://streams.spec.whatwg.org/#readablestream" id="ref-for-readablestream①">ReadableStream</a></code> representing the encoded data source.</p>
16681667
<li data-md>
1669-
<p>Set s.writable to a WritableStream representing the encoded data sink.</p>
1668+
<p>Set <var>s</var>.<code class="idl"><a data-link-type="idl" href="#dom-rtcinsertablestreams-writable" id="ref-for-dom-rtcinsertablestreams-writable">writable</a></code> to a <code class="idl"><a data-link-type="idl" href="https://streams.spec.whatwg.org/#writablestream" id="ref-for-writablestream①">WritableStream</a></code> representing the encoded data sink.</p>
16701669
<li data-md>
16711670
<p>Enable the encoded data source.</p>
16721671
<li data-md>
1673-
<p>Store 's' in the internal slot [[\Streams]].</p>
1672+
<p>Store <var>s</var> in the internal slot <code>[[Streams]]</code>.</p>
16741673
<li data-md>
1675-
<p>Return 's'</p>
1674+
<p>Return <var>s</var></p>
16761675
</ul>
16771676
<h4 class="heading settled" data-level="3.1.2" id="stream-processing"><span class="secno">3.1.2. </span><span class="content">Stream processing</span><a class="self-link" href="#stream-processing"></a></h4>
1678-
<p>When a frame is produced from the encoded data source, place it on the
1679-
[[\Streams]].readableStream'.</p>
1680-
<p>When a frame appears on the [[\Streams]].writable, do the following:</p>
1677+
<p>When a frame is produced from the encoded data source, place it on the <code>[[Streams]]</code>.<code class="idl"><a data-link-type="idl" href="#dom-rtcinsertablestreams-readable" id="ref-for-dom-rtcinsertablestreams-readable①">readable</a></code>.</p>
1678+
<p>When a frame appears on the <code>[[Streams]]</code>.<code class="idl"><a data-link-type="idl" href="#dom-rtcinsertablestreams-writable" id="ref-for-dom-rtcinsertablestreams-writable①">writable</a></code>, do the following:</p>
16811679
<ul>
16821680
<li data-md>
16831681
<p>Check that the frame is a a valid frame that has been created by the encoded data source; if it is not, discard it. A processor cannot create frames, or move frames between streams.</p>
@@ -1694,7 +1692,7 @@ <h2 class="heading settled" data-level="4" id="privacy"><span class="secno">4. <
16941692
<p>The API will allow access to some aspects of timing information that are
16951693
otherwise unavailable, which allows some fingerprinting surface.</p>
16961694
<h2 class="heading settled" data-level="5" id="examples"><span class="secno">5. </span><span class="content">Examples</span><a class="self-link" href="#examples"></a></h2>
1697-
<p>See the explainer document.</p>
1695+
<p>See the <a href="https://github.com/w3c/webrtc-insertable-streams/blob/master/explainer.md#code-examples">explainer document</a>.</p>
16981696
</main>
16991697
<div data-fill-with="conformance">
17001698
<h2 class="no-ref no-num heading settled" id="conformance"><span class="content"> Conformance</span><a class="self-link" href="#conformance"></a></h2>
@@ -1911,12 +1909,14 @@ <h3 class="no-num no-ref heading settled" id="index-defined-here"><span class="c
19111909
<a href="https://streams.spec.whatwg.org/#readablestream">https://streams.spec.whatwg.org/#readablestream</a><b>Referenced in:</b>
19121910
<ul>
19131911
<li><a href="#ref-for-readablestream">3. Specification</a>
1912+
<li><a href="#ref-for-readablestream①">3.1.1. Stream creation</a>
19141913
</ul>
19151914
</aside>
19161915
<aside class="dfn-panel" data-for="term-for-writablestream">
19171916
<a href="https://streams.spec.whatwg.org/#writablestream">https://streams.spec.whatwg.org/#writablestream</a><b>Referenced in:</b>
19181917
<ul>
19191918
<li><a href="#ref-for-writablestream">3. Specification</a>
1919+
<li><a href="#ref-for-writablestream①">3.1.1. Stream creation</a>
19201920
</ul>
19211921
</aside>
19221922
<aside class="dfn-panel" data-for="term-for-idl-ArrayBuffer">
@@ -2132,6 +2132,20 @@ <h2 class="no-num no-ref heading settled" id="idl-index"><span class="content">I
21322132
<li><a href="#ref-for-dictdef-rtcinsertablestreams②">3.1.1. Stream creation</a>
21332133
</ul>
21342134
</aside>
2135+
<aside class="dfn-panel" data-for="dom-rtcinsertablestreams-readable">
2136+
<b><a href="#dom-rtcinsertablestreams-readable">#dom-rtcinsertablestreams-readable</a></b><b>Referenced in:</b>
2137+
<ul>
2138+
<li><a href="#ref-for-dom-rtcinsertablestreams-readable">3.1.1. Stream creation</a>
2139+
<li><a href="#ref-for-dom-rtcinsertablestreams-readable①">3.1.2. Stream processing</a>
2140+
</ul>
2141+
</aside>
2142+
<aside class="dfn-panel" data-for="dom-rtcinsertablestreams-writable">
2143+
<b><a href="#dom-rtcinsertablestreams-writable">#dom-rtcinsertablestreams-writable</a></b><b>Referenced in:</b>
2144+
<ul>
2145+
<li><a href="#ref-for-dom-rtcinsertablestreams-writable">3.1.1. Stream creation</a>
2146+
<li><a href="#ref-for-dom-rtcinsertablestreams-writable①">3.1.2. Stream processing</a>
2147+
</ul>
2148+
</aside>
21352149
<aside class="dfn-panel" data-for="enumdef-rtcencodedvideoframetype">
21362150
<b><a href="#enumdef-rtcencodedvideoframetype">#enumdef-rtcencodedvideoframetype</a></b><b>Referenced in:</b>
21372151
<ul>

0 commit comments

Comments
 (0)