shaka-player 2.5.1 → 2.5.5

package/docs/tutorials/drm-config.md

@@ -160,3 +160,4 @@ values for other key systems are not known to us at this time.
 #### Continue the Tutorials
 
 Next, check out {@tutorial license-server-auth}.
+Or check out {@tutorial fairplay}.

package/docs/tutorials/fairplay.md

@@ -0,0 +1,77 @@
+# FairPlay Support
+
+When using native `src=` playback, we support using FairPlay on Safari.
+Adding FairPlay support involves a bit more work than other key systems.
+
+
+## Server certificate
+
+All FairPlay content requires setting a server certificate.  This is set in the
+Player configuration:
+
+```js
+const req = await fetch('https://example.com/cert.der');
+const cert = await req.arrayBuffer();
+
+player.configure('drm.advanced.com\\.apple\\.fps\\.1_0.serverCertificate',
+                 new Uint8Array(cert));
+```
+
+
+## Content ID
+
+Some FairPlay content use custom signaling for the content ID.  The content ID
+is used by the browser to generate the license request.  If you don't use the
+default content ID derivation, you need to specify a custom init data transform:
+
+```js
+player.configure('drm.initDataTransform', (initData) => {
+  const contentId = getMyContentId(initData);
+  const cert = player.drmInfo().serverCertificate;
+  return shaka.util.FairPlayUtils.initDataTransform(initData, contentId, cert);
+});
+```
+
+## License wrapping
+
+For v2.5.x, we provide a default license request/response filter that mirrors
+the FairPlay examples.  You can remove these by setting the
+`drm.fairPlayTransform` configuration to `false`.
+
+Some FairPlay servers need to accept the license request in a different format
+or give the response in a different format.  For more info, see the general
+{@tutorial license-wrapping} tutorial:
+
+```js
+player.getNetworkingEngine().registerRequestFilter((type, request) => {
+  if (type != shaka.net.NetworkingEngine.RequestType.LICENSE) {
+    return;
+  }
+
+  const originalPayload = new Uint8Array(request.body);
+  const base64Payload =
+      shaka.util.Uint8ArrayUtils.toStandardBase64(originalPayload);
+  const params = 'spc=' + base64Payload;
+  request.headers['Content-Type'] = 'application/x-www-form-urlencoded';
+  request.body = shaka.util.StringUtils.toUTF8(encodeURIComponent(params));
+});
+
+player.getNetworkingEngine().registerResponseFilter((type, request) => {
+  if (type != shaka.net.NetworkingEngine.RequestType.LICENSE) {
+    return;
+  }
+
+  let responseText = shaka.util.StringUtils.fromUTF8(response.data);
+  // Trim whitespace.
+  responseText = responseText.trim();
+
+  // Look for <ckc> wrapper and remove it.
+  if (responseText.substr(0, 5) === '<ckc>' &&
+      responseText.substr(-6) === '</ckc>') {
+    responseText = responseText.slice(5, -6);
+  }
+
+  // Decode the base64-encoded data into the format the browser expects.
+  response.data = shaka.util.Uint8ArrayUtils.fromBase64(responseText).buffer;
+});
+```

package/docs/tutorials/index.json

@@ -15,6 +15,7 @@
   { "architecture": { "title": "Architecture Diagrams" } },
   { "service-worker": { "title": "Service Worker Caching" } },
   { "offline": { "title": "Offline Storage and Playback" } },
+  { "fairplay": { "title": "FairPlay support" } },
   { "faq": { "title": "Frequently Asked Questions" } },
   { "upgrade": {
       "title": "Upgrade Guide",

package/docs/tutorials/manifest-parser.md

@@ -216,7 +216,7 @@ In order to support Live content, the manifest may need to be updated.  In the
 `setInterval`) to update the manifest.  Then it should re-parse the manifest
 periodically.  To add new segments to the streams, simply add them to the
 segment index.  Because the original manifest object is modified in-place,
-adding them to the index will allow the Player to use them. You *cannnot* add
+adding them to the index will allow the Player to use them. You *cannot* add
 new Variants or text streams to an existing Period.
 
 To add a new Period, you must first call `filterNewPeriod`. This will filter out

package/docs/tutorials/ui-customization.md

@@ -68,6 +68,9 @@ The following buttons can be added to the overflow menu:
   that support it. Button is invisible on other browsers.
 <!-- TODO: If we add more buttons that can be put in the order this way, list them here. -->
 
+The presense 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.
+
 UI layout can be reconfigured at any point after it's been created.
 Please note that custom layouts might need CSS adjustments to look good.
 
@@ -75,8 +78,8 @@ Please note that custom layouts might need CSS adjustments to look good.
 <!-- TODO: Is there a better way to do this? (The actual thing, not the tutorial) -->
 The seek bar consists of three segments: past (already played part of the presentation),
 future-buffered and future-unbuffered. The segments colors are set when the seek bar is created.
-To customize the colors, change the values of `shaka.ui.Controls.SEEK_BAR_BASE_COLOR_` ,
-`shaka.ui.Controls.SEEK_BAR_PLAYED_COLOR_`, and `shaka.ui.Controls.SEEK_BAR_BUFFERED_COLOR_` in ui/controls.js
+To customize the colors, change the values of `shaka.ui.Constants.SEEK_BAR_BASE_COLOR` ,
+`shaka.ui.Constants.SEEK_BAR_PLAYED_COLOR`, and `shaka.ui.Constants.SEEK_BAR_BUFFERED_COLOR` in ui/controls.js
 
 
 #### Creating custom elements and adding them to the UI

package/docs/tutorials/ui.md

@@ -19,6 +19,8 @@ Set up controls with HTML data attributes:
     <script src="dist/shaka-player.ui.js"></script>
     <!-- Shaka Player ui compiled library default CSS: -->
     <link rel="stylesheet" type="text/css" href="dist/controls.css">
+    <!-- Chromecast SDK (if you want Chromecast support for your app): -->
+    <script defer src="https://www.gstatic.com/cv/js/sender/v1/cast_sender.js"></script>
     <!-- Your application source: -->
     <script src="myapp.js"></script>
   </head>
@@ -27,7 +29,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="A15A181D">
+         data-shaka-player-cast-receiver-id="7B25EC44">
        <!-- 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>
@@ -60,7 +62,7 @@ async function init() {
     // This runs if the asynchronous load is successful.
     console.log('The video has now been loaded!');
   } catch (error) {
-    onError(error);
+    onPlayerError(error);
   }
 }
 
@@ -71,21 +73,24 @@ function onPlayerErrorEvent(errorEvent) {
 
 function onPlayerError(error) {
   // Handle player error
+  console.error('Error code', error.code, 'object', error);
 }
 
 function onUIErrorEvent(errorEvent) {
-  // Handle UI error
+  // Extract the shaka.util.Error object from the event.
+  onPlayerError(event.detail);
 }
 
 function initFailed() {
   // Handle the failure to load
+  console.error('Unable to load the UI library!');
 }
 
 // Listen to the custom shaka-ui-loaded event, to wait until the UI is loaded.
 document.addEventListener('shaka-ui-loaded', init);
 // Listen to the custom shaka-ui-load-failed event, in case Shaka Player fails
 // to load (e.g. due to lack of browser support).
-document.addEventListener('shaka-ui-load-failed, initFailed);
+document.addEventListener('shaka-ui-load-failed', initFailed);
 
 ```
 
@@ -116,6 +121,7 @@ Next, let's add a listener to the 'caststatuschanged' event in myapp.js:
   function onCastStatusChanged(event) {
     const newCastStatus = event['newStatus'];
     // Handle cast status change
+    console.log('The new cast status is: ' + newCastStatus);
   }
 
 ```

package/docs/tutorials/welcome.md

@@ -28,9 +28,9 @@ externs have been generated.
 You can build Shaka on Linux, Windows, or Mac.
 To get the sources and compile the library, you will need:
   * {@link https://git-scm.com/downloads Git v1.9+}
-  * {@link https://www.python.org/downloads/ Python v2.7}
+  * {@link https://www.python.org/downloads/ Python v2.7 or v3.5+}
   * {@link https://java.com/en/download/ Java Runtime Environment v8+}
-  * {@link https://nodejs.org/en/download/ NodeJS v6+}
+  * {@link https://nodejs.org/en/download/ NodeJS v8+}
   * A local web server, such as {@link https://httpd.apache.org/ Apache}
     * _NOTE: A local web server is required because browsers place restrictions
       on applications from file:/// URLs._

package/externs/mediasession.js

@@ -34,5 +34,20 @@ var MediaMetadata = function(options) {};
 MediaMetadata.prototype.title;
 
 
-/** @type {MediaMetadata} */
+/** @type {string} */
+MediaMetadata.prototype.artist;
+
+
+/** @type {string} */
+MediaMetadata.prototype.artwork;
+
+
+/** @constructor */
+var MediaSession = function() {};
+
+/** @type {?MediaMetadata} */
+MediaSession.prototype.metadata;
+
+
+/** @type {MediaSession} */
 Navigator.prototype.mediaSession;

package/externs/shaka/net.js

@@ -60,7 +60,8 @@ shaka.extern.RetryParameters;
  *   headers: !Object.<string, string>,
  *   allowCrossSiteCredentials: boolean,
  *   retryParameters: !shaka.extern.RetryParameters,
- *   licenseRequestType: ?string
+ *   licenseRequestType: ?string,
+ *   sessionId: ?string
  * }}
  *
  * @description
@@ -87,6 +88,9 @@ shaka.extern.RetryParameters;
  *   request it is (not the type of license).  This is the |messageType| field
  *   of the EME message.  For example, this could be 'license-request' or
  *   'license-renewal'.
+ * @property {?string} sessionId
+ *   If this is a LICENSE request, this field contains the session ID of the
+ *   EME session that made the request.
  *
  * @exportDoc
  */
@@ -110,6 +114,9 @@ shaka.extern.Request;
  * @property {string} uri
  *   The URI which was loaded.  Request filters and server redirects can cause
  *   this to be different from the original request URIs.
+ * @property {string} originalUri
+ *   The original URI passed to the browser for networking. This is before any
+ *   redirects, but after request filters are executed.
  * @property {ArrayBuffer} data
  *   The body of the response.
  * @property {!Object.<string, string>} headers
@@ -132,13 +139,16 @@ shaka.extern.Response;
  * @typedef {!function(string,
  *                     shaka.extern.Request,
  *                     shaka.net.NetworkingEngine.RequestType,
- *                     shaka.extern.ProgressUpdated=):
+ *                     shaka.extern.ProgressUpdated):
  *     !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 an optional progressUpdated function.
-
+ * 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.
+ *
  * @exportDoc
  */
 shaka.extern.SchemePlugin;