Convert to WebIDL contiguous mode in ReSpec #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| static boolean isTypeSupported (DOMString type); | ||
| };</pre><section><h2>Constructors</h2><dl data-link-for="MediaRecorder" data-dfn-for="MediaRecorder" class="constructors"><dt><dfn><code>MediaRecorder</code></dfn></dt><dd> | ||
|
|
||
| <table class="parameters"><tbody><tr><th>Parameter</th><th>Type</th><th>Nullable</th><th>Optional</th><th>Description</th></tr><tr><td class="prmName">stream</td><td class="prmType"><code>MediaStream</code></td><td class="prmNullFalse"><span role="img" aria-label="False">✘</span></td><td class="prmOptFalse"><span role="img" aria-label="False">✘</span></td><td class="prmDesc">The MediaStream to be recorded. This will be the value of the <code>stream</code> attribute. See [[!GETUSERMEDIA]] for the definition of MediaStream.</td></tr><tr><td class="prmName">options</td><td class="prmType"><code>MediaRecorderOptions</code></td><td class="prmNullFalse"><span role="img" aria-label="False">✘</span></td><td class="prmOptTrue"><span role="img" aria-label="True">✔</span></td><td class="prmDesc">A dictionary of options to for the UA instructing how the recording will take part. <code>options.mimeType</code>, if present, will become the value of <code>mimeType</code> attribute.</td></tr></tbody></table></dd></dl></section><section><h2>Attributes</h2><dl data-link-for="MediaRecorder" data-dfn-for="MediaRecorder" class="attributes"><dt><dfn><code>stream</code></dfn> of type <span class="idlAttrType"><a>MediaStream</a></span>, readonly </dt><dd>The MediaStream to be recorded. </dd><dt><dfn><code>mimeType</code></dfn> of type <span class="idlAttrType"><a>DOMString</a></span>, readonly </dt><dd>The MIME type that has been selected as the container for recording. This entry includes all the parameters to the base <code>mimeType</code>. The UA should be able to play back any of the MIME types it supports for recording. For example, it should be able to display a video recording in the HTML <video> tag. The default value for this property is platform-specific. Note that the <code>mimeType</code> specifies the container format for the recording, and that the codecs that the recording contains will normally be specified as parameters to it. </dd><dt><dfn><code>state</code></dfn> of type <span class="idlAttrType"><a>RecordingState</a></span>, readonly </dt><dd> The current state of the MediaRecorder object. When the MediaRecorder is created, the UA <em title="must" class="rfc2119">must</em> set this attribute to <code>inactive</code>.</dd><dt><dfn><code>onstart</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle the start event.</dd><dt><dfn><code>onstop</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle the stop event.</dd><dt><dfn><code>ondataavailable</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle the dataavailable event. Note that the Blob (see [[!FILE-API]]) of recorded data is contained in this event and can be accessed via the 'data' attribute.</dd><dt><dfn><code>onpause</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle the pause event. </dd><dt><dfn><code>onresume</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle the resume event. </dd><dt><dfn><code>onerror</code></dfn> of type <span class="idlAttrType"><a>EventHandler</a></span></dt><dd>Called to handle a <a>ErrorEvent</a>. </dd><dt><dfn><code>ignoreMutedMedia</code></dfn> of type <span class="idlAttrType"><a>boolean</a></span></dt><dd>If this attribute is set to <code>true</code>, the MediaRecorder will not record anything when the input Media Stream is muted. If this attribute is <code>false</code>, the MediaRecorder will record silence (for audio) and black frames (for video) when the input MediaStream is muted. When the MediaRecorder is created, the UA <em title="must" class="rfc2119">must</em> set this attribute to <code>false</code>.</dd><dt><dfn><code>videoBitsPerSecond</code></dfn> of type <span class="idlAttrType"><a>unsigned long</a></span>, readonly </dt><dd>The value of the Video encoding target bit rate that was passed to the Platform (potentially truncated, rounded, etc), or the calculated one if the user has specified <code>bitsPerSecond</code>.</dd><dt><dfn><code>audioBitsPerSecond</code></dfn> of type <span class="idlAttrType"><a>unsigned long</a></span>, readonly </dt><dd>The value of the Audio encoding target bit rate that was passed to the Platform (potentially truncated, rounded, etc), or the calculated one if the user has specified <code>bitsPerSecond</code>.</dd></dl></section><section><h2>Methods</h2><dl data-link-for="MediaRecorder" data-dfn-for="MediaRecorder" class="methods"><dt><dfn><code>start</code></dfn></dt><dd>When a <code>MediaRecorder</code> object’s <code>start()</code> method is invoked, the UA <em title="must" class="rfc2119">must</em> run the following steps: |
There was a problem hiding this comment.
Actually, can we still reflow these paragraphs in a non-minified way?
Like:
with LFs in between? It's so much easier to edit as text, and that in turn
enables better git-diff reviews etc.
There was a problem hiding this comment.
sure - but that can hopefully happen separately :)
There was a problem hiding this comment.
Ok, would you do the LF reintroduction, or should we add an issue?
Either way LGTM :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional minor fixes in the process