[giow] (0) Captions - Stage 20.5: more wip for API definitions.

git-svn-id: http://svn.whatwg.org/webapps@5142 340c8d12-0b0e-0410-8428-c7bf67bfef74
whatwg · Jul 8, 2010 · 57e002c · 57e002c
1 parent 935de44
commit 57e002c
Show file tree

Hide file tree

Showing 3 changed files with 152 additions and 68 deletions.
diff --git a/complete.html b/complete.html
@@ -26916,14 +26916,15 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
   </dl><p>If the <a href=#timed-track-mode>timed track mode</a> of the <a href=#timed-track>timed
   track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents is
   not the <a href=#timed-track-disabled>timed track disabled</a> mode, then the <dfn id=dom-timedtrack-cues title=dom-TimedTrack-cues><code>cues</code></dfn> attribute must
-  return a <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that represents the
-  subset of the <a href=#timed-track-list-of-cues>timed track list of cues</a> of the
-  <a href=#timed-track>timed track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object
-  represents whose <a href=#timed-track-cue-start-time title="timed track cue start time">start
-  times</a> occur before the <a href=#earliest-possible-position-when-the-script-started>earliest possible position when
-  the script started</a>, in <a href=#timed-track-cue-order>timed track cue
-  order</a>. Otherwise, it must return null. When an object is
-  returned, the same object must be returned each time.</p>
+  return a <a href=#live>live</a> <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object
+  that represents the subset of the <a href=#timed-track-list-of-cues>timed track list of
+  cues</a> of the <a href=#timed-track>timed track</a> that the
+  <code><a href=#timedtrack>TimedTrack</a></code> object represents whose <a href=#timed-track-cue-start-time title="timed
+  track cue start time">start times</a> occur before the
+  <a href=#earliest-possible-position-when-the-script-started>earliest possible position when the script started</a>, in
+  <a href=#timed-track-cue-order>timed track cue order</a>. Otherwise, it must return
+  null. When an object is returned, the same object must be returned
+  each time.</p>
 
   <p>The <dfn id=earliest-possible-position-when-the-script-started>earliest possible position when the script started</dfn>
   is whatever the <a href=#earliest-possible-position>earliest possible position</a> was the last
@@ -26932,16 +26933,17 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
   <p>If the <a href=#timed-track-mode>timed track mode</a> of the <a href=#timed-track>timed
   track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents is
   not the <a href=#timed-track-disabled>timed track disabled</a> mode, then the <dfn id=dom-timedtrack-activecues title=dom-TimedTrack-activeCues><code>activeCues</code></dfn>
-  attribute must return a <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that
-  represents the subset of the <a href=#timed-track-list-of-cues>timed track list of cues</a>
-  of the <a href=#timed-track>timed track</a> that the <code><a href=#timedtrack>TimedTrack</a></code>
-  object represents whose <a href=#timed-track-cue-start-time title="timed track cue start
-  time">start times</a> occur before the <a href=#current-playback-position-when-the-script-started>current playback
-  position when the script started</a> and whose <a href=#timed-track-cue-end-time title="timed
-  track cue end time">end times</a> occur after the <a href=#current-playback-position-when-the-script-started>current
-  playback position when the script started</a>, in <a href=#timed-track-cue-order>timed
-  track cue order</a>. Otherwise, it must return null. When an
-  object is returned, the same object must be returned each time.</p>
+  attribute must return a <a href=#live>live</a>
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that represents the subset of
+  the <a href=#timed-track-list-of-cues>timed track list of cues</a> of the <a href=#timed-track>timed
+  track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents
+  whose <a href=#timed-track-cue-start-time title="timed track cue start time">start times</a>
+  occur before the <a href=#current-playback-position-when-the-script-started>current playback position when the script
+  started</a> and whose <a href=#timed-track-cue-end-time title="timed track cue end time">end
+  times</a> occur after the <a href=#current-playback-position-when-the-script-started>current playback position when
+  the script started</a>, in <a href=#timed-track-cue-order>timed track cue
+  order</a>. Otherwise, it must return null. When an object is
+  returned, the same object must be returned each time.</p>
 
   <p>The <dfn id=current-playback-position-when-the-script-started>current playback position when the script started</dfn>
   is whatever the <a href=#current-playback-position>current playback position</a> was the last
@@ -27064,31 +27066,56 @@ <h6 id=timed-track-api><span class=secno>4.8.10.10.5 </span>Timed track API</h6>
   </ol></div>
 
   <hr><pre class=idl>interface <dfn id=timedtrackcuelist>TimedTrackCueList</dfn> {
-  readonly attribute unsigned long <span title=dom-TimedTrackCueList-length>length</span>;
+  readonly attribute unsigned long <a href=#dom-timedtrackcuelist-length title=dom-TimedTrackCueList-length>length</a>;
   getter <a href=#timedtrackcue>TimedTrackCue</a> (in unsigned long index);
-  <a href=#timedtrackcue>TimedTrackCue</a> <span title=dom-TimedTrackCueList-getCueById>getCueById</span>(in DOMString id);
+  <a href=#timedtrackcue>TimedTrackCue</a> <a href=#dom-timedtrackcuelist-getcuebyid title=dom-TimedTrackCueList-getCueById>getCueById</a>(in DOMString id);
 };</pre>
 
-  <dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length>length</code></dt>
+  <dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length><a href=#dom-timedtrackcuelist-length>length</a></code></dt>
    <dd>
     <p>Returns the number of <a href=#timed-track-cue title="timed track cue">cues</a> in the list.</p>
    </dd>
 
    <dt><var title="">cuelist</var>[<var title="">index</var>]</dt>
    <dd>
     <p>Returns the <a href=#timed-track-cue>timed track cue</a> with index <var title="">index</var> in the list. The cues are sorted in <a href=#timed-track-cue-order>timed track cue order</a>.</p>
-    <p>Returns null if <var title="">index</var> is out of range.</p>
    </dd>
 
-   <dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-getCueById>getCueById</code>( <var title="">id</var> )</dt>
+   <dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-getCueById><a href=#dom-timedtrackcuelist-getcuebyid>getCueById</a></code>( <var title="">id</var> )</dt>
    <dd>
     <p>Returns the first <a href=#timed-track-cue>timed track cue</a> (in <a href=#timed-track-cue-order>timed track cue order</a>) with <a href=#timed-track-cue-identifier>timed track cue identifier</a> <var title="">id</var>.</p>
     <p>Returns null if none of the cues have the given identifier.</p>
    </dd>
 
   </dl><div class=impl>
 
-  <p class=XXX>...</p>
+  <p>A <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object represents a dynamically
+  updating list of <a href=#timed-track-cue title="timed track cue">timed track
+  cues</a> in a given order.</p>
+
+  <p>The <dfn id=dom-timedtrackcuelist-length title=dom-TimedTrackCueList-length><code>length</code></dfn>
+  attribute must return the number of <a href=#timed-track-cue title="timed track
+  cue">cues</a> in the list represented by the
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object.</p>
+
+  <p>The <span>supported property indicies</span> of a
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object at any instant are the numbers
+  from zero to the number of <a href=#timed-track-cue title="timed track cue">cues</a>
+  in the list represented by the <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object
+  minus one, if any. If there are no <a href=#timed-track-cue title="timed track
+  cue">cues</a> in the list, there are no <span>supported property
+  indicies</span>.</p>
+
+  <p>To <span>determine the value of an indexed property</span> for a
+  given index <var title="">index</var>, the user agent must return
+  the <var title="">index</var>th <a href=#timed-track-cue>timed track cue</a> in the
+  list represented by the <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object.</p>
+
+  <p>The <dfn id=dom-timedtrackcuelist-getcuebyid title=dom-TimedTrackCueList-getCueById><code>getCueById(<var title="">id</var>)</code></dfn> method must return the first
+  <a href=#timed-track-cue>timed track cue</a> in the list represented by the
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object whose <a href=#timed-track-cue-identifier>timed track cue
+  identifier</a> is <var title="">id</var>, if any, or null
+  otherwise.</p>
 
   </div>
 

diff --git a/index b/index
@@ -26843,14 +26843,15 @@ interface <dfn id=htmlaudioelement>HTMLAudioElement</dfn> : <a href=#htmlmediael
   </dl><p>If the <a href=#timed-track-mode>timed track mode</a> of the <a href=#timed-track>timed
   track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents is
   not the <a href=#timed-track-disabled>timed track disabled</a> mode, then the <dfn id=dom-timedtrack-cues title=dom-TimedTrack-cues><code>cues</code></dfn> attribute must
-  return a <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that represents the
-  subset of the <a href=#timed-track-list-of-cues>timed track list of cues</a> of the
-  <a href=#timed-track>timed track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object
-  represents whose <a href=#timed-track-cue-start-time title="timed track cue start time">start
-  times</a> occur before the <a href=#earliest-possible-position-when-the-script-started>earliest possible position when
-  the script started</a>, in <a href=#timed-track-cue-order>timed track cue
-  order</a>. Otherwise, it must return null. When an object is
-  returned, the same object must be returned each time.</p>
+  return a <a href=#live>live</a> <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object
+  that represents the subset of the <a href=#timed-track-list-of-cues>timed track list of
+  cues</a> of the <a href=#timed-track>timed track</a> that the
+  <code><a href=#timedtrack>TimedTrack</a></code> object represents whose <a href=#timed-track-cue-start-time title="timed
+  track cue start time">start times</a> occur before the
+  <a href=#earliest-possible-position-when-the-script-started>earliest possible position when the script started</a>, in
+  <a href=#timed-track-cue-order>timed track cue order</a>. Otherwise, it must return
+  null. When an object is returned, the same object must be returned
+  each time.</p>
 
   <p>The <dfn id=earliest-possible-position-when-the-script-started>earliest possible position when the script started</dfn>
   is whatever the <a href=#earliest-possible-position>earliest possible position</a> was the last
@@ -26859,16 +26860,17 @@ interface <dfn id=htmlaudioelement>HTMLAudioElement</dfn> : <a href=#htmlmediael
   <p>If the <a href=#timed-track-mode>timed track mode</a> of the <a href=#timed-track>timed
   track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents is
   not the <a href=#timed-track-disabled>timed track disabled</a> mode, then the <dfn id=dom-timedtrack-activecues title=dom-TimedTrack-activeCues><code>activeCues</code></dfn>
-  attribute must return a <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that
-  represents the subset of the <a href=#timed-track-list-of-cues>timed track list of cues</a>
-  of the <a href=#timed-track>timed track</a> that the <code><a href=#timedtrack>TimedTrack</a></code>
-  object represents whose <a href=#timed-track-cue-start-time title="timed track cue start
-  time">start times</a> occur before the <a href=#current-playback-position-when-the-script-started>current playback
-  position when the script started</a> and whose <a href=#timed-track-cue-end-time title="timed
-  track cue end time">end times</a> occur after the <a href=#current-playback-position-when-the-script-started>current
-  playback position when the script started</a>, in <a href=#timed-track-cue-order>timed
-  track cue order</a>. Otherwise, it must return null. When an
-  object is returned, the same object must be returned each time.</p>
+  attribute must return a <a href=#live>live</a>
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object that represents the subset of
+  the <a href=#timed-track-list-of-cues>timed track list of cues</a> of the <a href=#timed-track>timed
+  track</a> that the <code><a href=#timedtrack>TimedTrack</a></code> object represents
+  whose <a href=#timed-track-cue-start-time title="timed track cue start time">start times</a>
+  occur before the <a href=#current-playback-position-when-the-script-started>current playback position when the script
+  started</a> and whose <a href=#timed-track-cue-end-time title="timed track cue end time">end
+  times</a> occur after the <a href=#current-playback-position-when-the-script-started>current playback position when
+  the script started</a>, in <a href=#timed-track-cue-order>timed track cue
+  order</a>. Otherwise, it must return null. When an object is
+  returned, the same object must be returned each time.</p>
 
   <p>The <dfn id=current-playback-position-when-the-script-started>current playback position when the script started</dfn>
   is whatever the <a href=#current-playback-position>current playback position</a> was the last
@@ -26991,31 +26993,56 @@ interface <dfn id=htmlaudioelement>HTMLAudioElement</dfn> : <a href=#htmlmediael
   </ol></div>
 
   <hr><pre class=idl>interface <dfn id=timedtrackcuelist>TimedTrackCueList</dfn> {
-  readonly attribute unsigned long <span title=dom-TimedTrackCueList-length>length</span>;
+  readonly attribute unsigned long <a href=#dom-timedtrackcuelist-length title=dom-TimedTrackCueList-length>length</a>;
   getter <a href=#timedtrackcue>TimedTrackCue</a> (in unsigned long index);
-  <a href=#timedtrackcue>TimedTrackCue</a> <span title=dom-TimedTrackCueList-getCueById>getCueById</span>(in DOMString id);
+  <a href=#timedtrackcue>TimedTrackCue</a> <a href=#dom-timedtrackcuelist-getcuebyid title=dom-TimedTrackCueList-getCueById>getCueById</a>(in DOMString id);
 };</pre>
 
-  <dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length>length</code></dt>
+  <dl class=domintro><dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-length><a href=#dom-timedtrackcuelist-length>length</a></code></dt>
    <dd>
     <p>Returns the number of <a href=#timed-track-cue title="timed track cue">cues</a> in the list.</p>
    </dd>
 
    <dt><var title="">cuelist</var>[<var title="">index</var>]</dt>
    <dd>
     <p>Returns the <a href=#timed-track-cue>timed track cue</a> with index <var title="">index</var> in the list. The cues are sorted in <a href=#timed-track-cue-order>timed track cue order</a>.</p>
-    <p>Returns null if <var title="">index</var> is out of range.</p>
    </dd>
 
-   <dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-getCueById>getCueById</code>( <var title="">id</var> )</dt>
+   <dt><var title="">cuelist</var> . <code title=dom-TimedTrackCueList-getCueById><a href=#dom-timedtrackcuelist-getcuebyid>getCueById</a></code>( <var title="">id</var> )</dt>
    <dd>
     <p>Returns the first <a href=#timed-track-cue>timed track cue</a> (in <a href=#timed-track-cue-order>timed track cue order</a>) with <a href=#timed-track-cue-identifier>timed track cue identifier</a> <var title="">id</var>.</p>
     <p>Returns null if none of the cues have the given identifier.</p>
    </dd>
 
   </dl><div class=impl>
 
-  <p class=XXX>...</p>
+  <p>A <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object represents a dynamically
+  updating list of <a href=#timed-track-cue title="timed track cue">timed track
+  cues</a> in a given order.</p>
+
+  <p>The <dfn id=dom-timedtrackcuelist-length title=dom-TimedTrackCueList-length><code>length</code></dfn>
+  attribute must return the number of <a href=#timed-track-cue title="timed track
+  cue">cues</a> in the list represented by the
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object.</p>
+
+  <p>The <span>supported property indicies</span> of a
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object at any instant are the numbers
+  from zero to the number of <a href=#timed-track-cue title="timed track cue">cues</a>
+  in the list represented by the <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object
+  minus one, if any. If there are no <a href=#timed-track-cue title="timed track
+  cue">cues</a> in the list, there are no <span>supported property
+  indicies</span>.</p>
+
+  <p>To <span>determine the value of an indexed property</span> for a
+  given index <var title="">index</var>, the user agent must return
+  the <var title="">index</var>th <a href=#timed-track-cue>timed track cue</a> in the
+  list represented by the <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object.</p>
+
+  <p>The <dfn id=dom-timedtrackcuelist-getcuebyid title=dom-TimedTrackCueList-getCueById><code>getCueById(<var title="">id</var>)</code></dfn> method must return the first
+  <a href=#timed-track-cue>timed track cue</a> in the list represented by the
+  <code><a href=#timedtrackcuelist>TimedTrackCueList</a></code> object whose <a href=#timed-track-cue-identifier>timed track cue
+  identifier</a> is <var title="">id</var>, if any, or null
+  otherwise.</p>
 
   </div>