Source: externs/shaka/mp4_parser.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.  * @typedef {{
  14.  *    name: string,
  15.  *    parser: !shaka.util.Mp4Parser,
  16.  *    partialOkay: boolean,
  17.  *    stopOnPartial: boolean,
  18.  *    start: number,
  19.  *    size: number,
  20.  *    version: ?number,
  21.  *    flags: ?number,
  22.  *    reader: !shaka.util.DataViewReader,
  23.  *    has64BitSize: boolean
  24.  * }}
  25.  *
  26.  * @property {string} name
  27.  *   The box name, a 4-character string (fourcc).
  28.  * @property {!shaka.util.Mp4Parser} parser
  29.  *   The parser that parsed this box. The parser can be used to parse child
  30.  *   boxes where the configuration of the current parser is needed to parsed
  31.  *   other boxes.
  32.  * @property {boolean} partialOkay
  33.  *   If true, allows reading partial payloads from some boxes. If the goal is a
  34.  *   child box, we can sometimes find it without enough data to find all child
  35.  *   boxes. This property allows the partialOkay flag from parse() to be
  36.  *   propagated through methods like children().
  37.  * @property {boolean} stopOnPartial
  38.  *   If true, stop reading if an incomplete box is detected.
  39.  * @property {number} start
  40.  *   The start of this box (before the header) in the original buffer. This
  41.  *   start position is the absolute position.
  42.  * @property {number} size
  43.  *   The size of this box (including the header).
  44.  * @property {?number} version
  45.  *   The version for a full box, null for basic boxes.
  46.  * @property {?number} flags
  47.  *   The flags for a full box, null for basic boxes.
  48.  * @property {!shaka.util.DataViewReader} reader
  49.  *   The reader for this box is only for this box. Reading or not reading to
  50.  *   the end will have no affect on the parser reading other sibling boxes.
  51.  * @property {boolean} has64BitSize
  52.  *   If true, the box header had a 64-bit size field.  This affects the offsets
  53.  *   of other fields.
  54.  * @exportDoc
  55.  */
  56. shaka.extern.ParsedBox;