Source: externs/shaka/offline.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. /** @externs */
  22. /**
  23.  * @typedef {{
  24.  *   basic: boolean,
  25.  *   encrypted: !Object.<string, boolean>
  26.  * }}
  27.  *
  28.  * @property {boolean} basic
  29.  *   True if offline is usable at all.
  30.  * @property {!Object.<string, boolean>} encrypted
  31.  *   A map of key system name to whether it supports offline playback.
  32.  * @exportDoc
  33.  */
  34. shakaExtern.OfflineSupport;
  37. /**
  38.  * @typedef {{
  39.  *   trackSelectionCallback:
  40.  *       function(!Array.<shakaExtern.Track>):!Array.<shakaExtern.Track>,
  41.  *   progressCallback: function(shakaExtern.StoredContent,number),
  42.  *   usePersistentLicense: boolean
  43.  * }}
  44.  *
  45.  * @property {function(!Array.<shakaExtern.Track>):!Array.<shakaExtern.Track>}
  46.  *     trackSelectionCallback
  47.  *   Called inside store() to determine which tracks to save from a manifest.
  48.  *   It is passed an array of Tracks from the manifest and it should return
  49.  *   an array of the tracks to store.  This is called for each Period in the
  50.  *   manifest (in order).
  51.  * @property {function(shakaExtern.StoredContent,number)} progressCallback
  52.  *   Called inside store() to give progress info back to the app.  It is given
  53.  *   the current manifest being stored and the progress of it being stored.
  54.  * @property {boolean} usePersistentLicense
  55.  *   If true, store protected content with a persistent license so that no
  56.  *   network is required to view.
  57.  *   If false, store protected content without a persistent license.  A network
  58.  *   will be required to retrieve a temporary license to view.
  59.  *   Defaults to true.
  60.  * @exportDoc
  61.  */
  62. shakaExtern.OfflineConfiguration;
  65. /**
  66.  * @typedef {{
  67.  *   offlineUri: string,
  68.  *   originalManifestUri: string,
  69.  *   duration: number,
  70.  *   size: number,
  71.  *   expiration: number,
  72.  *   tracks: !Array.<shakaExtern.Track>,
  73.  *   appMetadata: Object
  74.  * }}
  75.  *
  76.  * @property {string} offlineUri
  77.  *   An offline URI to access the content.  This can be passed directly to
  78.  *   Player.
  79.  * @property {string} originalManifestUri
  80.  *   The original manifest URI of the content stored.
  81.  * @property {number} duration
  82.  *   The duration of the content, in seconds.
  83.  * @property {number} size
  84.  *   The size of the content, in bytes.
  85.  * @property {number} expiration
  86.  *   The time that the encrypted license expires, in milliseconds.  If the media
  87.  *   is clear or the license never expires, this will equal Infinity.
  88.  * @property {!Array.<shakaExtern.Track>} tracks
  89.  *   The tracks that are stored.  This only lists those found in the first
  90.  *   Period.
  91.  * @property {Object} appMetadata
  92.  *   The metadata passed to store().
  93.  * @exportDoc
  94.  */
  95. shakaExtern.StoredContent;
  98. /**
  99.  * @typedef {{
  100.  *   key: number,
  101.  *   originalManifestUri: string,
  102.  *   duration: number,
  103.  *   size: number,
  104.  *   expiration: number,
  105.  *   periods: !Array.<shakaExtern.PeriodDB>,
  106.  *   sessionIds: !Array.<string>,
  107.  *   drmInfo: ?shakaExtern.DrmInfo,
  108.  *   appMetadata: Object
  109.  * }}
  110.  *
  111.  * @property {number} key
  112.  *   The key that uniquely identifies the manifest.
  113.  * @property {string} originalManifestUri
  114.  *   The URI that the manifest was originally loaded from.
  115.  * @property {number} duration
  116.  *   The total duration of the media, in seconds.
  117.  * @property {number} size
  118.  *   The total size of all stored segments, in bytes.
  119.  * @property {number} expiration
  120.  *   The license expiration, in milliseconds; or Infinity if not applicable.
  121.  * @property {!Array.<shakaExtern.PeriodDB>} periods
  122.  *   The Periods that are stored.
  123.  * @property {!Array.<string>} sessionIds
  124.  *   The DRM offline session IDs for the media.
  125.  * @property {?shakaExtern.DrmInfo} drmInfo
  126.  *   The DRM info used to initialize EME.
  127.  * @property {Object} appMetadata
  128.  *   A metadata object passed from the application.
  129.  */
  130. shakaExtern.ManifestDB;
  133. /**
  134.  * @typedef {{
  135.  *   startTime: number,
  136.  *   streams: !Array.<shakaExtern.StreamDB>
  137.  * }}
  138.  *
  139.  * @property {number} startTime
  140.  *   The start time of the period, in seconds.
  141.  * @property {!Array.<shakaExtern.StreamDB>} streams
  142.  *   The streams that define the Period.
  143.  */
  144. shakaExtern.PeriodDB;
  147. /**
  148.  * @typedef {{
  149.  *   id: number,
  150.  *   primary: boolean,
  151.  *   presentationTimeOffset: number,
  152.  *   contentType: string,
  153.  *   mimeType: string,
  154.  *   codecs: string,
  155.  *   frameRate: (number|undefined),
  156.  *   kind: (string|undefined),
  157.  *   language: string,
  158.  *   label: ?string,
  159.  *   width: ?number,
  160.  *   height: ?number,
  161.  *   initSegmentUri: ?string,
  162.  *   encrypted: boolean,
  163.  *   keyId: ?string,
  164.  *   segments: !Array.<shakaExtern.SegmentDB>,
  165.  *   variantIds: ?Array.<number>
  166.  * }}
  167.  *
  168.  * @property {number} id
  169.  *   The unique id of the stream.
  170.  * @property {boolean} primary
  171.  *   Whether the stream set was primary.
  172.  * @property {number} presentationTimeOffset
  173.  *   The presentation time offset of the stream.
  174.  * @property {string} contentType
  175.  *   The type of the stream, 'audio', 'text', or 'video'.
  176.  * @property {string} mimeType
  177.  *   The MIME type of the stream.
  178.  * @property {string} codecs
  179.  *   The codecs of the stream.
  180.  * @property {(number|undefined)} frameRate
  181.  *   The Stream's framerate in frames per second
  182.  * @property {(string|undefined)} kind
  183.  *   The kind of text stream; undefined for audio/video.
  184.  * @property {string} language
  185.  *   The language of the stream; '' for video.
  186.  * @property {?string} label
  187.  *   The label of the stream; '' for video.
  188.  * @property {?number} width
  189.  *   The width of the stream; null for audio/text.
  190.  * @property {?number} height
  191.  *   The height of the stream; null for audio/text.
  192.  * @property  {?string} initSegmentUri
  193.  *   The offline URI where the init segment is found; null if no init segment.
  194.  * @property {boolean} encrypted
  195.  *   Whether this stream is encrypted.
  196.  * @property {?string} keyId
  197.  *   The key ID this stream is encrypted with.
  198.  * @property {!Array.<shakaExtern.SegmentDB>} segments
  199.  *   An array of segments that make up the stream
  200.  * @property {?Array.<number>} variantIds
  201.  *   An array of ids of variants the stream is a part of.
  202.  */
  203. shakaExtern.StreamDB;
  206. /**
  207.  * @typedef {{
  208.  *   startTime: number,
  209.  *   endTime: number,
  210.  *   uri: string
  211.  * }}
  212.  *
  213.  * @property {number} startTime
  214.  *   The start time of the segment, in seconds from the start of the Period.
  215.  * @property {number} endTime
  216.  *   The end time of the segment, in seconds from the start of the Period.
  217.  * @property {string} uri
  218.  *   The offline URI where the segment is found.
  219.  */
  220. shakaExtern.SegmentDB;
  223. /**
  224.  * @typedef {{
  225.  *   key: number,
  226.  *   data: ArrayBuffer,
  227.  *   manifestKey: number,
  228.  *   streamNumber: number,
  229.  *   segmentNumber: number
  230.  * }}
  231.  *
  232.  * @property {number} key
  233.  *   A key that uniquely describes the segment.
  234.  * @property {ArrayBuffer} data
  235.  *   The data contents of the segment.
  236.  * @property {number} manifestKey
  237.  *   The key of the manifest this belongs to.
  238.  * @property {number} streamNumber
  239.  *   The index of the stream this belongs to.
  240.  * @property {number} segmentNumber
  241.  *   The index of the segment within the stream.
  242.  */
  243. shakaExtern.SegmentDataDB;