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