[html5] r3639 - [] (0) video: Remove the cue range API.

whatwg at whatwg.org whatwg at whatwg.org
Sun Aug 16 04:42:07 PDT 2009


Author: ianh
Date: 2009-08-16 04:42:06 -0700 (Sun, 16 Aug 2009)
New Revision: 3639

Modified:
   index
   source
Log:
[] (0) video: Remove the cue range API.

Modified: index
===================================================================
--- index	2009-08-16 11:23:59 UTC (rev 3638)
+++ index	2009-08-16 11:42:06 UTC (rev 3639)
@@ -423,13 +423,12 @@
        <li><a href=#loading-the-media-resource><span class=secno>4.8.10.5 </span>Loading the media resource</a></li>
        <li><a href=#offsets-into-the-media-resource><span class=secno>4.8.10.6 </span>Offsets into the media resource</a></li>
        <li><a href=#the-ready-states><span class=secno>4.8.10.7 </span>The ready states</a></li>
-       <li><a href=#cue-ranges><span class=secno>4.8.10.8 </span>Cue ranges</a></li>
-       <li><a href=#playing-the-media-resource><span class=secno>4.8.10.9 </span>Playing the media resource</a></li>
-       <li><a href=#seeking><span class=secno>4.8.10.10 </span>Seeking</a></li>
-       <li><a href=#user-interface><span class=secno>4.8.10.11 </span>User interface</a></li>
-       <li><a href=#time-ranges><span class=secno>4.8.10.12 </span>Time ranges</a></li>
-       <li><a href=#mediaevents><span class=secno>4.8.10.13 </span>Event summary</a></li>
-       <li><a href=#security-and-privacy-considerations><span class=secno>4.8.10.14 </span>Security and privacy considerations</a></ol></li>
+       <li><a href=#playing-the-media-resource><span class=secno>4.8.10.8 </span>Playing the media resource</a></li>
+       <li><a href=#seeking><span class=secno>4.8.10.9 </span>Seeking</a></li>
+       <li><a href=#user-interface><span class=secno>4.8.10.10 </span>User interface</a></li>
+       <li><a href=#time-ranges><span class=secno>4.8.10.11 </span>Time ranges</a></li>
+       <li><a href=#mediaevents><span class=secno>4.8.10.12 </span>Event summary</a></li>
+       <li><a href=#security-and-privacy-considerations><span class=secno>4.8.10.13 </span>Security and privacy considerations</a></ol></li>
      <li><a href=#the-canvas-element><span class=secno>4.8.11 </span>The <code>canvas</code> element</a>
       <ol>
        <li><a href=#the-2d-context><span class=secno>4.8.11.1 </span>The 2D context</a>
@@ -20376,20 +20375,22 @@
   void <a href=#dom-media-play title=dom-media-play>play</a>();
   void <a href=#dom-media-pause title=dom-media-pause>pause</a>();
 
+<!--v2CUERANGE
   // cue ranges
-  void <a href=#dom-media-addcuerange title=dom-media-addCueRange>addCueRange</a>(in DOMString className, in DOMString id, in float start, in float end, in boolean pauseOnExit, in <a href=#cuerangecallback>CueRangeCallback</a> enterCallback, in <a href=#cuerangecallback>CueRangeCallback</a> exitCallback);
-  void <a href=#dom-media-removecueranges title=dom-media-removeCueRanges>removeCueRanges</a>(in DOMString className);
+  void <span title="dom-media-addCueRange">addCueRange</span>(in DOMString className, in DOMString id, in float start, in float end, in boolean pauseOnExit, in <span>CueRangeCallback</span> enterCallback, in <span>CueRangeCallback</span> exitCallback);
+  void <span title="dom-media-removeCueRanges">removeCueRanges</span>(in DOMString className);
+-->
 
   // controls
            attribute boolean <a href=#dom-media-controls title=dom-media-controls>controls</a>;
            attribute float <a href=#dom-media-volume title=dom-media-volume>volume</a>;
            attribute boolean <a href=#dom-media-muted title=dom-media-muted>muted</a>;
-};
+};<!--v2CUERANGE
 
 [Callback=FunctionOnly, NoInterfaceObject]
-interface <dfn id=cuerangecallback>CueRangeCallback</dfn> {
-  void <span title=dom-CueRangeCallback-handleEvent>handleEvent</span>(in DOMString id);
-};</pre>
+interface <dfn>CueRangeCallback</dfn> {
+  void <span title="dom-CueRangeCallback-handleEvent">handleEvent</span>(in DOMString id);
+};--></pre>
 
   <p>The <dfn id=media-element-attributes>media element attributes</dfn>, <code title=attr-media-src><a href=#attr-media-src>src</a></code>, <code title=attr-media-autobuffer><a href=#attr-media-autobuffer>autobuffer</a></code>, <code title=attr-media-autoplay><a href=#attr-media-autoplay>autoplay</a></code>, <code title=attr-media-loop><a href=#attr-media-loop>loop</a></code>, and <code title=attr-media-controls><a href=#attr-media-controls>controls</a></code>, apply to all <a href=#media-element title="media element">media elements</a>. They are defined in
   this section.</p>
@@ -21816,16 +21817,18 @@
   </div>
 
 
+<!--v2CUERANGE
+  <h5>Cue ranges</h5>
 
-  <h5 id=cue-ranges><span class=secno>4.8.10.8 </span>Cue ranges</h5>
+  <dl class="domintro">
 
-  <dl class=domintro><dt><var title="">media</var> . <code title=dom-media-addCueRange><a href=#dom-media-addcuerange>addCueRange</a></code>(<var title="">className</var>, <var title="">id</var>, <var title="">start</var>, <var title="">end</var>, <var title="">pauseOnExit</var>, <var title="">enterCallback</var>, <var title="">exitCallback</var>)</dt>
+   <dt><var title="">media</var> . <code title="dom-media-addCueRange">addCueRange</code>(<var title="">className</var>, <var title="">id</var>, <var title="">start</var>, <var title="">end</var>, <var title="">pauseOnExit</var>, <var title="">enterCallback</var>, <var title="">exitCallback</var>)</dt>
 
    <dd>
 
     <p>Registers a range of time, given in seconds, and a pair of
     callbacks, the first of which will be invoked when the
-    <a href=#current-playback-position>current playback position</a> enters the range, and the
+    <span>current playback position</span> enters the range, and the
     second of which will be invoked when it exits the range. The
     callbacks are invoked with the given ID as their argument.</p>
 
@@ -21835,7 +21838,7 @@
 
    </dd>
 
-   <dt><var title="">media</var> . <code title=dom-media-removeCueRange>removeCueRange</code>(<var title="">className</var>)</dt>
+   <dt><var title="">media</var> . <code title="dom-media-removeCueRange">removeCueRange</code>(<var title="">className</var>)</dt>
 
    <dd>
 
@@ -21844,59 +21847,76 @@
 
    </dd>
 
-  </dl><div class=impl>
+  </dl>
 
-  <p><a href=#media-element title="media element">Media elements</a> have a set of
-  <dfn id=cue-range title="cue range">cue ranges</dfn>. Each cue range is made up
+  <div class="impl">
+
+  <p><span title="media element">Media elements</span> have a set of
+  <dfn title="cue range">cue ranges</dfn>. Each cue range is made up
   of the following information:</p>
 
-  <dl><dt>A class name</dt>
+  <dl>
+
+   <dt>A class name</dt>
    <dd>A group of related ranges can be given the same class name so
    that they can all be removed at the same time.</dd>
 
    <dt>An identifier<dt>
-   </dt><dd>A string can be assigned to each cue range for identification
+   <dd>A string can be assigned to each cue range for identification
    by script. The string need not be unique and can contain any
    value.</dd>
 
    <dt>A start time</dt>
    <dt>An end time</dt>
    <dd>The actual time range, using the same timeline as the
-   <a href=#media-resource>media resource</a> itself.</dd>
+   <span>media resource</span> itself.</dd>
 
    <dt>A "pause" boolean</dt>
    <dd>A flag indicating whether to pause playback on exit.</dd>
 
    <dt>An "enter" callback</dt>
-   <dd>A callback that is called when the <a href=#current-playback-position>current playback
-   position</a> enters the range.</dd>
+   <dd>A callback that is called when the <span>current playback
+   position</span> enters the range.</dd>
 
    <dt>An "exit" callback</dt>
-   <dd>A callback that is called when the <a href=#current-playback-position>current playback
-   position</a> exits the range.</dd>
+   <dd>A callback that is called when the <span>current playback
+   position</span> exits the range.</dd>
 
    <dt>An "active" boolean</dt>
    <dd>A flag indicating whether the range is active or not.</dd>
 
-  </dl><p>The <dfn id=dom-media-addcuerange title=dom-media-addCueRange><code>addCueRange(<var title="">className</var>, <var title="">id</var>, <var title="">start</var>, <var title="">end</var>, <var title="">pauseOnExit</var>, <var title="">enterCallback</var>, <var title="">exitCallback</var>)</code></dfn> method must, when called,
-  add a <a href=#cue-range>cue range</a> to the <a href=#media-element>media element</a>, that
+  </dl>
+
+  <p>The <dfn title="dom-media-addCueRange"><code>addCueRange(<var
+  title="">className</var>, <var title="">id</var>, <var
+  title="">start</var>, <var title="">end</var>, <var
+  title="">pauseOnExit</var>, <var title="">enterCallback</var>, <var
+  title="">exitCallback</var>)</code></dfn> method must, when called,
+  add a <span>cue range</span> to the <span>media element</span>, that
   cue range having the class name <var title="">className</var>, the
-  identifier <var title="">id</var>, the start time <var title="">start</var> (in seconds), the end time <var title="">end</var> (in seconds), the "pause" boolean with the same
-  value as <var title="">pauseOnExit</var>, the "enter" callback <var title="">enterCallback</var>, the "exit" callback <var title="">exitCallback</var>, and an "active" boolean that is true if
-  the <a href=#current-playback-position>current playback position</a> is equal to or greater
+  identifier <var title="">id</var>, the start time <var
+  title="">start</var> (in seconds), the end time <var
+  title="">end</var> (in seconds), the "pause" boolean with the same
+  value as <var title="">pauseOnExit</var>, the "enter" callback <var
+  title="">enterCallback</var>, the "exit" callback <var
+  title="">exitCallback</var>, and an "active" boolean that is true if
+  the <span>current playback position</span> is equal to or greater
   than the start time and less than the end time, and false
   otherwise.</p>
 
-  <p>The <dfn id=dom-media-removecueranges title=dom-media-removeCueRanges><code>removeCueRanges(<var title="">className</var>)</code></dfn> method must, when called,
-  remove all the <a href=#cue-range title="cue range">cue ranges</a> of the
-  <a href=#media-element>media element</a> which have the class name <var title="">className</var>.</p>
+  <p>The <dfn
+  title="dom-media-removeCueRanges"><code>removeCueRanges(<var
+  title="">className</var>)</code></dfn> method must, when called,
+  remove all the <span title="cue range">cue ranges</span> of the
+  <span>media element</span> which have the class name <var
+  title="">className</var>.</p>
 
   </div>
+-->
 
 
+  <h5 id=playing-the-media-resource><span class=secno>4.8.10.8 </span>Playing the media resource</h5>
 
-  <h5 id=playing-the-media-resource><span class=secno>4.8.10.9 </span>Playing the media resource</h5>
-
   <dl class=domintro><dt><var title="">media</var> . <code title=dom-media-paused><a href=#dom-media-paused>paused</a></code></dt>
 
    <dd>
@@ -22242,21 +22262,22 @@
   certain ranges to be skipped over as the user agent rushes ahead to
   "catch up".)</p>
 
-  <ol><li><p>Let <var title="">current ranges</var> be an ordered list of
-   <a href=#cue-range title="cue range">cue ranges</a>, initialized to contain
-   all the <a href=#cue-range title="cue range">cue ranges</a> of the
-   <a href=#media-element>media element</a> whose start times are less than or equal
-   to the <a href=#current-playback-position>current playback position</a> and whose end times
-   are greater than the <a href=#current-playback-position>current playback position</a>, in the
-   order they were added to the element.</li>
+  <ol><!--v2CUERANGE
+   <li><p>Let <var title="">current ranges</var> be an ordered list of
+   <span title="cue range">cue ranges</span>, initialized to contain
+   all the <span title="cue range">cue ranges</span> of the
+   <span>media element</span> whose start times are less than or equal
+   to the <span>current playback position</span> and whose end times
+   are greater than the <span>current playback position</span>, in the
+   order they were added to the element.</p></li>
 
    <li><p>Let <var title="">other ranges</var> be an ordered list of
-   <a href=#cue-range title="cue range">cue ranges</a>, initialized to contain
-   all the <a href=#cue-range title="cue range">cue ranges</a> of the
-   <a href=#media-element>media element</a> that are not present in <var title="">current ranges</var>, in the order they were added to the
-   element.</li>
-
-   <li><p>If the time was reached through the usual monotonic increase
+   <span title="cue range">cue ranges</span>, initialized to contain
+   all the <span title="cue range">cue ranges</span> of the
+   <span>media element</span> that are not present in <var
+   title="">current ranges</var>, in the order they were added to the
+   element.</p></li>
+--><li><p>If the time was reached through the usual monotonic increase
    of the current playback position during normal playback, and if the
    user agent has not fired a <code title=event-timeupdate><a href=#event-timeupdate>timeupdate</a></code> event at the element in
    the past 15 to 250ms, then the user agent must <a href=#queue-a-task>queue a
@@ -22271,44 +22292,47 @@
    cost of processing the event each time, so that the UI updates are
    not any more frequent than the user agent can comfortably handle
    while decoding the video.</li>
-
-   <li><p>If none of the <a href=#cue-range title="cue range">cue ranges</a> in
+<!--v2CUERANGE [beware - - nested comments]
+   <li><p>If none of the <span title="cue range">cue ranges</span> in
    <var title="">current ranges</var> have their "active" boolean set
-   to "false" (inactive) and none of the <a href=#cue-range title="cue range">cue
-   ranges</a> in <var title="">other ranges</var> have their
+   to "false" (inactive) and none of the <span title="cue range">cue
+   ranges</span> in <var title="">other ranges</var> have their
    "active" boolean set to "true" (active), then abort these
-   steps.</li>
+   steps.</p></li>
 
    <li><p>If the time was reached through the usual monotonic increase
    of the current playback position during normal playback, and there
-   are <a href=#cue-range title="cue range">cue ranges</a> in <var title="">other ranges</var> that have both their "active" boolean
+   are <span title="cue range">cue ranges</span> in <var
+   title="">other ranges</var> that have both their "active" boolean
    and their "pause" boolean set to "true", then immediately act as if
-   the element's <code title=dom-media-pause><a href=#dom-media-pause>pause()</a></code> method
-   had been invoked. <!-- pause() can in theory call load(), but never
+   the element's <code title="dom-media-pause">pause()</code> method
+   had been invoked. <!- - pause() can in theory call load(), but never
    can it do so as part of this invokation, since we wouldn't be in
    this algorithm if the media element was empty. So, no need to couch
-   all this in a task. --> (In the other cases, such as explicit
+   all this in a task. - -> (In the other cases, such as explicit
    seeks, playback is not paused by exiting a cue range, even if that
-   cue range has its "pause" boolean set to "true".)</li>
+   cue range has its "pause" boolean set to "true".)</p></li>
 
-   <li><p>For each non-null "exit" callback of the <a href=#cue-range title="cue range">cue ranges</a> in <var title="">other
+   <li><p>For each non-null "exit" callback of the <span
+   title="cue range">cue ranges</span> in <var title="">other
    ranges</var> that have their "active" boolean set to "true"
-   (active), in list order, <a href=#queue-a-task>queue a task</a> that invokes the
+   (active), in list order, <span>queue a task</span> that invokes the
    callback, passing the cue range's identifier as the callback's only
-   argument.</li>
+   argument.</p></li>
 
-   <li><p>For each non-null "enter" callback of the <a href=#cue-range title="cue
-   range">cue ranges</a> in <var title="">current ranges</var> that
+   <li><p>For each non-null "enter" callback of the <span title="cue
+   range">cue ranges</span> in <var title="">current ranges</var> that
    have their "active" boolean set to "false" (inactive), in list
-   order, <a href=#queue-a-task>queue a task</a> that invokes the callback, passing
+   order, <span>queue a task</span> that invokes the callback, passing
    the cue range's identifier as the callback's only
-   argument.</li>
+   argument.</p></li>
 
-   <li><p>Set the "active" boolean of all the <a href=#cue-range title="cue
-   range">cue ranges</a> in the <var title="">current ranges</var>
-   list to "true" (active), and the "active" boolean of all the <a href=#cue-range title="cue range">cue ranges</a> in the <var title="">other
-   ranges</var> list to "false" (inactive).</li>
-
+   <li><p>Set the "active" boolean of all the <span title="cue
+   range">cue ranges</span> in the <var title="">current ranges</var>
+   list to "true" (active), and the "active" boolean of all the <span
+   title="cue range">cue ranges</span> in the <var title="">other
+   ranges</var> list to "false" (inactive).</p></li>
+-->
   </ol><p>When a <a href=#media-element>media element</a> is <a href=#remove-an-element-from-a-document title="remove an
   element from a document">removed from a
   <code>Document</code></a>, if the <a href=#media-element>media element</a>'s
@@ -22325,7 +22349,7 @@
 
 
 
-  <h5 id=seeking><span class=secno>4.8.10.10 </span>Seeking</h5>
+  <h5 id=seeking><span class=secno>4.8.10.9 </span>Seeking</h5>
 
   <dl class=domintro><dt><var title="">media</var> . <code title=dom-media-seeking><a href=#dom-media-seeking>seeking</a></code></dt>
 
@@ -22441,7 +22465,7 @@
   </div>
 
 
-  <h5 id=user-interface><span class=secno>4.8.10.11 </span>User interface</h5>
+  <h5 id=user-interface><span class=secno>4.8.10.10 </span>User interface</h5>
 
   <p>The <dfn id=attr-media-controls title=attr-media-controls><code>controls</code></dfn>
   attribute is a <a href=#boolean-attribute>boolean attribute</a>. If present, it
@@ -22548,7 +22572,7 @@
 
 
 
-  <h5 id=time-ranges><span class=secno>4.8.10.12 </span>Time ranges</h5>
+  <h5 id=time-ranges><span class=secno>4.8.10.11 </span>Time ranges</h5>
 
   <p>Objects implementing the <code><a href=#timeranges>TimeRanges</a></code> interface
   represent a list of ranges (periods) of time.</p>
@@ -22626,7 +22650,7 @@
   </div>
 
 
-  <h5 id=mediaevents><span class=secno>4.8.10.13 </span>Event summary</h5>
+  <h5 id=mediaevents><span class=secno>4.8.10.12 </span>Event summary</h5>
 
   <p>The following events fire on <a href=#media-element title="media element">media
   elements</a> as part of the processing model described above:</p>
@@ -22736,7 +22760,7 @@
      <td>
   </table><div class=impl>
 
-  <h5 id=security-and-privacy-considerations><span class=secno>4.8.10.14 </span>Security and privacy considerations</h5>
+  <h5 id=security-and-privacy-considerations><span class=secno>4.8.10.13 </span>Security and privacy considerations</h5>
 
   <p>The main security and privacy implications of the
   <code><a href=#video>video</a></code> and <code><a href=#audio>audio</a></code> elements come from the

Modified: source
===================================================================
--- source	2009-08-16 11:23:59 UTC (rev 3638)
+++ source	2009-08-16 11:42:06 UTC (rev 3639)
@@ -21855,20 +21855,22 @@
   void <span title="dom-media-play">play</span>();
   void <span title="dom-media-pause">pause</span>();
 
+<!--v2CUERANGE
   // cue ranges
   void <span title="dom-media-addCueRange">addCueRange</span>(in DOMString className, in DOMString id, in float start, in float end, in boolean pauseOnExit, in <span>CueRangeCallback</span> enterCallback, in <span>CueRangeCallback</span> exitCallback);
   void <span title="dom-media-removeCueRanges">removeCueRanges</span>(in DOMString className);
+-->
 
   // controls
            attribute boolean <span title="dom-media-controls">controls</span>;
            attribute float <span title="dom-media-volume">volume</span>;
            attribute boolean <span title="dom-media-muted">muted</span>;
-};
+};<!--v2CUERANGE
 
 [Callback=FunctionOnly, NoInterfaceObject]
 interface <dfn>CueRangeCallback</dfn> {
   void <span title="dom-CueRangeCallback-handleEvent">handleEvent</span>(in DOMString id);
-};</pre>
+};--></pre>
 
   <p>The <dfn>media element attributes</dfn>, <code
   title="attr-media-src">src</code>, <code
@@ -23581,7 +23583,7 @@
   </div>
 
 
-
+<!--v2CUERANGE
   <h5>Cue ranges</h5>
 
   <dl class="domintro">
@@ -23676,9 +23678,9 @@
   title="">className</var>.</p>
 
   </div>
+-->
 
 
-
   <h5>Playing the media resource</h5>
 
   <dl class="domintro">
@@ -24101,6 +24103,7 @@
 
   <ol>
 
+<!--v2CUERANGE
    <li><p>Let <var title="">current ranges</var> be an ordered list of
    <span title="cue range">cue ranges</span>, initialized to contain
    all the <span title="cue range">cue ranges</span> of the
@@ -24115,7 +24118,7 @@
    <span>media element</span> that are not present in <var
    title="">current ranges</var>, in the order they were added to the
    element.</p></li>
-
+-->
    <li><p>If the time was reached through the usual monotonic increase
    of the current playback position during normal playback, and if the
    user agent has not fired a <code
@@ -24133,7 +24136,7 @@
    cost of processing the event each time, so that the UI updates are
    not any more frequent than the user agent can comfortably handle
    while decoding the video.</p></li>
-
+<!--v2CUERANGE [beware - - nested comments]
    <li><p>If none of the <span title="cue range">cue ranges</span> in
    <var title="">current ranges</var> have their "active" boolean set
    to "false" (inactive) and none of the <span title="cue range">cue
@@ -24147,10 +24150,10 @@
    title="">other ranges</var> that have both their "active" boolean
    and their "pause" boolean set to "true", then immediately act as if
    the element's <code title="dom-media-pause">pause()</code> method
-   had been invoked. <!-- pause() can in theory call load(), but never
+   had been invoked. <!- - pause() can in theory call load(), but never
    can it do so as part of this invokation, since we wouldn't be in
    this algorithm if the media element was empty. So, no need to couch
-   all this in a task. --> (In the other cases, such as explicit
+   all this in a task. - -> (In the other cases, such as explicit
    seeks, playback is not paused by exiting a cue range, even if that
    cue range has its "pause" boolean set to "true".)</p></li>
 
@@ -24173,7 +24176,7 @@
    list to "true" (active), and the "active" boolean of all the <span
    title="cue range">cue ranges</span> in the <var title="">other
    ranges</var> list to "false" (inactive).</p></li>
-
+-->
   </ol>
 
   <p>When a <span>media element</span> is <span title="remove an




More information about the Commit-Watchers mailing list