shaka-player 3.1.5 → 3.2.3

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="E7271BEC">
        <!-- 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="E7271BEC">
     </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="E7271BEC">
       <!-- 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="E7271BEC">
       <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="E7271BEC">
       <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/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.

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
@@ -328,7 +333,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

package/externs/shaka/offline.js

@@ -194,6 +194,7 @@ shaka.extern.StreamDB;
  *   appendWindowStart: number,
  *   appendWindowEnd: number,
  *   timestampOffset: number,
+ *   tilesLayout: ?string,
  *   dataKey: number
  * }}
  *
@@ -210,6 +211,10 @@ 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 {number} dataKey
  *   The key to the data in storage.
  */

package/externs/shaka/player.js

@@ -516,6 +516,7 @@ shaka.extern.EmsgInfo;
  *   videoRobustness: string,
  *   audioRobustness: string,
  *   serverCertificate: Uint8Array,
+ *   serverCertificateUri: string,
  *   individualizationServer: string,
  *   sessionType: string
  * }}
@@ -545,6 +546,10 @@ shaka.extern.EmsgInfo;
  *   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 <code>''</code>.</i><br>
+ *   If given, will make a request to the given URI to get the server
+ *   certificate. This is ignored if <code>serverCertificate</code> is set.
  * @property {string} individualizationServer
  *   The server that handles an <code>'individualiation-request'</code>.  If the
  *   server isn't given, it will default to the license server.
@@ -569,7 +574,8 @@ shaka.extern.AdvancedDrmConfiguration;
  *       ((function(!Uint8Array, string, ?shaka.extern.DrmInfo):!Uint8Array)|
  *         undefined),
  *   logLicenseExchange: boolean,
- *   updateExpirationTime: number
+ *   updateExpirationTime: number,
+ *   preferredKeySystems: !Array.<string>
  * }}
  *
  * @property {shaka.extern.RetryParameters} retryParameters
@@ -607,6 +613,9 @@ shaka.extern.AdvancedDrmConfiguration;
  * @property {number} updateExpirationTime
  *   <i>Defaults to 1.</i> <br>
  *   The frequency in seconds with which to check the expiration of a session.
+ * @property {!Array.<string>} preferredKeySystems
+ *   <i>Defaults to an empty array. </i> <br>
+ *   Specifies the priorties of available DRM key systems.
  *
  * @exportDoc
  */
@@ -625,7 +634,8 @@ shaka.extern.DrmConfiguration;
  *   ignoreSuggestedPresentationDelay: boolean,
  *   ignoreEmptyAdaptationSet: boolean,
  *   ignoreMaxSegmentDuration: boolean,
- *   keySystemsByURI: !Object.<string, string>
+ *   keySystemsByURI: !Object.<string, string>,
+ *   manifestPreprocessor: function(!Element)
  * }}
  *
  * @property {string} clockSyncUri
@@ -675,6 +685,10 @@ shaka.extern.DrmConfiguration;
  * @property {Object.<string, string>} keySystemsByURI
  *   A map of scheme URI to key system name. Defaults to default key systems
  *   mapping handled by Shaka.
+ * @property {function(!Element)} manifestPreprocessor
+ *   Called immediately after the DASH manifest has been parsed into an
+ *   XMLDocument. Provides a way for applications to perform efficient
+ *   preprocessing of the manifest.
  * @exportDoc
  */
 shaka.extern.DashManifestConfiguration;
@@ -683,12 +697,16 @@ shaka.extern.DashManifestConfiguration;
 /**
  * @typedef {{
  *   ignoreTextStreamFailures: boolean,
+ *   ignoreImageStreamFailures: boolean,
  *   useFullSegmentsForStartTime: boolean
  * }}
  *
  * @property {boolean} ignoreTextStreamFailures
  *   If <code>true</code>, ignore any errors in a text stream and filter out
  *   those streams.
+ * @property {boolean} ignoreImageStreamFailures
+ *   If <code>true</code>, ignore any errors in a image stream and filter out
+ *   those streams.
  * @property {boolean} useFullSegmentsForStartTime
  *   If <code>true</code>, force HlsParser to use a full segment request for
  *   determining start time in case the server does not support partial requests
@@ -771,7 +789,8 @@ shaka.extern.ManifestConfiguration;
  *   lowLatencyMode: boolean,
  *   autoLowLatencyMode: boolean,
  *   forceHTTPS: boolean,
- *   preferNativeHls: boolean
+ *   preferNativeHls: boolean,
+ *   updateIntervalSeconds: number
  * }}
  *
  * @description
@@ -878,6 +897,8 @@ shaka.extern.ManifestConfiguration;
  *   If true, if the protocol is HTTP change it to HTTPs.
  * @property {boolean} preferNativeHls
  *   If true, prefer native HLS playback when possible, regardless of platform.
+ * @property {number} updateIntervalSeconds
+ *   The minimum number of seconds to see if the manifest has changes.
  *
  * @exportDoc
  */
@@ -971,13 +992,15 @@ shaka.extern.OfflineConfiguration;
  *   preferredTextLanguage: string,
  *   preferredVariantRole: string,
  *   preferredTextRole: string,
+ *   preferredVideoCodecs: !Array.<string>,
+ *   preferredAudioCodecs: !Array.<string>,
  *   preferredAudioChannelCount: number,
+ *   preferredDecodingAttributes: !Array.<string>,
  *   preferForcedSubs: boolean,
  *   restrictions: shaka.extern.Restrictions,
  *   playRangeStart: number,
  *   playRangeEnd: number,
- *   textDisplayFactory: shaka.extern.TextDisplayer.Factory,
- *   useMediaCapabilities: boolean
+ *   textDisplayFactory: shaka.extern.TextDisplayer.Factory
  * }}
  *
  * @property {shaka.extern.DrmConfiguration} drm
@@ -1005,8 +1028,15 @@ shaka.extern.OfflineConfiguration;
  *   The preferred role to use for variants.
  * @property {string} preferredTextRole
  *   The preferred role to use for text tracks.
+ * @property {!Array.<string>} preferredVideoCodecs
+ *   The list of preferred video codecs, in order of highest to lowest priority.
+ * @property {!Array.<string>} preferredAudioCodecs
+ *   The list of preferred audio codecs, in order of highest to lowest priority.
  * @property {number} preferredAudioChannelCount
  *   The preferred number of audio channels.
+ * @property {!Array.<string>} preferredDecodingAttributes
+ *   The list of preferred attributes of decodingInfo, in the order of their
+ *   priorities.
  * @property {boolean} preferForcedSubs
  *   If true, a forced text track is preferred.  Defaults to false.
  *   If the content has no forced captions and the value is true,
@@ -1026,10 +1056,6 @@ shaka.extern.OfflineConfiguration;
  * @property {shaka.extern.TextDisplayer.Factory} textDisplayFactory
  *   A factory to construct a text displayer. Note that, if this is changed
  *   during playback, it will cause the text tracks to be reloaded.
- * @property {boolean} useMediaCapabilities
- *   If true, use MediaCapabilities.decodingInfo() to filter the manifest, and
- *   get MediaKeys information for encrypted content. Default to false.
- *   Shaka Player's integration with MediaCapabilities is now in BETA.
  * @exportDoc
  */
 shaka.extern.PlayerConfiguration;
@@ -1056,6 +1082,8 @@ shaka.extern.LanguageRole;
 
 /**
  * @typedef {{
+ *   imageHeight: number,
+ *   imageWidth: number,
  *   height: number,
  *   positionX: number,
  *   positionY: number,
@@ -1065,6 +1093,12 @@ shaka.extern.LanguageRole;
  *   width: number
  * }}
  *
+ * @property {number} imageHeight
+ *    The image height in px. The image height could be different to height if
+ *    the layout is different to 1x1.
+ * @property {number} imageWidth
+ *    The image width in px. The image width could be different to width if
+ *    the layout is different to 1x1.
  * @property {number} height
  *    The thumbnail height in px.
  * @property {number} positionX
@@ -1083,3 +1117,21 @@ shaka.extern.LanguageRole;
  * @exportDoc
  */
 shaka.extern.Thumbnail;
+
+
+/**
+ * @typedef {{
+ *   title: string,
+ *   startTime: number,
+ *   endTime: number
+ * }}
+ *
+ * @property {string} title
+ *    The title of the chapter.
+ * @property {number} startTime
+ *    The time that describes the beginning of the range of the chapter.
+ * @property {number} endTime
+ *    The time that describes the end of the range of chapter.
+ * @exportDoc
+ */
+shaka.extern.Chapter;

package/externs/shaka/text.js

@@ -128,7 +128,7 @@ shaka.extern.Cue = class {
     /**
      * The text payload of the cue.  If nestedCues is non-empty, this should be
      * empty.  Top-level block containers should have no payload of their own.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.payload;
@@ -234,14 +234,14 @@ shaka.extern.Cue = class {
 
     /**
      * Text color as a CSS color, e.g. "#FFFFFF" or "white".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.color;
 
     /**
      * Text background color as a CSS color, e.g. "#FFFFFF" or "white".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.backgroundColor;
@@ -257,14 +257,14 @@ shaka.extern.Cue = class {
 
     /**
      * The URL of the background image, e.g. "data:[mime type];base64,[data]".
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.backgroundImage;
 
     /**
      * The border around this cue as a CSS border.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.border;
@@ -292,28 +292,28 @@ shaka.extern.Cue = class {
 
     /**
      * Text font family.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.fontFamily;
 
     /**
      * Text letter spacing as a CSS letter-spacing value.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.letterSpacing;
 
     /**
      * Text line padding as a CSS line-padding value.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.linePadding;
 
     /**
      * Opacity of the cue element, from 0-1.
-     * @type {!number}
+     * @type {number}
      * @exportDoc
      */
     this.opacity;
@@ -335,7 +335,7 @@ shaka.extern.Cue = class {
 
     /**
      * Id of the cue.
-     * @type {!string}
+     * @type {string}
      * @exportDoc
      */
     this.id;

package/externs/texttrack.js

@@ -20,3 +20,6 @@ TextTrack.prototype.kind;
 
 /** @type {string} */
 TextTrack.prototype.label;
+
+/** @type {string} */
+TextTrack.prototype.language;

package/lib/ads/ad_manager.js

@@ -6,7 +6,6 @@
 
 
 goog.provide('shaka.ads.AdManager');
-goog.provide('shaka.ads.CuePoint');
 
 goog.require('shaka.Player');
 goog.require('shaka.ads.AdsStats');
@@ -594,6 +593,22 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @override
+   * @export
+   */
+  getServerSideCuePoints() {
+    if (!this.ssAdManager_) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Category.ADS,
+          shaka.util.Error.Code.SS_AD_MANAGER_NOT_INITIALIZED);
+    }
+    return this.ssAdManager_.getCuePoints();
+  }
+
+
   /**
    * @return {shaka.extern.AdsStats}
    * @override
@@ -646,20 +661,6 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 };
 
-
-shaka.ads.CuePoint = class {
-  /**
-   * @param {number} start
-   * @param {?number=} end
-   */
-  constructor(start, end = null) {
-    /** @public {number} */
-    this.start = start;
-    /** @public {?number} */
-    this.end = end;
-  }
-};
-
 /**
  * The event name for when a sequence of ads has been loaded.
  *

package/lib/ads/client_side_ad_manager.js

@@ -162,10 +162,14 @@ shaka.ads.ClientSideAdManager = class {
 
     const cuePointStarts = this.imaAdsManager_.getCuePoints();
     if (cuePointStarts.length) {
-      /** @type {!Array.<!shaka.ads.CuePoint>} */
+      /** @type {!Array.<!shaka.extern.AdCuePoint>} */
       const cuePoints = [];
       for (const start of cuePointStarts) {
-        const shakaCuePoint = new shaka.ads.CuePoint(start);
+        /** @type {shaka.extern.AdCuePoint} */
+        const shakaCuePoint = {
+          start: start,
+          end: null,
+        };
         cuePoints.push(shakaCuePoint);
       }
 

package/lib/ads/server_side_ad_manager.js

@@ -64,6 +64,9 @@ shaka.ads.ServerSideAdManager = class {
     /** @private {string} */
     this.backupUrl_ = '';
 
+    /** @private {!Array.<!shaka.extern.AdCuePoint>} */
+    this.currentCuePoints_ = [];
+
     /** @private {shaka.util.EventManager} */
     this.eventManager_ = new shaka.util.EventManager();
 
@@ -212,6 +215,7 @@ shaka.ads.ServerSideAdManager = class {
     // this.streamManager_.reset();
     this.backupUrl_ = '';
     this.snapForwardTime_ = null;
+    this.currentCuePoints_ = [];
   }
 
   /** @override */
@@ -249,6 +253,13 @@ shaka.ads.ServerSideAdManager = class {
     }
   }
 
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   */
+  getCuePoints() {
+    return this.currentCuePoints_;
+  }
+
   /**
    * If a seek jumped over the ad break, return to the start of the
    * ad break, then complete the seek after the ad played through.
@@ -376,13 +387,19 @@ shaka.ads.ServerSideAdManager = class {
   onCuePointsChanged_(e) {
     const streamData = e.getStreamData();
 
-    /** @type {!Array.<!shaka.ads.CuePoint>} */
+    /** @type {!Array.<!shaka.extern.AdCuePoint>} */
     const cuePoints = [];
     for (const point of streamData.cuepoints) {
-      const shakaCuePoint = new shaka.ads.CuePoint(point.start, point.end);
+      /** @type {shaka.extern.AdCuePoint} */
+      const shakaCuePoint = {
+        start: point.start,
+        end: point.end,
+      };
       cuePoints.push(shakaCuePoint);
     }
 
+    this.currentCuePoints_ = cuePoints;
+
     this.onEvent_(new shaka.util.FakeEvent(
         shaka.ads.AdManager.CUEPOINTS_CHANGED,
         (new Map()).set('cuepoints', cuePoints)));

package/lib/cast/cast_proxy.js

@@ -648,6 +648,14 @@ shaka.cast.CastProxy = class extends shaka.util.FakeEventTarget {
       return () => this.localPlayer_.getNetworkingEngine();
     }
 
+    if (name == 'getDrmEngine') {
+      // Always returns a local instance.
+      if (this.sender_.isCasting()) {
+        shaka.log.warning('NOTE: getDrmEngine() is always local!');
+      }
+      return () => this.localPlayer_.getDrmEngine();
+    }
+
     if (name == 'getAdManager') {
       // Always returns a local instance.
       if (this.sender_.isCasting()) {

package/lib/cast/cast_utils.js

@@ -305,10 +305,11 @@ shaka.cast.CastUtils.PlayerGetterMethods = {
   'getAssetUri': 2,
   'getAudioLanguages': 4,
   'getAudioLanguagesAndRoles': 4,
+  'getBufferFullness': 1,
   'getBufferedInfo': 2,
   // NOTE: The 'getSharedConfiguration' property is not proxied as it would
   //       not be possible to share a reference.
-  'getConfiguration': 2,
+  'getConfiguration': 4,
   'getExpiration': 2,
   'getKeyStatuses': 2,
   // NOTE: The 'getManifest' property is not proxied, as it is very large.
@@ -371,10 +372,13 @@ shaka.cast.CastUtils.PlayerInitAfterLoadState = [
  * @const {!Array.<string>}
  */
 shaka.cast.CastUtils.PlayerVoidMethods = [
+  'addChaptersTrack',
   'addTextTrack',
   'addTextTrackAsync',
   'cancelTrickPlay',
   'configure',
+  'getChapters',
+  'getChaptersTracks',
   'resetConfiguration',
   'retryStreaming',
   'selectAudioLanguage',
@@ -384,6 +388,7 @@ shaka.cast.CastUtils.PlayerVoidMethods = [
   'selectVariantsByLabel',
   'setTextTrackVisibility',
   'trickPlay',
+  'goToLive',
 ];