Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[giow] (1) Split TextTrackCue into an abstract TextTrackCue interface…
… and a WebVTT-specific interface WebVTTCue.

Affected topics: Video Text Tracks

git-svn-id: http://svn.whatwg.org/webapps@7742 340c8d12-0b0e-0410-8428-c7bf67bfef74
  • Loading branch information
Hixie committed Mar 8, 2013
1 parent 207a803 commit 8866ad0
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 47 deletions.
35 changes: 19 additions & 16 deletions complete.html
Expand Up @@ -248,7 +248,7 @@

<header class=head id=head><p><a class=logo href=http://www.whatwg.org/><img alt=WHATWG height=101 src=/images/logo width=101></a></p>
<hgroup><h1 class=allcaps>HTML</h1>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 7 March 2013</h2>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 8 March 2013</h2>
</hgroup><dl><dt><strong>Web developer edition:</strong></dt>
<dd><strong><a href=http://developers.whatwg.org/>http://developers.whatwg.org/</a></strong></dd>
<dt>Multiple-page version:</dt>
Expand Down Expand Up @@ -31549,7 +31549,7 @@ <h6 id=text-track-api><span class=secno>4.8.10.12.5 </span>Text track API</h6>

// add sounds we care about
function addFX(start, end, name) {
var cue = new TextTrackCue(start, end, '');
var cue = new WebVTTCue(start, end, '');
cue.id = name;
cue.pauseOnExit = true;
sounds.addCue(cue);
Expand Down Expand Up @@ -31620,11 +31620,15 @@ <h6 id=text-track-api><span class=secno>4.8.10.12.5 </span>Text track API</h6>

</div>

<hr><pre class=idl>enum <dfn id=autokeyword>AutoKeyword</dfn> { "auto" };
[<a href=#dom-texttrackcue title=dom-TextTrackCue>Constructor</a>(double startTime, double endTime, DOMString text)]
interface <dfn id=texttrackcue>TextTrackCue</dfn> : <a href=#eventtarget>EventTarget</a> {
<hr><pre class=idl>interface <dfn id=texttrackcue>TextTrackCue</dfn> : <a href=#eventtarget>EventTarget</a> {
readonly attribute <a href=#texttrack>TextTrack</a>? <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onenter title=handler-TextTrackCue-onenter>onenter</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onexit title=handler-TextTrackCue-onexit>onexit</a>;
};

enum <dfn id=autokeyword>AutoKeyword</dfn> { "auto" };
[<a href=#dom-texttrackcue title=dom-TextTrackCue>Constructor</a>(double startTime, double endTime, DOMString text)]
interface <dfn id=webvttcue>WebVTTCue</dfn> : <a href=#texttrackcue>TextTrackCue</a> {
attribute DOMString <a href=#dom-texttrackcue-id title=dom-TextTrackCue-id>id</a>;
attribute double <a href=#dom-texttrackcue-starttime title=dom-TextTrackCue-startTime>startTime</a>;
attribute double <a href=#dom-texttrackcue-endtime title=dom-TextTrackCue-endTime>endTime</a>;
Expand All @@ -31637,26 +31641,24 @@ <h6 id=text-track-api><span class=secno>4.8.10.12.5 </span>Text track API</h6>
attribute DOMString <a href=#dom-texttrackcue-align title=dom-TextTrackCue-align>align</a>;
attribute DOMString <a href=#dom-texttrackcue-text title=dom-TextTrackCue-text>text</a>;
<a href=#documentfragment>DocumentFragment</a> <a href=#dom-texttrackcue-getcueashtml title=dom-TextTrackCue-getCueAsHTML>getCueAsHTML</a>();

attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onenter title=handler-TextTrackCue-onenter>onenter</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onexit title=handler-TextTrackCue-onexit>onexit</a>;
};</pre>

<dl class=domintro><dt><var title="">cue</var> = new <code title=dom-TextTrackCue><a href=#dom-texttrackcue>TextTrackCue</a></code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dl class=domintro><dt><var title="">cue</var> . <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a></dt>
<dd>
<p>Returns the <code><a href=#texttrack>TextTrack</a></code> object to which this
<a href=#text-track-cue>text track cue</a> belongs, if any, or null
otherwise.</p>
</dd>


<dt><var title="">cue</var> = new <code title=dom-TextTrackCue><a href=#dom-texttrackcue>WebVTTCue</a></code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dd>
<p>Returns a new <code><a href=#texttrackcue>TextTrackCue</a></code> object, for use with the <code title=dom-TextTrack-addCue><a href=#dom-texttrack-addcue>addCue()</a></code> method.</p>
<p>The <var title="">startTime</var> argument sets the <a href=#text-track-cue-start-time>text track cue start time</a>.</p>
<p>The <var title="">endTime</var> argument sets the <a href=#text-track-cue-end-time>text track cue end time</a>.</p>
<p>The <var title="">text</var> argument sets the <a href=#text-track-cue-text>text track cue text</a>.</p>
</dd>

<dt><var title="">cue</var> . <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a></dt>
<dd>
<p>Returns the <code><a href=#texttrack>TextTrack</a></code> object to which this
<a href=#text-track-cue>text track cue</a> belongs, if any, or null
otherwise.</p>
</dd>

<dt><var title="">cue</var> . <a href=#dom-texttrackcue-id title=dom-TextTrackCue-id>id</a> [ = <var title="">value</var> ]</dt>
<dd>
<p>Returns the <a href=#text-track-cue-identifier>text track cue identifier</a>.</p>
Expand Down Expand Up @@ -101877,6 +101879,7 @@ <h3 class="no-num">Reflecting IDL attributes</h3>
<li><code><a href=#videotrack>VideoTrack</a></code>
<li><code><a href=#videotracklist>VideoTrackList</a></code>
<li><code><a href=#websocket>WebSocket</a></code>
<li><code><a href=#webvttcue>WebVTTCue</a></code>
<li><code><a href=#window>Window</a></code>
<li><code><a href=#windowbase64>WindowBase64</a></code>
<li><code><a href=#windoweventhandlers>WindowEventHandlers</a></code>
Expand Down
35 changes: 19 additions & 16 deletions index
Expand Up @@ -248,7 +248,7 @@

<header class=head id=head><p><a class=logo href=http://www.whatwg.org/><img alt=WHATWG height=101 src=/images/logo width=101></a></p>
<hgroup><h1 class=allcaps>HTML</h1>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 7 March 2013</h2>
<h2 class="no-num no-toc">Living Standard &mdash; Last Updated 8 March 2013</h2>
</hgroup><dl><dt><strong>Web developer edition:</strong></dt>
<dd><strong><a href=http://developers.whatwg.org/>http://developers.whatwg.org/</a></strong></dd>
<dt>Multiple-page version:</dt>
Expand Down Expand Up @@ -31549,7 +31549,7 @@ var sounds = sfx.addTextTrack('metadata');

// add sounds we care about
function addFX(start, end, name) {
var cue = new TextTrackCue(start, end, '');
var cue = new WebVTTCue(start, end, '');
cue.id = name;
cue.pauseOnExit = true;
sounds.addCue(cue);
Expand Down Expand Up @@ -31620,11 +31620,15 @@ window.onbeforeunload = function () {

</div>

<hr><pre class=idl>enum <dfn id=autokeyword>AutoKeyword</dfn> { "auto" };
[<a href=#dom-texttrackcue title=dom-TextTrackCue>Constructor</a>(double startTime, double endTime, DOMString text)]
interface <dfn id=texttrackcue>TextTrackCue</dfn> : <a href=#eventtarget>EventTarget</a> {
<hr><pre class=idl>interface <dfn id=texttrackcue>TextTrackCue</dfn> : <a href=#eventtarget>EventTarget</a> {
readonly attribute <a href=#texttrack>TextTrack</a>? <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onenter title=handler-TextTrackCue-onenter>onenter</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onexit title=handler-TextTrackCue-onexit>onexit</a>;
};

enum <dfn id=autokeyword>AutoKeyword</dfn> { "auto" };
[<a href=#dom-texttrackcue title=dom-TextTrackCue>Constructor</a>(double startTime, double endTime, DOMString text)]
interface <dfn id=webvttcue>WebVTTCue</dfn> : <a href=#texttrackcue>TextTrackCue</a> {
attribute DOMString <a href=#dom-texttrackcue-id title=dom-TextTrackCue-id>id</a>;
attribute double <a href=#dom-texttrackcue-starttime title=dom-TextTrackCue-startTime>startTime</a>;
attribute double <a href=#dom-texttrackcue-endtime title=dom-TextTrackCue-endTime>endTime</a>;
Expand All @@ -31637,26 +31641,24 @@ interface <dfn id=texttrackcue>TextTrackCue</dfn> : <a href=#eventtarget>EventTa
attribute DOMString <a href=#dom-texttrackcue-align title=dom-TextTrackCue-align>align</a>;
attribute DOMString <a href=#dom-texttrackcue-text title=dom-TextTrackCue-text>text</a>;
<a href=#documentfragment>DocumentFragment</a> <a href=#dom-texttrackcue-getcueashtml title=dom-TextTrackCue-getCueAsHTML>getCueAsHTML</a>();

attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onenter title=handler-TextTrackCue-onenter>onenter</a>;
attribute <a href=#eventhandler>EventHandler</a> <a href=#handler-texttrackcue-onexit title=handler-TextTrackCue-onexit>onexit</a>;
};</pre>

<dl class=domintro><dt><var title="">cue</var> = new <code title=dom-TextTrackCue><a href=#dom-texttrackcue>TextTrackCue</a></code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dl class=domintro><dt><var title="">cue</var> . <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a></dt>
<dd>
<p>Returns the <code><a href=#texttrack>TextTrack</a></code> object to which this
<a href=#text-track-cue>text track cue</a> belongs, if any, or null
otherwise.</p>
</dd>


<dt><var title="">cue</var> = new <code title=dom-TextTrackCue><a href=#dom-texttrackcue>WebVTTCue</a></code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dd>
<p>Returns a new <code><a href=#texttrackcue>TextTrackCue</a></code> object, for use with the <code title=dom-TextTrack-addCue><a href=#dom-texttrack-addcue>addCue()</a></code> method.</p>
<p>The <var title="">startTime</var> argument sets the <a href=#text-track-cue-start-time>text track cue start time</a>.</p>
<p>The <var title="">endTime</var> argument sets the <a href=#text-track-cue-end-time>text track cue end time</a>.</p>
<p>The <var title="">text</var> argument sets the <a href=#text-track-cue-text>text track cue text</a>.</p>
</dd>

<dt><var title="">cue</var> . <a href=#dom-texttrackcue-track title=dom-TextTrackCue-track>track</a></dt>
<dd>
<p>Returns the <code><a href=#texttrack>TextTrack</a></code> object to which this
<a href=#text-track-cue>text track cue</a> belongs, if any, or null
otherwise.</p>
</dd>

<dt><var title="">cue</var> . <a href=#dom-texttrackcue-id title=dom-TextTrackCue-id>id</a> [ = <var title="">value</var> ]</dt>
<dd>
<p>Returns the <a href=#text-track-cue-identifier>text track cue identifier</a>.</p>
Expand Down Expand Up @@ -101877,6 +101879,7 @@ if (s = prompt('What is your name?')) {
<li><code><a href=#videotrack>VideoTrack</a></code>
<li><code><a href=#videotracklist>VideoTrackList</a></code>
<li><code><a href=#websocket>WebSocket</a></code>
<li><code><a href=#webvttcue>WebVTTCue</a></code>
<li><code><a href=#window>Window</a></code>
<li><code><a href=#windowbase64>WindowBase64</a></code>
<li><code><a href=#windoweventhandlers>WindowEventHandlers</a></code>
Expand Down
32 changes: 17 additions & 15 deletions source
Expand Up @@ -34127,7 +34127,7 @@ var sounds = sfx.addTextTrack('metadata');

// add sounds we care about
function addFX(start, end, name) {
var cue = new TextTrackCue(start, end, '');
var cue = new WebVTTCue(start, end, '');
cue.id = name;
cue.pauseOnExit = true;
sounds.addCue(cue);
Expand Down Expand Up @@ -34210,11 +34210,15 @@ window.onbeforeunload = function () {

<hr>

<pre class="idl">enum <dfn>AutoKeyword</dfn> { "auto" };
[<span title="dom-TextTrackCue">Constructor</span>(double startTime, double endTime, DOMString text)]
interface <dfn>TextTrackCue</dfn> : <span>EventTarget</span> {
<pre class="idl">interface <dfn>TextTrackCue</dfn> : <span>EventTarget</span> {
readonly attribute <span>TextTrack</span>? <span title="dom-TextTrackCue-track">track</span>;
attribute <span>EventHandler</span> <span title="handler-TextTrackCue-onenter">onenter</span>;
attribute <span>EventHandler</span> <span title="handler-TextTrackCue-onexit">onexit</span>;
};

enum <dfn>AutoKeyword</dfn> { "auto" };
[<span title="dom-TextTrackCue">Constructor</span>(double startTime, double endTime, DOMString text)]
interface <dfn>WebVTTCue</dfn> : <span>TextTrackCue</span> {
attribute DOMString <span title="dom-TextTrackCue-id">id</span>;
attribute double <span title="dom-TextTrackCue-startTime">startTime</span>;
attribute double <span title="dom-TextTrackCue-endTime">endTime</span>;
Expand All @@ -34227,28 +34231,26 @@ interface <dfn>TextTrackCue</dfn> : <span>EventTarget</span> {
attribute DOMString <span title="dom-TextTrackCue-align">align</span>;
attribute DOMString <span title="dom-TextTrackCue-text">text</span>;
<span>DocumentFragment</span> <span title="dom-TextTrackCue-getCueAsHTML">getCueAsHTML</span>();

attribute <span>EventHandler</span> <span title="handler-TextTrackCue-onenter">onenter</span>;
attribute <span>EventHandler</span> <span title="handler-TextTrackCue-onexit">onexit</span>;
};</pre>

<dl class="domintro">

<dt><var title="">cue</var> = new <code title="dom-TextTrackCue">TextTrackCue</code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dd>
<p>Returns a new <code>TextTrackCue</code> object, for use with the <code title="dom-TextTrack-addCue">addCue()</code> method.</p>
<p>The <var title="">startTime</var> argument sets the <span>text track cue start time</span>.</p>
<p>The <var title="">endTime</var> argument sets the <span>text track cue end time</span>.</p>
<p>The <var title="">text</var> argument sets the <span>text track cue text</span>.</p>
</dd>

<dt><var title="">cue</var> . <span title="dom-TextTrackCue-track">track</span></dt>
<dd>
<p>Returns the <code>TextTrack</code> object to which this
<span>text track cue</span> belongs, if any, or null
otherwise.</p>
</dd>


<dt><var title="">cue</var> = new <code title="dom-TextTrackCue">WebVTTCue</code>( <var title="">startTime</var>, <var title="">endTime</var>, <var title="">text</var> )</dt>
<dd>
<p>Returns a new <code>TextTrackCue</code> object, for use with the <code title="dom-TextTrack-addCue">addCue()</code> method.</p>
<p>The <var title="">startTime</var> argument sets the <span>text track cue start time</span>.</p>
<p>The <var title="">endTime</var> argument sets the <span>text track cue end time</span>.</p>
<p>The <var title="">text</var> argument sets the <span>text track cue text</span>.</p>
</dd>

<dt><var title="">cue</var> . <span title="dom-TextTrackCue-id">id</span> [ = <var title="">value</var> ]</dt>
<dd>
<p>Returns the <span>text track cue identifier</span>.</p>
Expand Down

0 comments on commit 8866ad0

Please sign in to comment.