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.    * @param {?(string|undefined)} uri
  40.    *    The media uri.
  41.    * @return {!Array.<!shaka.text.Cue>}
  42.    *
  43.    * @exportDoc
  44.    */
  45.   parseMedia(data, timeContext, uri) {}
  47.   /**
  48.    * Notifies the stream if the manifest is in sequence mode or not.
  49.    *
  50.    * @param {boolean} sequenceMode
  51.    */
  52.   setSequenceMode(sequenceMode) {}
  54.   /**
  55.    * Notifies the manifest type.
  56.    *
  57.    * @param {string} manifestType
  58.    */
  59.   setManifestType(manifestType) {}
  60. };
  63. /**
  64.  * A collection of time offsets used to adjust text cue times.
  65.  *
  66.  * @typedef {{
  67.  *   periodStart: number,
  68.  *   segmentStart: number,
  69.  *   segmentEnd: number,
  70.  *   vttOffset: number
  71.  * }}
  72.  *
  73.  * @property {number} periodStart
  74.  *     The absolute start time of the period in seconds.
  75.  * @property {number} segmentStart
  76.  *     The absolute start time of the segment in seconds.
  77.  * @property {number} segmentEnd
  78.  *     The absolute end time of the segment in seconds.
  79.  * @property {number} vttOffset
  80.  *     The start time relative to either segment or period start depending
  81.  *     on <code>segmentRelativeVttTiming</code> configuration.
  82.  *
  83.  * @exportDoc
  84.  */
  85. shaka.extern.TextParser.TimeContext;
  88. /**
  89.  * A callback used for editing cues before appending.
  90.  * Provides the cue, the URI of the captions file the cue was parsed from, and
  91.  * the time context that was used when generating that cue.
  92.  * You can edit the cue object passed in.
  93.  * @typedef {function(!shaka.text.Cue, ?string,
  94.  *    !shaka.extern.TextParser.TimeContext)}
  95.  * @exportDoc
  96.  */
  97. shaka.extern.TextParser.ModifyCueCallback;
  100. /**
  101.  * @typedef {function():!shaka.extern.TextParser}
  102.  * @exportDoc
  103.  */
  104. shaka.extern.TextParserPlugin;
  107. /**
  108.  * @summary
  109.  * An interface for plugins that display text.
  110.  *
  111.  * @description
  112.  * This should handle displaying the text cues on the page.  This is given the
  113.  * cues to display and told when to start and stop displaying.  This should only
  114.  * display the cues it is given and remove cues when told to.
  115.  *
  116.  * <p>
  117.  * This should only change whether it is displaying the cues through the
  118.  * <code>setTextVisibility</code> function; the app should not change the text
  119.  * visibility outside the top-level Player methods.  If you really want to
  120.  * control text visibility outside the Player methods, you must set the
  121.  * <code>streaming.alwaysStreamText</code> Player configuration value to
  122.  * <code>true</code>.
  123.  *
  124.  * @interface
  125.  * @extends {shaka.util.IDestroyable}
  126.  * @exportDoc
  127.  */
  128. shaka.extern.TextDisplayer = class {
  129.   /**
  130.    * @override
  131.    * @exportDoc
  132.    */
  133.   destroy() {}
  135.   /**
  136.    * Sets the TextDisplayer configuration.
  137.    *
  138.    * @param {shaka.extern.TextDisplayerConfiguration} config
  139.    */
  140.   configure(config) {}
  142.   /**
  143.    * Append given text cues to the list of cues to be displayed.
  144.    *
  145.    * @param {!Array.<!shaka.text.Cue>} cues
  146.    *    Text cues to be appended.
  147.    *
  148.    * @exportDoc
  149.    */
  150.   append(cues) {}
  152.   /**
  153.    * Remove all cues that are fully contained by the given time range (relative
  154.    * to the presentation). <code>endTime</code> will be greater to equal to
  155.    * <code>startTime</code>.  <code>remove</code> should only return
  156.    * <code>false</code> if the displayer has been destroyed. If the displayer
  157.    * has not been destroyed <code>remove</code> should return <code>true</code>.
  158.    *
  159.    * @param {number} startTime
  160.    * @param {number} endTime
  161.    *
  162.    * @return {boolean}
  163.    *
  164.    * @exportDoc
  165.    */
  166.   remove(startTime, endTime) {}
  168.   /**
  169.    * Returns true if text is currently visible.
  170.    *
  171.    * @return {boolean}
  172.    *
  173.    * @exportDoc
  174.    */
  175.   isTextVisible() {}
  177.   /**
  178.    * Set text visibility.
  179.    *
  180.    * @param {boolean} on
  181.    *
  182.    * @exportDoc
  183.    */
  184.   setTextVisibility(on) {}
  185. };
  188. /**
  189.  * A factory for creating a TextDisplayer.
  190.  *
  191.  * @typedef {function():!shaka.extern.TextDisplayer}
  192.  * @exportDoc
  193.  */
  194. shaka.extern.TextDisplayer.Factory;