shaka-player 4.10.13 → 4.11.0

package/externs/mediasession.js

@@ -36,9 +36,18 @@ const MediaSession = class {
   setActionHandler(type, callback) {
     /** @type {string} */
     this.type = type;
-    /** @type {!function(!{action: string, seekOffset: ?number})} */
+
+    /** @type {!function(!{action: string, seekOffset: ?number,
+     *                     seekTime: ?number})}
+     */
     this.callback = callback;
   }
+
+  /**
+   * @param {?{duration: ?number, playbackRate: ?number,
+   *         position: ?number}=} stateDict
+   */
+  setPositionState(stateDict) {}
 };
 
 

package/externs/shaka/ads.js

@@ -57,6 +57,65 @@ shaka.extern.AdsStats;
 shaka.extern.AdCuePoint;
 
 
+/**
+ * @typedef {{
+ *   id: ?string,
+ *   startTime: number,
+ *   endTime: ?number,
+ *   uri: string,
+ *   isSkippable: boolean,
+ *   skipOffset: ?number,
+ *   canJump: boolean,
+ *   resumeOffset: ?number,
+ *   playoutLimit: ?number,
+ *   once: boolean,
+ *   pre: boolean,
+ *   post: boolean,
+ *   timelineRange: boolean
+ * }}
+ *
+ * @description
+ * Contains the ad interstitial info.
+ *
+ * @property {?string} id
+ *   The id of the interstitial.
+ * @property {number} startTime
+ *   The start time of the interstitial.
+ * @property {?number} endTime
+ *   The end time of the interstitial.
+ * @property {string} uri
+ *   The uri of the interstitial, can be any type that
+ *   ShakaPlayer supports (either in MSE or src=)
+ * @property {boolean} isSkippable
+ *   Indicate if the interstitial is skippable.
+ * @property {?number} skipOffset
+ *   Time value that identifies when skip controls are made available to the
+ *   end user.
+ * @property {boolean} canJump
+ *   Indicate if the interstitial is jumpable.
+ * @property {?number} resumeOffset
+ *   Indicates where the primary playback will resume after the interstitial
+ *   plays. It is expressed as a time lag from when interstitial playback was
+ *   scheduled on the primary player's timeline. For live ad replacement it
+ *   must be null.
+ * @property {?number} playoutLimit
+ *   Indicate a limit for the playout time of the entire interstitial.
+ * @property {boolean} once
+ *   Indicates that the interstitial should only be played once.
+ * @property {boolean} pre
+ *   Indicates that an action is to be triggered before playback of the
+ *   primary asset begins, regardless of where playback begins in the primary
+ *   asset.
+ * @property {boolean} post
+ *   Indicates that an action is to be triggered after the primary asset has
+ *   been played to its end without error.
+ * @property {boolean} timelineRange
+ *   Indicates whether the  interstitial should be presented in a timeline UI
+ *   as a single point or as a range.
+ */
+shaka.extern.AdInterstitial;
+
+
 /**
  * An object that's responsible for all the ad-related logic
  * in the player.
@@ -187,9 +246,27 @@ shaka.extern.IAdManager = class extends EventTarget {
   /**
    * @param {!shaka.Player} basePlayer
    * @param {!HTMLMediaElement} baseVideo
-   * @param {shaka.extern.Interstitial} interstitial
+   * @param {shaka.extern.HLSInterstitial} interstitial
+   */
+  onHLSInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
+
+  /**
+   * @param {!shaka.Player} basePlayer
+   * @param {!HTMLMediaElement} baseVideo
+   * @param {shaka.extern.TimelineRegionInfo} region
+   */
+  onDASHInterstitialMetadata(basePlayer, baseVideo, region) {}
+
+  /**
+   * @param {shaka.extern.AdInterstitial} interstitial
+   */
+  addCustomInterstitial(interstitial) {}
+
+  /**
+   * @param {string} url
+   * @return {!Promise}
    */
-  onInterstitialMetadata(basePlayer, baseVideo, interstitial) {}
+  addAdUrlInterstitial(url) {}
 };
 
 

package/externs/shaka/manifest.js

@@ -25,7 +25,8 @@
  *   nextUrl: ?string,
  *   periodCount: number,
  *   gapCount: number,
- *   isLowLatency: boolean
+ *   isLowLatency: boolean,
+ *   startTime: ?number
  * }}
  *
  * @description
@@ -111,6 +112,10 @@
  *   If in src= mode or nothing is loaded, NaN.
  * @property {bolean} isLowLatency
  *   If true, the manifest is Low Latency.
+ * @property {?number} startTime
+ *   Indicate the startTime of the playback, when <code>startTime</code> is
+ *   <code>null</code>, playback will start at the default start time.
+ *   Note: It only overrides the load startTime when it is not defined.
  *
  * @exportDoc
  */

package/externs/shaka/manifest_parser.js

@@ -47,9 +47,10 @@ shaka.extern.ManifestParser = class {
    * configuration changes.  Will be called at least once before start().
    *
    * @param {shaka.extern.ManifestConfiguration} config
+   * @param {(function():boolean)=} isPreloadFn
    * @exportDoc
    */
-  configure(config) {}
+  configure(config, isPreloadFn) {}
 
   /**
    * Initialize and start the parser. When |start| resolves, it should return
@@ -139,7 +140,8 @@ shaka.extern.ManifestParser = class {
  *   getBandwidthEstimate: function():number,
  *   onMetadata: function(string, number, ?number,
  *                        !Array.<shaka.extern.MetadataFrame>),
- *   disableStream: function(!shaka.extern.Stream)
+ *   disableStream: function(!shaka.extern.Stream),
+ *   addFont: function(string, string)
  * }}
  *
  * @description
@@ -184,6 +186,8 @@ shaka.extern.ManifestParser = class {
  * @property {function(!shaka.extern.Stream)} disableStream
  *   Called to temporarily disable a stream i.e. disabling all variant
  *   containing said stream.
+ * @property {function(string, string)} addFont
+ *   Called when a new font needs to be added.
  * @exportDoc
  */
 shaka.extern.ManifestParser.PlayerInterface;

package/externs/shaka/net.js

@@ -169,7 +169,8 @@ shaka.extern.Response;
  *                     shaka.extern.Request,
  *                     shaka.net.NetworkingEngine.RequestType,
  *                     shaka.extern.ProgressUpdated,
- *                     shaka.extern.HeadersReceived):
+ *                     shaka.extern.HeadersReceived,
+ *                     shaka.extern.SchemePluginConfig):
  *     !shaka.extern.IAbortableOperation.<shaka.extern.Response>}
  * @description
  * Defines a plugin that handles a specific scheme.
@@ -185,6 +186,23 @@ shaka.extern.Response;
 shaka.extern.SchemePlugin;
 
 
+/**
+ * @typedef {{
+*   minBytesForProgressEvents: (number|undefined)
+* }}
+*
+* @description
+*   Defines configuration object to use by SchemePlugins.
+*
+* @property {(number|undefined)} minBytesForProgressEvents
+*   Defines minimum number of bytes that should be use to emit progress event,
+*   if possible.
+*
+* @exportDoc
+*/
+shaka.extern.SchemePluginConfig;
+
+
 /**
  * @typedef {function(number, number, number)}
  *
@@ -217,7 +235,8 @@ shaka.extern.HeadersReceived;
  * @typedef {{
  *   type: (shaka.net.NetworkingEngine.AdvancedRequestType|undefined),
  *   stream: (shaka.extern.Stream|undefined),
- *   segment: (shaka.media.SegmentReference|undefined)
+ *   segment: (shaka.media.SegmentReference|undefined),
+ *   isPreload: (boolean|undefined)
  * }}
  *
  * @description
@@ -229,6 +248,8 @@ shaka.extern.HeadersReceived;
  *   The duration of the segment in seconds
  * @property {shaka.media.SegmentReference=} segment
  *   The request's segment reference
+ * @property {boolean=} isPreload
+ *   Whether the request came from a preload or a normal load.
  * @exportDoc
  */
 shaka.extern.RequestContext;