dom/media/webvtt/nsIWebVTTListener.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 /**
   8  * Listener for a JS WebVTT parser (vtt.js).
   9  */
  10 [scriptable, uuid(8a2d7780-2045-4a29-99f4-df15cae5fc49)]
  11 interface nsIWebVTTListener : nsISupports
  12 {
  13   /**
  14    * Is called when the WebVTTParser successfully parses a WebVTT cue.
  15    *
  16    * @param cue An object representing the data of a parsed WebVTT cue.
  17    */
  18   [implicit_jscontext]
  19   void onCue(in jsval cue);
  20
  21   /**
  22    * Is called when the WebVTT parser successfully parses a WebVTT region.
  23    *
  24    * @param region An object representing the data of a parsed
  25    *               WebVTT region.
  26    */
  27   [implicit_jscontext]
  28   void onRegion(in jsval region);
  29
  30   /**
  31    * Is called when the WebVTT parser encounters a parsing error.
  32    *
  33    * @param error The error code of the ParserError the occured.
  34    */
  35   [implicit_jscontext]
  36   void onParsingError(in long errorCode);
  37 };