Source: externs/shaka/offline_compat_v1.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.  *   key: number,
  15.  *   originalManifestUri: string,
  16.  *   duration: number,
  17.  *   size: number,
  18.  *   expiration: number,
  19.  *   periods: !Array<shaka.extern.PeriodDBV1>,
  20.  *   sessionIds: !Array<string>,
  21.  *   drmInfo: ?shaka.extern.DrmInfo,
  22.  *   appMetadata: Object
  23.  * }}
  24.  *
  25.  * @property {number} key
  26.  *   A unique key to identify this item.
  27.  * @property {string} originalManifestUri
  28.  *   The URI that the manifest was originally loaded from.
  29.  * @property {number} duration
  30.  *   The total duration of the media, in seconds.
  31.  * @property {number} size
  32.  *   The total size of all stored segments, in bytes.
  33.  * @property {number} expiration
  34.  *   The license expiration, in milliseconds; or Infinity if not applicable.
  35.  *   Note that upon JSON serialization, Infinity becomes null, and must be
  36.  *   converted back upon loading from storage.
  37.  * @property {!Array<shaka.extern.PeriodDBV1>} periods
  38.  *   The Periods that are stored.
  39.  * @property {!Array<string>} sessionIds
  40.  *   The DRM offline session IDs for the media.
  41.  * @property {?shaka.extern.DrmInfo} drmInfo
  42.  *   The DRM info used to initialize EME.
  43.  * @property {Object} appMetadata
  44.  *   A metadata object passed from the application.
  45.  */
  46. shaka.extern.ManifestDBV1;
  49. /**
  50.  * @typedef {{
  51.  *   startTime: number,
  52.  *   streams: !Array<shaka.extern.StreamDBV1>
  53.  * }}
  54.  *
  55.  * @property {number} startTime
  56.  *   The start time of the period, in seconds.
  57.  * @property {!Array<shaka.extern.StreamDBV1>} streams
  58.  *   The streams that define the Period.
  59.  */
  60. shaka.extern.PeriodDBV1;
  63. /**
  64.  * @typedef {{
  65.  *   id: number,
  66.  *   primary: boolean,
  67.  *   presentationTimeOffset: number,
  68.  *   contentType: string,
  69.  *   mimeType: string,
  70.  *   codecs: string,
  71.  *   frameRate: (number|undefined),
  72.  *   kind: (string|undefined),
  73.  *   language: string,
  74.  *   label: ?string,
  75.  *   width: ?number,
  76.  *   height: ?number,
  77.  *   initSegmentUri: ?string,
  78.  *   encrypted: boolean,
  79.  *   keyId: ?string,
  80.  *   segments: !Array<shaka.extern.SegmentDBV1>,
  81.  *   variantIds: !Array<number>
  82.  * }}
  83.  *
  84.  * @property {number} id
  85.  *   The unique id of the stream.
  86.  * @property {boolean} primary
  87.  *   Whether the stream set was primary.
  88.  * @property {number} presentationTimeOffset
  89.  *   The presentation time offset of the stream, in seconds.  Note that this is
  90.  *   the inverse of the timestampOffset as defined in the manifest types.
  91.  * @property {string} contentType
  92.  *   The type of the stream, 'audio', 'text', or 'video'.
  93.  * @property {string} mimeType
  94.  *   The MIME type of the stream.
  95.  * @property {string} codecs
  96.  *   The codecs of the stream.
  97.  * @property {(number|undefined)} frameRate
  98.  *   The Stream's framerate in frames per second.
  99.  * @property {(string|undefined)} kind
  100.  *   The kind of text stream; undefined for audio/video.
  101.  * @property {string} language
  102.  *   The language of the stream; '' for video.
  103.  * @property {?string} label
  104.  *   The label of the stream; '' for video.
  105.  * @property {?number} width
  106.  *   The width of the stream; null for audio/text.
  107.  * @property {?number} height
  108.  *   The height of the stream; null for audio/text.
  109.  * @property  {?number} initSegmentUri
  110.  *   The offline URI where the init segment is found; null if no init segment.
  111.  * @property {boolean} encrypted
  112.  *   Whether this stream is encrypted.
  113.  * @property {?string} keyId
  114.  *   The key ID this stream is encrypted with.
  115.  * @property {!Array<shaka.extern.SegmentDBV1>} segments
  116.  *   An array of segments that make up the stream.
  117.  * @property {!Array<number>} variantIds
  118.  *   An array of ids of variants the stream is a part of.
  119.  */
  120. shaka.extern.StreamDBV1;
  123. /**
  124.  * @typedef {{
  125.  *   startTime: number,
  126.  *   endTime: number,
  127.  *   uri: string
  128.  * }}
  129.  *
  130.  * @property {number} startTime
  131.  *   The start time of the segment, in seconds from the start of the Period.
  132.  * @property {number} endTime
  133.  *   The end time of the segment, in seconds from the start of the Period.
  134.  * @property {string} uri
  135.  *   The offline URI of the segment.
  136.  */
  137. shaka.extern.SegmentDBV1;
  140. /**
  141.  * @typedef {{
  142.  *   key: number,
  143.  *   data: !ArrayBuffer
  144.  * }}
  145.  *
  146.  * @property {number} key
  147.  *   A unique key to identify this item.
  148.  * @property {!ArrayBuffer} data
  149.  *   The data contents of the segment.
  150.  */
  151. shaka.extern.SegmentDataDBV1;