Source: externs/shaka/text.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  19. /** @externs */
  23. /**
  24.  * An interface for plugins that parse text tracks.
  25.  *
  26.  * @interface
  27.  * @exportDoc
  28.  */
  29. shakaExtern.TextParser = function() {};
  32. /**
  33.  * A collection of time offsets used to adjust text cue times.
  34.  *
  35.  * @typedef {{
  36.  *   periodStart : number,
  37.  *   segmentStart : number,
  38.  *   segmentEnd : number
  39.  * }}
  40.  *
  41.  * @property {number} periodStart
  42.  *     The absolute start time of the period in seconds.
  43.  * @property {number} segmentStart
  44.  *     The absolute start time of the segment in seconds.
  45.  * @property {number} segmentEnd
  46.  *     The absolute end time of the segment in seconds.
  47.  *
  48.  * @exportDoc
  49.  */
  50. shakaExtern.TextParser.TimeContext;
  53. /**
  54.  * Parse an initialization segment. Some formats do not have init
  55.  * segments so this won't always be called.
  56.  *
  57.  * @param {!ArrayBuffer} data
  58.  *    The data that makes up the init segment.
  59.  *
  60.  * @exportDoc
  61.  */
  62. shakaExtern.TextParser.prototype.parseInit = function(data) {};
  65. /**
  66.  * Parse a media segment and return the cues that make up the segment.
  67.  *
  68.  * @param {!ArrayBuffer} data
  69.  *    The next section of buffer.
  70.  * @param {shakaExtern.TextParser.TimeContext} timeContext
  71.  *    The time information that should be used to adjust the times values
  72.  *    for each cue.
  73.  * @return {!Array.<!shaka.text.Cue>}
  74.  *
  75.  * @exportDoc
  76.  */
  77. shakaExtern.TextParser.prototype.parseMedia = function(data, timeContext) {};
  80. /**
  81.  * @typedef {function(new:shakaExtern.TextParser)}
  82.  */
  83. shakaExtern.TextParserPlugin;
  87. /**
  88.  * An interface for plugins that display text.
  89.  *
  90.  * @interface
  91.  * @extends {shaka.util.IDestroyable}
  92.  * @exportDoc
  93.  */
  94. shakaExtern.TextDisplayer = function() {};
  97. /**
  98.  * Append given text cues to the list of cues to be displayed.
  99.  *
  100.  * @param {!Array.<!shaka.text.Cue>} cues
  101.  *    Text cues to be appended.
  102.  *
  103.  * @exportDoc
  104.  */
  105. shakaExtern.TextDisplayer.prototype.append = function(cues) {};
  108. /**
  109.  * Remove cues in a given time range.
  110.  *
  111.  * @param {number} start
  112.  * @param {number} end
  113.  * @return {boolean}
  114.  *
  115.  * @exportDoc
  116.  */
  117. shakaExtern.TextDisplayer.prototype.remove = function(start, end) {};
  120. /**
  121.  * Returns true if text is currently visible.
  122.  *
  123.  * @return {boolean}
  124.  *
  125.  * @exportDoc
  126.  */
  127. shakaExtern.TextDisplayer.prototype.isTextVisible = function() {};
  130. /**
  131.  * Set text visibility.
  132.  *
  133.  * @param {boolean} on
  134.  *
  135.  * @exportDoc
  136.  */
  137. shakaExtern.TextDisplayer.prototype.setTextVisibility = function(on) {};
  140. /**
  141.  * A factory for creating a TextDisplayer.
  142.  *
  143.  * @typedef {function(new:shakaExtern.TextDisplayer)}
  144.  * @exportDoc
  145.  */
  146. shakaExtern.TextDisplayer.Factory;