Source: externs/shaka/cea.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. /**
  9.  * @externs
  10.  */
  12. /**
  13.  * Interface for parsing inband closed caption data from MP4 streams.
  14.  * @interface
  15.  * @exportDoc
  16.  */
  17. shaka.extern.ICeaParser = class {
  18.   /**
  19.    * Initializes the parser with init segment data.
  20.    * @param {!BufferSource} initSegment init segment to parse.
  21.    * @exportDoc
  22.    */
  23.   init(initSegment) {}
  25.   /**
  26.    * Parses the stream and extracts closed captions packets.
  27.    * @param {!BufferSource} mediaSegment media segment to parse.
  28.    * @return {!Array<!shaka.extern.ICeaParser.CaptionPacket>}
  29.    * @exportDoc
  30.    */
  31.   parse(mediaSegment) {}
  32. };
  34. /**
  35.  * @typedef {{
  36.  *   packet: !Uint8Array,
  37.  *   pts: number
  38.  * }}
  39.  *
  40.  * @description Parsed Caption Packet.
  41.  * @property {!Uint8Array} packet
  42.  * Caption packet. More specifically, it contains a "User data
  43.  * registered by Recommendation ITU-T T.35 SEI message", from section D.1.6
  44.  * and section D.2.6 of Rec. ITU-T H.264 (06/2019).
  45.  * @property {number} pts
  46.  * The presentation timestamp (pts) at which the ITU-T T.35 data shows up.
  47.  * in seconds.
  48.  * @exportDoc
  49.  */
  50. shaka.extern.ICeaParser.CaptionPacket;
  53. /**
  54.  * Interface for decoding inband closed captions from packets.
  55.  * @interface
  56.  * @exportDoc
  57.  */
  58. shaka.extern.ICaptionDecoder = class {
  59.   /**
  60.    * Extracts packets and prepares them for decoding. In a given media fragment,
  61.    * all the caption packets found in its SEI messages should be extracted by
  62.    * successive calls to extract(), followed by a single call to decode().
  63.    *
  64.    * @param {!Uint8Array} userDataSeiMessage
  65.    * This is a User Data registered by Rec.ITU-T T.35 SEI message.
  66.    * It is described in sections D.1.6 and D.2.6 of Rec. ITU-T H.264 (06/2019).
  67.    * @param {number} pts PTS when this packet was received, in seconds.
  68.    * @exportDoc
  69.    */
  70.   extract(userDataSeiMessage, pts) {}
  72.   /**
  73.    * Decodes all currently extracted packets and then clears them.
  74.    * This should be called once for a set of extracts (see comment on extract).
  75.    * @return {!Array.<!shaka.extern.ICaptionDecoder.ClosedCaption>}
  76.    * @exportDoc
  77.    */
  78.   decode() {}
  80.   /**
  81.    * Clears the decoder state completely.
  82.    * Should be used when an action renders the decoder state invalid,
  83.    * e.g. unbuffered seeks.
  84.    * @exportDoc
  85.    */
  86.   clear() {}
  88.   /**
  89.    * Returns the streams that the CEA decoder found.
  90.    * @return {!Array.<string>}
  91.    * @exportDoc
  92.    */
  93.   getStreams() {}
  94. };
  96. /**
  97.  * Parsed Cue.
  98.  * @typedef {{
  99.  *   cue: !shaka.text.Cue,
  100.  *   stream: string
  101.  * }}
  102.  *
  103.  * @exportDoc
  104.  */
  105. shaka.extern.ICaptionDecoder.ClosedCaption;
  107. /**
  108.  * @typedef {function():!shaka.extern.ICeaParser}
  109.  * @exportDoc
  110.  */
  111. shaka.extern.CeaParserPlugin;
  113. /**
  114.  * @typedef {function():!shaka.extern.ICaptionDecoder}
  115.  * @exportDoc
  116.  */
  117. shaka.extern.CaptionDecoderPlugin;