shaka-player 3.1.4 → 3.3.0

package/docs/design/bg-fetch-after.gv

@@ -0,0 +1,29 @@
+# Generate png with: dot -Tpng -O after.gv
+digraph storage_after {
+  subgraph cluster_0 {
+    label="Shaka Player";
+    parse[label="Download and parse manifest (parseManifest)"];
+    drm[label="Make DRM engine and load keys (createDrmEngine)"]
+    filter[label="Filter manifest (filterManifest_)"];
+    segments[label="Download segments (downloadSegments_)"];
+    store[label="Store manifest (cell.addManifests)"];
+    parse -> drm;
+    drm -> filter;
+    filter -> store;
+    store -> segments[label="BG Fetch Not Available"];
+  }
+  subgraph cluster_1 {
+    label="Service Worker";
+    bgSegments[label="Download segments in background (backgroundFetch.fetch)"]
+    store -> bgSegments[label="BG Fetch Available"];
+  }
+  subgraph cluster_2 {
+    label="Shaka Player Static Methods";
+    storeSeg[label="Store segments one-by-one (assignStreamToManifest)"]
+    remove[label="Clean up (cleanStoredManifest)"];
+    segments -> remove[label="On Fail"];
+    segments -> storeSeg;
+    bgSegments -> storeSeg;
+    bgSegments -> remove[label="On Fail"];
+  }
+}

package/docs/design/bg-fetch-before.gv

@@ -0,0 +1,18 @@
+# Generate png with: dot -Tpng -O before.gv
+digraph storage_before {
+  subgraph cluster_0 {
+    label="Shaka Player";
+    parse[label="Download and parse manifest (parseManifest)"];
+    drm[label="Make DRM engine and load keys (createDrmEngine)"]
+    filter[label="Filter manifest (filterManifest_)"];
+    segments[label="Download and store segments (downloadManifest_)"];
+    store[label="Store manifest (cell.addManifests)"];
+    remove[label="Clean up (cell.removeSegments)"];
+    parse -> drm;
+    drm -> filter;
+    filter -> segments;
+    segments -> store;
+    segments -> remove[label="On Fail"];
+    store -> remove[label="On Fail"];
+  }
+}

package/docs/design/bg-fetch.md

@@ -0,0 +1,134 @@
+# Shaka Player Background Fetch Support
+
+last update: 2021-7-12
+
+by: [theodab@google.com](mailto:theodab@google.com)
+
+
+## Overview
+
+The feature of background fetch has been in Shaka Player’s backlog [since 2017].
+At the time it was added to the backlog, the feature was not quite ready for
+use. Since then, it has matured, and now is something we could feasibly use, but
+it has still been a low-priority feature.
+
+[since 2017]: https://github.com/google/shaka-player/issues/879
+
+## Design Concept
+
+This design attempts to reuse existing code whenever possible, in order to
+minimize the amount of new code that has to be tested. The code will be made in
+two main stages:
+1. Refactor the offline download process to change the order that the asset is
+downloaded. The manifest should be downloaded and stored first, and then every
+segment should be downloaded. As a segment is downloaded, it should be stored.
+The code for storing a segment, in particular, should be broken out into an
+exported static (e.g. stateless) function.
+1. Modify the Shaka Player wrapper to add the appropriate background fetch event
+listeners if the environment is detected to be a service worker, so that a
+compiled Shaka Player bundle can be used as a service worker. If background
+fetch is used, the segment downloading step should be passed to this service
+worker. When each segment is downloaded, it should be passed to the static
+storage functions added in stage 1.
+
+By restructuring the offline storage code in this way, switching between
+foreground and background fetch will just be a matter of calling a different
+segment-downloading function. In addition, it is possible that, in the future, a
+plugin interface could be made for this. That probably won’t be necessary unless
+another browser makes a competing API for downloading in the background (which
+is admittedly a possibility, as background fetch [is not yet a W3C standard]).
+
+[is not yet a W3C standard]: https://wicg.github.io/background-fetch/
+
+### Storage System Process: Before
+
+![Shaka storage system flow before](bg-fetch-before.gv.png)
+
+
+### Storage System Process: After
+
+![Shaka storage system flow after](bg-fetch-after.gv.png)
+
+
+## Implementation
+
+### Changes to shaka.offline.Storage
+
+1. Change createOfflineManifest_ to leave the storage indexes on the segments
+null at first. With this change, downloadManifest_ will now only be downloading
+the encryption keys (which cannot be downloaded via background fetch, as they
+require request bodies).
+1. Create a new step within store_, after the manifest is stored, called
+“downloadSegments_” that makes a Set of SegmentReference objects that need to be
+downloaded.
+   1. We use SegmentReference objects in order to contain the URI, startByte,
+   and endByte.
+   1. This change also means we will no longer need an internal cache for
+   downloaded segments, as they will be deduplicated by the use of a Set.
+1. If background fetch is not available, downloadSegments_ will simply download
+the segments from this set as before, and then once they are all downloaded,
+pass them all to assignStreamsToManifest.
+1. If background fetch is available, this set will be turned into an array,
+Request objects should be made for the individual uris (with appropriate headers
+applied), and then that array will be passed to the service worker with a
+background fetch call. The service worker will then, after everything is
+downloaded and stored, call assignStreamsToManifest.  An estimate of the total
+download size will need to be computed here, and padded to avoid premature
+cancellation for inaccurate manifests.
+1. Create a new public static method, assignStreamToManifest. This is a static
+method that requires no internal state, so that the service worker can call it.
+It stores the data provided, loads the manifest from storage, applies the
+storage id of the data to the appropriate segments (based on uri), and then
+stores the modified manifest. It should have a mutex over the part that loads
+and changes the manifest, to keep one invocation from overriding the manifest
+changes of another. It should have the following parameters:
+   1. manifestStorageId
+   1. uri
+   1. data
+   1. throwIfAbortedFn
+1. Create a second public static method, cleanStoredManifest. This method is
+meant to be called by the service worker in the instance of the fetch operation
+being aborted, and will simply clear the manifest away. It will also clear any
+segments that have been stored already. This also means we will no longer need
+the segmentsFromStore_ array, which we had previously been using to un-store
+after canceled or failed downloads. It should have the following parameters:
+   1. manifestStorageId
+1. When filling out shaka.extern.StoredContent entries for the list() method,
+the storage system should be sure to set the offlineUri field to null if the
+manifest is still “isIncomplete”, to mark that the asset has not yet finished
+downloading. This will help developers detect that an asset is mid-download on
+page load, so that they can set up progress indicators if they so wish.
+
+
+### Service Worker Design
+
+1. This code should go in, or at least be loaded in, the wrapper code. This will
+let us access Shaka Player methods inside the service worker, without having to
+coordinate how to load a compiled Shaka Player bundle from a service worker;
+the user can simply load a Shaka Player bundle as a service worker.
+1. When the background fetch message is called (see [the documentation]), the
+“id” field should be set to the storage id of the manifest, with an added prefix
+of “Shaka-”. The API does not provide any field for custom data, but this value
+still needs to be provided to the service worker somehow. Luckily, this is the
+only extra data the service worker needs, so it can just be the id of the fetch
+operation.
+   1. When handling background fetch-related events, we can simply ignore any
+   event that does not start with the prefix. This will help prevent any
+   contamination with other service worker code from the developer.
+1. As each segment is downloaded, the assignStreamToManifest method should be
+called to store that data in the manifest.
+1. If the download is canceled, call the cleanStoredManifest method, so that the
+player doesn’t pollute indexedDb with unused segment data.
+1. As a service worker is essentially just a collection of event listeners, one
+can theoretically listen to the same event multiple times. This is relevant
+because [a given scope] can only have a single service worker, so our service
+worker code will have to be something that other people can load into their
+existing service workers, if they have any.
+1. Our system should use the message event to pass a specific identifying
+message to the service worker, and the service worker will be expected to
+respond with a specific response message. This way, we won’t mistake an
+unrelated service worker for our own.
+   1. This message can also be used to make sure the versions are the same.
+
+[the documentation]: https://developers.google.com/web/updates/2018/12/background-fetch#starting_a_background_fetch
+[a given scope]: https://developers.google.com/web/fundamentals/primers/service-workers#register_a_service_worker

package/docs/tutorials/blob-url.md

@@ -0,0 +1,15 @@
+# Blob URL
+
+In case you need shaka-player to load a blob url mpd:
+
+`player.load(computedMpdBlobURL, startTime, 'application/dash+xml');`
+
+
+In case you need shaka-player to load a blob url m3u8 :
+
+`player.load(computedMpdBlobURL, startTime, 'application/x-mpegurl');`
+
+
+Note: relative URIs in the manifest are broken because the original manifest URI is lost. This can be worked around with either absolute URIs or the use of BaseURL element in DASH.
+
+Note: this tutorial only applies to v3.3 or higher

package/docs/tutorials/index.json

@@ -18,6 +18,7 @@
   { "offline": { "title": "Offline Storage and Playback" } },
   { "fairplay": { "title": "FairPlay support" } },
   { "application-level-redirects": { "title": "Application-Level Redirects" } },
+  { "blob-url": { "title": "Blob URL" } },
   { "faq": { "title": "Frequently Asked Questions" } },
   { "upgrade": {
       "title": "Upgrade Guide",

package/docs/tutorials/ui-customization.md

@@ -67,6 +67,10 @@ The following elements can be added to the UI bar using this configuration value
   supports AirPlay.
 * cast: adds a button that opens a Chromecast dialog. The button is visible only if there is
   at least one Chromecast device on the same network available for casting.
+* quality: adds a button that controls enabling/disabling of abr and video resolution selection.
+* language: adds a button that controls audio language selection.
+* playback_rate: adds a button that controls the playback rate selection.
+* captions: adds a button that controls the current text track selection (including turning it off).
 <!-- TODO: If we add more buttons that can be put in the order this way, list them here. -->
 
 Similarly, the 'overflowMenuButtons' configuration option can be used to control
@@ -84,6 +88,7 @@ The following buttons can be added to the overflow menu:
 * playback_rate: adds a button that controls the playback rate selection.
 * airplay: adds a button that opens a AirPlay dialog. The button is visible only if the browser
   supports AirPlay.
+* Statistics: adds a button that displays statistics of the video.
 <!-- TODO: If we add more buttons that can be put in the order this way, list them here. -->
 
 Example:
@@ -98,6 +103,51 @@ ui.configure(config);
 An important note: the 'overflow_menu' button needs to be part of the 'controlPanelElements'
 layout for the overflow menu to be available to the user.
 
+#### Adding tooltips to control panel buttons
+
+Tooltips can be enabled to display the function of every button in the control panel. Where applicable, they will also contain the current selection in parenthesis.
+
+Example:
+```js
+const config = {
+  'enableTooltips' : true
+}
+ui.configure(config);
+```
+
+#### Replacing the default context menu
+
+A custom context menu can be added through the `customContextMenu` boolean. Additionally, the `contextMenuElements` option can be used to add elements to it.
+The following buttons can be added to the context menu:
+* Statistics: adds a button that displays statistics of the video.
+* loop: adds a button that controls if the currently selected video is played in a loop.
+* picture_in_picture: adds a button that enables/disables picture-in-picture mode on browsers
+  that support it. Button is invisible on other browsers.
+
+Example:
+```js
+const config = {
+  'customContextMenu' : true,
+  'contextMenuElements' : ['statistics'],
+}
+ui.configure(config);
+```
+
+#### Configuring Statistics
+The list of statistics that are displayed when toggling the statistics button can be customized by specifying a `statisticsList` on the configuration. With the exception of `switchHistory` and `stateHistory`, all of the statistics from the {@link shaka.extern.Stats `Stats`} extern can be displayed.
+
+Example:
+```js
+// Add a context menu with the 'statistics' button that displays a container with
+// the current 'width', 'height', 'playTime', and 'bufferingTime' values.
+const config = {
+  'customContextMenu' : true,
+  'contextMenuElements' : ['statistics'],
+  'statisticsList' : ['width', 'height', 'playTime', 'bufferingTime'],
+}
+ui.configure(config);
+```
+
 The presence of the seek bar and the big play button in the center of the video element can be
 customized with `addSeekBar` and `addBigPlayButton` booleans in the config.
 
@@ -130,6 +180,22 @@ const config = {
 ui.configure(config);
 ```
 
+#### Configuring playback, fast forward and rewind rates
+The rate in which the player can play, fast forward and rewind content can be configured using the `playbackRates`, `fastForwardRates` and `rewindRates` options.
+
+* `playbackRates`: List of rates available in the `playback_rate` menu.
+* `fastForwardRates`: List of rates available to cycle through every time the `fast_forward` button is clicked.
+* `rewindRates`: List of rates available to cycle through every time the `rewind` button is clicked.
+
+ ```js
+const config = {
+  'controlPanelElements': ['playback_rate', 'fast_forward', 'rewind'],
+  'playbackRates': [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2],
+  'fastForwardRates': [2, 4, 8, 1],
+  'rewindRates': [-1, -2, -4, -8],
+}
+ui.configure(config);
+```
 
 #### Creating custom elements and adding them to the UI
 It's possible to add custom application-specific buttons to the UI.

package/docs/tutorials/ui.md

@@ -30,7 +30,7 @@ Set up controls with HTML data attributes:
          The data-shaka-player-cast-receiver-id tag allows you to provide a Cast Application ID that
            the cast button will cast to; the value provided here is the sample cast receiver. -->
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="BBED8D28">
        <!-- The data-shaka-player tag will make the UI library use this video element.
             If no video is provided, the UI will automatically make one inside the container div. -->
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%"></video>
@@ -111,7 +111,7 @@ set up a listener for the 'caststatuschanged' events.
 <!-- Add a data-shaka-player-cast-receiver-id tag to provide a Cast Application ID that
            the cast button will cast to; the value provided here is the sample cast receiver. -->
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="BBED8D28">
     </div>
 ```
 
@@ -137,7 +137,7 @@ or a `<source>` tag inside it to enable auto loading of the specified content.
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="BBED8D28">
       <!-- The manifest url in the src attribute will be automatically loaded -->
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%"
        src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"></video>
@@ -148,7 +148,7 @@ or
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="BBED8D28">
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%">
         <!-- The manifest url in the src attribute will be auto loaded -->
        <source src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"/>
@@ -161,7 +161,7 @@ call to the first one fails.
 
 ```html
     <div data-shaka-player-container style="max-width:40em"
-         data-shaka-player-cast-receiver-id="1BA79154">
+         data-shaka-player-cast-receiver-id="BBED8D28">
       <video autoplay data-shaka-player id="video" style="width:100%;height:100%">
         <!-- Try this first -->
         <source src="https://storage.googleapis.com/shaka-demo-assets/angel-one/dash.mpd"/>

package/externs/aria.js

@@ -16,3 +16,9 @@ Element.prototype.ariaLabel;
 
 /** @type {string} */
 Element.prototype.ariaPressed;
+
+/** @type {string} */
+Element.prototype.ariaSelected;
+
+/** @type {string} */
+Element.prototype.ariaHidden;

package/externs/ima.js

@@ -164,6 +164,9 @@ google.ima.Ad = class {
 
   /** @return {string} */
   getAdvertiserName() {}
+
+  /** @return {boolean} */
+  isLinear() {}
 };
 
 

package/externs/shaka/ads.js

@@ -33,6 +33,24 @@
 shaka.extern.AdsStats;
 
 
+/**
+ * @typedef {{
+ *   start: number,
+ *   end: ?number
+ * }}
+ *
+ * @description
+ * Contains the times of a range of an Ad.
+ *
+ * @property {number} start
+ *   The start time of the range, in milliseconds.
+ * @property {number} end
+ *   The end time of the range, in milliseconds.
+ * @exportDoc
+ */
+shaka.extern.AdCuePoint;
+
+
 /**
  * An object that's responsible for all the ad-related logic
  * in the player.
@@ -70,7 +88,7 @@ shaka.extern.IAdManager = class extends EventTarget {
   /**
    * @param {!google.ima.dai.api.StreamRequest} imaRequest
    * @param {string=} backupUrl
-   * @return {!Promise.<!string>}
+   * @return {!Promise.<string>}
    */
   requestServerSideStream(imaRequest, backupUrl) {}
 
@@ -79,6 +97,11 @@ shaka.extern.IAdManager = class extends EventTarget {
    */
   replaceServerSideAdTagParameters(adTagParameters) {}
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   */
+  getServerSideCuePoints() {}
+
   /**
    * Get statistics for the current playback session. If the player is not
    * playing content, this will return an empty stats object.
@@ -184,6 +207,11 @@ shaka.extern.IAd = class {
    */
   setMuted(muted) {}
 
+  /**
+   * @return {boolean}
+   */
+  isLinear() {}
+
   /**
    * @param {number} width
    * @param {number} height

package/externs/shaka/manifest.js

@@ -111,6 +111,7 @@ shaka.extern.InitDataOverride;
  *   audioRobustness: string,
  *   videoRobustness: string,
  *   serverCertificate: Uint8Array,
+ *   serverCertificateUri: string,
  *   sessionType: string,
  *   initData: Array.<!shaka.extern.InitDataOverride>,
  *   keyIds: Set.<string>
@@ -150,6 +151,10 @@ shaka.extern.InitDataOverride;
  *   A key-system-specific server certificate used to encrypt license requests.
  *   Its use is optional and is meant as an optimization to avoid a round-trip
  *   to request a certificate.
+ * @property {string} serverCertificateUri
+ *   <i>Defaults to '', e.g., server certificate will be requested from the
+ *   given URI if serverCertificate is not provided. Can be filled in by
+ *   advanced DRM config.</i>
  * @property {Array.<!shaka.extern.InitDataOverride>} initData
  *   <i>Defaults to [], e.g., no override.</i> <br>
  *   A list of initialization data which override any initialization data found
@@ -233,6 +238,7 @@ shaka.extern.CreateSegmentIndexFunction;
  *   id: number,
  *   originalId: ?string,
  *   createSegmentIndex: shaka.extern.CreateSegmentIndexFunction,
+ *   closeSegmentIndex: (function()|undefined),
  *   segmentIndex: shaka.media.SegmentIndex,
  *   mimeType: string,
  *   codecs: string,
@@ -258,7 +264,10 @@ shaka.extern.CreateSegmentIndexFunction;
  *   audioSamplingRate: ?number,
  *   spatialAudio: boolean,
  *   closedCaptions: Map.<string, string>,
- *   tilesLayout: (string|undefined)
+ *   tilesLayout: (string|undefined),
+ *   matchedStreams:
+ *      (!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
+ *      undefined)
  * }}
  *
  * @description
@@ -275,6 +284,9 @@ shaka.extern.CreateSegmentIndexFunction;
  * @property {shaka.extern.CreateSegmentIndexFunction} createSegmentIndex
  *   <i>Required.</i> <br>
  *   Creates the Stream's segmentIndex (asynchronously).
+ * @property {(function()|undefined)} closeSegmentIndex
+ *   <i>Optional.</i> <br>
+ *   Closes the Stream's segmentIndex.
  * @property {shaka.media.SegmentIndex} segmentIndex
  *   <i>Required.</i> <br>
  *   May be null until createSegmentIndex() is complete.
@@ -328,7 +340,7 @@ shaka.extern.CreateSegmentIndexFunction;
  *   The Stream's label, unique text that should describe the audio/text track.
  * @property {string} type
  *   <i>Required.</i> <br>
- *   Content type (e.g. 'video', 'audio' or 'text')
+ *   Content type (e.g. 'video', 'audio' or 'text', 'image')
  * @property {boolean} primary
  *   <i>Defaults to false.</i> <br>
  *   True indicates that the player should use this Stream over others if user
@@ -365,6 +377,10 @@ shaka.extern.CreateSegmentIndexFunction;
  *   The value is a grid-item-dimension consisting of two positive decimal
  *   integers in the format: column-x-row ('4x3'). It describes the arrangement
  *   of Images in a Grid. The minimum valid LAYOUT is '1x1'.
+ * @property {(!Array.<shaka.extern.Stream>|!Array.<shaka.extern.StreamDB>|
+ *   undefined)} matchedStreams
+ *   The streams in all periods which match the stream. Used for Dash.
+ *
  * @exportDoc
  */
 shaka.extern.Stream;

package/externs/shaka/manifest_parser.js

@@ -100,6 +100,10 @@ shaka.extern.ManifestParser = class {
 /**
  * @typedef {{
  *   networkingEngine: !shaka.net.NetworkingEngine,
+ *   modifyManifestRequest: function(!shaka.extern.Request,
+ *      shaka.util.CmcdManager.ManifestInfo),
+ *   modifySegmentRequest: function(!shaka.extern.Request,
+ *      shaka.util.CmcdManager.SegmentInfo),
  *   filter: function(shaka.extern.Manifest):!Promise,
  *   makeTextStreamsForClosedCaptions: function(shaka.extern.Manifest),
  *   onTimelineRegionAdded: function(shaka.extern.TimelineRegionInfo),
@@ -118,6 +122,12 @@ shaka.extern.ManifestParser = class {
  *
  * @property {!shaka.net.NetworkingEngine} networkingEngine
  *   The networking engine to use for network requests.
+ * @property {function(!shaka.extern.Request,
+ *    shaka.util.CmcdManager.ManifestInfo)} modifyManifestRequest
+ *   Modify a manifest request
+ * @property {function(!shaka.extern.Request,
+ *   shaka.util.CmcdManager.SegmentInfo)} modifySegmentRequest
+ *   Modify a segment request
  * @property {function(shaka.extern.Manifest):!Promise} filter
  *   Should be called when new variants or text streams are added to the
  *   Manifest.  Note that this operation is asynchronous.
@@ -150,4 +160,3 @@ shaka.extern.ManifestParser.PlayerInterface;
  * @exportDoc
  */
 shaka.extern.ManifestParser.Factory;
-

package/externs/shaka/net.js

@@ -101,6 +101,7 @@ shaka.extern.Request;
  * @typedef {{
  *   uri: string,
  *   data: BufferSource,
+ *   status: (number|undefined),
  *   headers: !Object.<string, string>,
  *   timeMs: (number|undefined),
  *   fromCache: (boolean|undefined)
@@ -119,6 +120,8 @@ shaka.extern.Request;
  *   redirects, but after request filters are executed.
  * @property {BufferSource} data
  *   The body of the response.
+ * @property {(number|undefined)} status
+ *   The response HTTP status code.
  * @property {!Object.<string, string>} headers
  *   A map of response headers, if supported by the underlying protocol.
  *   All keys should be lowercased.
@@ -139,15 +142,17 @@ shaka.extern.Response;
  * @typedef {!function(string,
  *                     shaka.extern.Request,
  *                     shaka.net.NetworkingEngine.RequestType,
- *                     shaka.extern.ProgressUpdated):
+ *                     shaka.extern.ProgressUpdated,
+ *                     shaka.extern.HeadersReceived):
  *     !shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  * @description
  * Defines a plugin that handles a specific scheme.
  *
  * The functions accepts four parameters, uri string, request, request type,
- * and a progressUpdated function.  The progressUpdated function can be ignored
- * by plugins that do not have this information, but it will always be provided
- * by NetworkingEngine.
+ * a progressUpdated function, and a headersReceived function.  The
+ * progressUpdated and headersReceived functions can be ignored by plugins that
+ * do not have this information, but it will always be provided by
+ * NetworkingEngine.
  *
  * @exportDoc
  */
@@ -171,6 +176,17 @@ shaka.extern.SchemePlugin;
 shaka.extern.ProgressUpdated;
 
 
+/**
+ * @typedef {function(!Object.<string, string>)}
+ *
+ * @description
+ * A callback function to handle headers received events through networking
+ * engine in player.
+ * The first argument is the headers object of the response.
+ */
+shaka.extern.HeadersReceived;
+
+
 /**
  * Defines a filter for requests.  This filter takes the request and modifies
  * it before it is sent to the scheme plugin.

package/externs/shaka/offline.js

@@ -33,7 +33,8 @@ shaka.extern.OfflineSupport;
  *   size: number,
  *   expiration: number,
  *   tracks: !Array.<shaka.extern.Track>,
- *   appMetadata: Object
+ *   appMetadata: Object,
+ *   isIncomplete: boolean
  * }}
  *
  * @property {?string} offlineUri
@@ -53,6 +54,9 @@ shaka.extern.OfflineSupport;
  *   The tracks that are stored.
  * @property {Object} appMetadata
  *   The metadata passed to store().
+ * @property {boolean} isIncomplete
+ *   If true, the content is still downloading.  Manifests with this set cannot
+ *   be played yet.
  * @exportDoc
  */
 shaka.extern.StoredContent;
@@ -68,7 +72,8 @@ shaka.extern.StoredContent;
  *   streams: !Array.<shaka.extern.StreamDB>,
  *   sessionIds: !Array.<string>,
  *   drmInfo: ?shaka.extern.DrmInfo,
- *   appMetadata: Object
+ *   appMetadata: Object,
+ *   isIncomplete: (boolean|undefined)
  * }}
  *
  * @property {number} creationTime
@@ -91,6 +96,8 @@ shaka.extern.StoredContent;
  *   The DRM info used to initialize EME.
  * @property {Object} appMetadata
  *   A metadata object passed from the application.
+ * @property {(boolean|undefined)} isIncomplete
+ *   If true, the content is still downloading.
  */
 shaka.extern.ManifestDB;
 
@@ -194,6 +201,9 @@ shaka.extern.StreamDB;
  *   appendWindowStart: number,
  *   appendWindowEnd: number,
  *   timestampOffset: number,
+ *   tilesLayout: ?string,
+ *   pendingSegmentRefId: (string|undefined),
+ *   pendingInitSegmentRefId: (string|undefined),
  *   dataKey: number
  * }}
  *
@@ -210,6 +220,21 @@ shaka.extern.StreamDB;
  * @property {number} timestampOffset
  *   An offset which MediaSource will add to the segment's media timestamps
  *   during ingestion, to align to the presentation timeline.
+ * @property {?string} tilesLayout
+ *   The value is a grid-item-dimension consisting of two positive decimal
+ *   integers in the format: column-x-row ('4x3'). It describes the
+ *   arrangement of Images in a Grid. The minimum valid LAYOUT is '1x1'.
+ * @property {(string|undefined)} pendingSegmentRefId
+ *   Contains an id that identifies what the segment was, originally. Used to
+ *   coordinate where segments are stored, during the downloading process.
+ *   If this field is non-null, it's assumed that the segment is not fully
+ *   downloaded.
+ * @property {(string|undefined)} pendingInitSegmentRefId
+ *   Contains an id that identifies what the init segment was, originally.
+ *   Used to coordinate where init segments are stored, during the downloading
+ *   process.
+ *   If this field is non-null, it's assumed that the init segment is not fully
+ *   downloaded.
  * @property {number} dataKey
  *   The key to the data in storage.
  */
@@ -328,6 +353,15 @@ shaka.extern.StorageCell = class {
    */
   addManifests(manifests) {}
 
+  /**
+   * Updates the given manifest, stored at the given key.
+   *
+   * @param {number} key
+   * @param {!shaka.extern.ManifestDB} manifest
+   * @return {!Promise}
+   */
+  updateManifest(key, manifest) {}
+
   /**
    * Replace the expiration time of the manifest stored under |key| with
    * |newExpiration|. If no manifest is found under |key| then this should