1/*
2 * Copyright (C) 2011 Google Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26enum TextTrackMode { "disabled",  "hidden",  "showing" };
27enum TextTrackKind { "subtitles",  "captions",  "descriptions",  "chapters", "metadata" };
28
29[
30    Conditional=VIDEO_TRACK,
31    EventTarget,
32    GenerateIsReachable=ImplElementRoot,
33    JSCustomMarkFunction,
34    SkipVTableValidation,
35] interface TextTrack {
36    readonly attribute DOMString id;
37    [CustomSetter] attribute TextTrackKind kind;
38    readonly attribute DOMString label;
39    [CustomSetter] attribute DOMString language;
40    readonly attribute DOMString inBandMetadataTrackDispatchType;
41
42    attribute TextTrackMode mode;
43
44    readonly attribute TextTrackCueList cues;
45    readonly attribute TextTrackCueList activeCues;
46
47    [RaisesException] void addCue(TextTrackCue cue);
48    [RaisesException] void removeCue(TextTrackCue cue);
49
50             attribute EventListener oncuechange;
51
52#if defined(ENABLE_WEBVTT_REGIONS) && ENABLE_WEBVTT_REGIONS
53    readonly attribute VTTRegionList regions;
54    void addRegion(VTTRegion region);
55    [RaisesException] void removeRegion(VTTRegion region);
56#endif
57
58    // EventTarget interface
59    void addEventListener(DOMString type,
60                          EventListener listener,
61                          optional boolean useCapture);
62    void removeEventListener(DOMString type,
63                             EventListener listener,
64                             optional boolean useCapture);
65    [RaisesException] boolean dispatchEvent(Event evt);
66};
67