dom/webidl/TextTrack.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * http://www.whatwg.org/specs/web-apps/current-work/#texttrack
   8  */
   9
  10 enum TextTrackKind {
  11   "subtitles",
  12   "captions",
  13   "descriptions",
  14   "chapters",
  15   "metadata"
  16 };
  17
  18 enum TextTrackMode {
  19   "disabled",
  20   "hidden",
  21   "showing"
  22 };
  23
  24 [Pref="media.webvtt.enabled"]
  25 interface TextTrack : EventTarget {
  26   readonly attribute TextTrackKind kind;
  27   readonly attribute DOMString label;
  28   readonly attribute DOMString language;
  29
  30   readonly attribute DOMString id;
  31   readonly attribute DOMString inBandMetadataTrackDispatchType;
  32
  33            attribute TextTrackMode mode;
  34
  35   readonly attribute TextTrackCueList? cues;
  36   readonly attribute TextTrackCueList? activeCues;
  37   readonly attribute VTTRegionList? regions;
  38
  39   void addCue(VTTCue cue);
  40   [Throws]
  41   void removeCue(VTTCue cue);
  42
  43            attribute EventHandler oncuechange;
  44   [Throws]
  45   void removeRegion(VTTRegion region);
  46   void addRegion(VTTRegion region);
  47 };