[html5] r7827 - [e] (0) Clarify API is limited to three strings by using WebIDL magic. Fixing ht [...]

whatwg at whatwg.org whatwg at whatwg.org
Fri Apr 12 16:30:30 PDT 2013


Author: ianh
Date: 2013-04-12 16:30:29 -0700 (Fri, 12 Apr 2013)
New Revision: 7827

Modified:
   complete.html
   index
   source
Log:
[e] (0) Clarify API is limited to three strings by using WebIDL magic.
Fixing https://www.w3.org/Bugs/Public/show_bug.cgi?id=21233
Affected topics: HTML, Video and Audio

Modified: complete.html
===================================================================
--- complete.html	2013-04-12 23:21:07 UTC (rev 7826)
+++ complete.html	2013-04-12 23:30:29 UTC (rev 7827)
@@ -26465,7 +26465,7 @@
            attribute DOMString <a href=#dom-source-media title=dom-source-media>media</a>;
 };</pre>
    </dd>
-  </dl><!--TOPIC:HTML--><p>The <code><a href=#the-source-element>source</a></code> element allows authors to specify
+  </dl><!--TOPIC:HTML--><!--CLEANUP--><p>The <code><a href=#the-source-element>source</a></code> element allows authors to specify
   multiple alternative <a href=#media-resource title="media resource">media
   resources</a> for <a href=#media-element title="media element">media
   elements</a>. It does not <a href=#represents title=represents>represent</a> anything on its own.</p>
@@ -26843,7 +26843,8 @@
   <p><dfn id=media-element title="media element">Media elements</dfn> (<code><a href=#the-audio-element>audio</a></code> and <code><a href=#the-video-element>video</a></code>, in
   this specification) implement the following interface:</p>
 
-  <pre class=idl>interface <dfn id=htmlmediaelement>HTMLMediaElement</dfn> : <a href=#htmlelement>HTMLElement</a> {
+  <pre class=idl>enum <dfn id=canplaytypeenum>CanPlayTypeEnum</dfn> { "" /* <a href=#dom-canplaytypeenum-nil title=dom-CanPlayTypeEnum-nil>empty string</a> */, "<a href=#dom-canplaytypeenum-maybe title=dom-CanPlayTypeEnum-maybe>maybe</a>", "<a href=#dom-canplaytypeenum-probably title=dom-CanPlayTypeEnum-probably>probably</a>" };
+interface <dfn id=htmlmediaelement>HTMLMediaElement</dfn> : <a href=#htmlelement>HTMLElement</a> {
 
   // error state
   readonly attribute <a href=#mediaerror>MediaError</a>? <a href=#dom-media-error title=dom-media-error>error</a>;
@@ -26862,7 +26863,7 @@
   readonly attribute boolean <span title="dom-media-bufferingThrottled">bufferingThrottled</span>;
 -->  readonly attribute <a href=#timeranges>TimeRanges</a> <a href=#dom-media-buffered title=dom-media-buffered>buffered</a>;
   void <a href=#dom-media-load title=dom-media-load>load</a>();
-  DOMString <a href=#dom-navigator-canplaytype title=dom-navigator-canPlayType>canPlayType</a>(DOMString type);
+  <a href=#canplaytypeenum>CanPlayTypeEnum</a> <a href=#dom-navigator-canplaytype title=dom-navigator-canPlayType>canPlayType</a>(DOMString type);
 
   // ready state
   const unsigned short <a href=#dom-media-have_nothing title=dom-media-HAVE_NOTHING>HAVE_NOTHING</a> = 0;
@@ -27137,12 +27138,12 @@
 
   </dl><div class=impl>
 
-  <p>The <dfn id=dom-navigator-canplaytype title=dom-navigator-canPlayType><code>canPlayType(<var title="">type</var>)</code></dfn> method must return the empty string if <var title="">type</var>
+  <p>The <dfn id=dom-navigator-canplaytype title=dom-navigator-canPlayType><code>canPlayType(<var title="">type</var>)</code></dfn> method must return <dfn id=dom-canplaytypeenum-nil title=dom-CanPlayTypeEnum-nil>the empty string</dfn> if <var title="">type</var>
   is <a href=#a-type-that-the-user-agent-knows-it-cannot-render>a type that the user agent knows it cannot render</a> or is the type
-  "<code>application/octet-stream</code>"; it must return "<code title="">probably</code>" if the
+  "<code>application/octet-stream</code>"; it must return "<dfn id=dom-canplaytypeenum-probably title=dom-CanPlayTypeEnum-probably><code>probably</code></dfn>" if the
   user agent is confident that the type represents a <a href=#media-resource>media resource</a> that it can render
-  if used in with this <code><a href=#the-audio-element>audio</a></code> or <code><a href=#the-video-element>video</a></code> element; and it must return "<code title="">maybe</code>" otherwise. Implementors are encouraged to return "<code title="">maybe</code>" unless the type can be confidently established as being supported or not.
-  Generally, a user agent should never return "<code title="">probably</code>" for a type that
+  if used in with this <code><a href=#the-audio-element>audio</a></code> or <code><a href=#the-video-element>video</a></code> element; and it must return "<dfn id=dom-canplaytypeenum-maybe title=dom-CanPlayTypeEnum-maybe><code>maybe</code></dfn>" otherwise. Implementors are encouraged to return "<code title=dom-CanPlayTypeEnum-maybe><a href=#dom-canplaytypeenum-maybe>maybe</a></code>" unless the type can be confidently established as being supported or not.
+  Generally, a user agent should never return "<code title=dom-CanPlayTypeEnum-probably><a href=#dom-canplaytypeenum-probably>probably</a></code>" for a type that
   allows the <code title="">codecs</code> parameter if that parameter is not present.</p>
 
   </div>

Modified: index
===================================================================
--- index	2013-04-12 23:21:07 UTC (rev 7826)
+++ index	2013-04-12 23:30:29 UTC (rev 7827)
@@ -26465,7 +26465,7 @@
            attribute DOMString <a href=#dom-source-media title=dom-source-media>media</a>;
 };</pre>
    </dd>
-  </dl><!--TOPIC:HTML--><p>The <code><a href=#the-source-element>source</a></code> element allows authors to specify
+  </dl><!--TOPIC:HTML--><!--CLEANUP--><p>The <code><a href=#the-source-element>source</a></code> element allows authors to specify
   multiple alternative <a href=#media-resource title="media resource">media
   resources</a> for <a href=#media-element title="media element">media
   elements</a>. It does not <a href=#represents title=represents>represent</a> anything on its own.</p>
@@ -26843,7 +26843,8 @@
   <p><dfn id=media-element title="media element">Media elements</dfn> (<code><a href=#the-audio-element>audio</a></code> and <code><a href=#the-video-element>video</a></code>, in
   this specification) implement the following interface:</p>
 
-  <pre class=idl>interface <dfn id=htmlmediaelement>HTMLMediaElement</dfn> : <a href=#htmlelement>HTMLElement</a> {
+  <pre class=idl>enum <dfn id=canplaytypeenum>CanPlayTypeEnum</dfn> { "" /* <a href=#dom-canplaytypeenum-nil title=dom-CanPlayTypeEnum-nil>empty string</a> */, "<a href=#dom-canplaytypeenum-maybe title=dom-CanPlayTypeEnum-maybe>maybe</a>", "<a href=#dom-canplaytypeenum-probably title=dom-CanPlayTypeEnum-probably>probably</a>" };
+interface <dfn id=htmlmediaelement>HTMLMediaElement</dfn> : <a href=#htmlelement>HTMLElement</a> {
 
   // error state
   readonly attribute <a href=#mediaerror>MediaError</a>? <a href=#dom-media-error title=dom-media-error>error</a>;
@@ -26862,7 +26863,7 @@
   readonly attribute boolean <span title="dom-media-bufferingThrottled">bufferingThrottled</span>;
 -->  readonly attribute <a href=#timeranges>TimeRanges</a> <a href=#dom-media-buffered title=dom-media-buffered>buffered</a>;
   void <a href=#dom-media-load title=dom-media-load>load</a>();
-  DOMString <a href=#dom-navigator-canplaytype title=dom-navigator-canPlayType>canPlayType</a>(DOMString type);
+  <a href=#canplaytypeenum>CanPlayTypeEnum</a> <a href=#dom-navigator-canplaytype title=dom-navigator-canPlayType>canPlayType</a>(DOMString type);
 
   // ready state
   const unsigned short <a href=#dom-media-have_nothing title=dom-media-HAVE_NOTHING>HAVE_NOTHING</a> = 0;
@@ -27137,12 +27138,12 @@
 
   </dl><div class=impl>
 
-  <p>The <dfn id=dom-navigator-canplaytype title=dom-navigator-canPlayType><code>canPlayType(<var title="">type</var>)</code></dfn> method must return the empty string if <var title="">type</var>
+  <p>The <dfn id=dom-navigator-canplaytype title=dom-navigator-canPlayType><code>canPlayType(<var title="">type</var>)</code></dfn> method must return <dfn id=dom-canplaytypeenum-nil title=dom-CanPlayTypeEnum-nil>the empty string</dfn> if <var title="">type</var>
   is <a href=#a-type-that-the-user-agent-knows-it-cannot-render>a type that the user agent knows it cannot render</a> or is the type
-  "<code>application/octet-stream</code>"; it must return "<code title="">probably</code>" if the
+  "<code>application/octet-stream</code>"; it must return "<dfn id=dom-canplaytypeenum-probably title=dom-CanPlayTypeEnum-probably><code>probably</code></dfn>" if the
   user agent is confident that the type represents a <a href=#media-resource>media resource</a> that it can render
-  if used in with this <code><a href=#the-audio-element>audio</a></code> or <code><a href=#the-video-element>video</a></code> element; and it must return "<code title="">maybe</code>" otherwise. Implementors are encouraged to return "<code title="">maybe</code>" unless the type can be confidently established as being supported or not.
-  Generally, a user agent should never return "<code title="">probably</code>" for a type that
+  if used in with this <code><a href=#the-audio-element>audio</a></code> or <code><a href=#the-video-element>video</a></code> element; and it must return "<dfn id=dom-canplaytypeenum-maybe title=dom-CanPlayTypeEnum-maybe><code>maybe</code></dfn>" otherwise. Implementors are encouraged to return "<code title=dom-CanPlayTypeEnum-maybe><a href=#dom-canplaytypeenum-maybe>maybe</a></code>" unless the type can be confidently established as being supported or not.
+  Generally, a user agent should never return "<code title=dom-CanPlayTypeEnum-probably><a href=#dom-canplaytypeenum-probably>probably</a></code>" for a type that
   allows the <code title="">codecs</code> parameter if that parameter is not present.</p>
 
   </div>

Modified: source
===================================================================
--- source	2013-04-12 23:21:07 UTC (rev 7826)
+++ source	2013-04-12 23:30:29 UTC (rev 7827)
@@ -27939,6 +27939,7 @@
    </dd>
   </dl><!--TOPIC:HTML-->
 
+<!--CLEANUP-->
   <p>The <code>source</code> element allows authors to specify
   multiple alternative <span title="media resource">media
   resources</span> for <span title="media element">media
@@ -28379,7 +28380,8 @@
   <p><dfn title="media element">Media elements</dfn> (<code>audio</code> and <code>video</code>, in
   this specification) implement the following interface:</p>
 
-  <pre class="idl">interface <dfn>HTMLMediaElement</dfn> : <span>HTMLElement</span> {
+  <pre class="idl">enum <dfn>CanPlayTypeEnum</dfn> { "" /* <span title="dom-CanPlayTypeEnum-nil">empty string</span> */, "<span title="dom-CanPlayTypeEnum-maybe">maybe</span>", "<span title="dom-CanPlayTypeEnum-probably">probably</span>" };
+interface <dfn>HTMLMediaElement</dfn> : <span>HTMLElement</span> {
 
   // error state
   readonly attribute <span>MediaError</span>? <span title="dom-media-error">error</span>;
@@ -28398,7 +28400,7 @@
   readonly attribute boolean <span title="dom-media-bufferingThrottled">bufferingThrottled</span>;
 -->  readonly attribute <span>TimeRanges</span> <span title="dom-media-buffered">buffered</span>;
   void <span title="dom-media-load">load</span>();
-  DOMString <span title="dom-navigator-canPlayType">canPlayType</span>(DOMString type);
+  <span>CanPlayTypeEnum</span> <span title="dom-navigator-canPlayType">canPlayType</span>(DOMString type);
 
   // ready state
   const unsigned short <span title="dom-media-HAVE_NOTHING">HAVE_NOTHING</span> = 0;
@@ -28704,14 +28706,14 @@
   <div class="impl">
 
   <p>The <dfn title="dom-navigator-canPlayType"><code>canPlayType(<var
-  title="">type</var>)</code></dfn> method must return the empty string if <var title="">type</var>
+  title="">type</var>)</code></dfn> method must return <dfn title="dom-CanPlayTypeEnum-nil">the empty string</dfn> if <var title="">type</var>
   is <span>a type that the user agent knows it cannot render</span> or is the type
-  "<code>application/octet-stream</code>"; it must return "<code title="">probably</code>" if the
+  "<code>application/octet-stream</code>"; it must return "<dfn title="dom-CanPlayTypeEnum-probably"><code>probably</code></dfn>" if the
   user agent is confident that the type represents a <span>media resource</span> that it can render
-  if used in with this <code>audio</code> or <code>video</code> element; and it must return "<code
-  title="">maybe</code>" otherwise. Implementors are encouraged to return "<code
-  title="">maybe</code>" unless the type can be confidently established as being supported or not.
-  Generally, a user agent should never return "<code title="">probably</code>" for a type that
+  if used in with this <code>audio</code> or <code>video</code> element; and it must return "<dfn
+  title="dom-CanPlayTypeEnum-maybe"><code>maybe</code></dfn>" otherwise. Implementors are encouraged to return "<code
+  title="dom-CanPlayTypeEnum-maybe">maybe</code>" unless the type can be confidently established as being supported or not.
+  Generally, a user agent should never return "<code title="dom-CanPlayTypeEnum-probably">probably</code>" for a type that
   allows the <code title="">codecs</code> parameter if that parameter is not present.</p>
 
   </div>




More information about the Commit-Watchers mailing list