content/media/webvtt/nsIWebVTTListener.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

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

mercurial