Source: externs/shaka/text.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. /**
  9.  * @externs
  10.  */
  13. /**
  14.  * An interface for plugins that parse text tracks.
  15.  *
  16.  * @interface
  17.  * @exportDoc
  18.  */
  19. shaka.extern.TextParser = class {
  20.   /**
  21.    * Parse an initialization segment. Some formats do not have init
  22.    * segments so this won't always be called.
  23.    *
  24.    * @param {!Uint8Array} data
  25.    *    The data that makes up the init segment.
  26.    *
  27.    * @exportDoc
  28.    */
  29.   parseInit(data) {}
  31.   /**
  32.    * Parse a media segment and return the cues that make up the segment.
  33.    *
  34.    * @param {!Uint8Array} data
  35.    *    The next section of buffer.
  36.    * @param {shaka.extern.TextParser.TimeContext} timeContext
  37.    *    The time information that should be used to adjust the times values
  38.    *    for each cue.
  39.    * @return {!Array.<!shaka.text.Cue>}
  40.    *
  41.    * @exportDoc
  42.    */
  43.   parseMedia(data, timeContext) {}
  45.   /**
  46.    * Notifies the stream if the manifest is in sequence mode or not.
  47.    *
  48.    * @param {boolean} sequenceMode
  49.    */
  50.   setSequenceMode(sequenceMode) {}
  52.   /**
  53.    * Notifies the manifest type.
  54.    *
  55.    * @param {string} manifestType
  56.    */
  57.   setManifestType(manifestType) {}
  58. };
  61. /**
  62.  * A collection of time offsets used to adjust text cue times.
  63.  *
  64.  * @typedef {{
  65.  *   periodStart: number,
  66.  *   segmentStart: number,
  67.  *   segmentEnd: number,
  68.  *   vttOffset: number
  69.  * }}
  70.  *
  71.  * @property {number} periodStart
  72.  *     The absolute start time of the period in seconds.
  73.  * @property {number} segmentStart
  74.  *     The absolute start time of the segment in seconds.
  75.  * @property {number} segmentEnd
  76.  *     The absolute end time of the segment in seconds.
  77.  * @property {number} vttOffset
  78.  *     The start time relative to either segment or period start depending
  79.  *     on <code>segmentRelativeVttTiming</code> configuration.
  80.  *
  81.  * @exportDoc
  82.  */
  83. shaka.extern.TextParser.TimeContext;
  86. /**
  87.  * @typedef {function():!shaka.extern.TextParser}
  88.  * @exportDoc
  89.  */
  90. shaka.extern.TextParserPlugin;
  93. /**
  94.  * @summary
  95.  * An interface for plugins that display text.
  96.  *
  97.  * @description
  98.  * This should handle displaying the text cues on the page.  This is given the
  99.  * cues to display and told when to start and stop displaying.  This should only
  100.  * display the cues it is given and remove cues when told to.
  101.  *
  102.  * <p>
  103.  * This should only change whether it is displaying the cues through the
  104.  * <code>setTextVisibility</code> function; the app should not change the text
  105.  * visibility outside the top-level Player methods.  If you really want to
  106.  * control text visibility outside the Player methods, you must set the
  107.  * <code>streaming.alwaysStreamText</code> Player configuration value to
  108.  * <code>true</code>.
  109.  *
  110.  * @interface
  111.  * @extends {shaka.util.IDestroyable}
  112.  * @exportDoc
  113.  */
  114. shaka.extern.TextDisplayer = class {
  115.   /**
  116.    * @override
  117.    * @exportDoc
  118.    */
  119.   destroy() {}
  121.   /**
  122.    * Append given text cues to the list of cues to be displayed.
  123.    *
  124.    * @param {!Array.<!shaka.text.Cue>} cues
  125.    *    Text cues to be appended.
  126.    *
  127.    * @exportDoc
  128.    */
  129.   append(cues) {}
  131.   /**
  132.    * Remove all cues that are fully contained by the given time range (relative
  133.    * to the presentation). <code>endTime</code> will be greater to equal to
  134.    * <code>startTime</code>.  <code>remove</code> should only return
  135.    * <code>false</code> if the displayer has been destroyed. If the displayer
  136.    * has not been destroyed <code>remove</code> should return <code>true</code>.
  137.    *
  138.    * @param {number} startTime
  139.    * @param {number} endTime
  140.    *
  141.    * @return {boolean}
  142.    *
  143.    * @exportDoc
  144.    */
  145.   remove(startTime, endTime) {}
  147.   /**
  148.    * Returns true if text is currently visible.
  149.    *
  150.    * @return {boolean}
  151.    *
  152.    * @exportDoc
  153.    */
  154.   isTextVisible() {}
  156.   /**
  157.    * Set text visibility.
  158.    *
  159.    * @param {boolean} on
  160.    *
  161.    * @exportDoc
  162.    */
  163.   setTextVisibility(on) {}
  164. };
  167. /**
  168.  * A factory for creating a TextDisplayer.
  169.  *
  170.  * @typedef {function():!shaka.extern.TextDisplayer}
  171.  * @exportDoc
  172.  */
  173. shaka.extern.TextDisplayer.Factory;