shaka-player 4.9.13 → 4.10.1

package/lib/ads/ad_manager.js

@@ -12,7 +12,9 @@ goog.require('shaka.Deprecate');
 goog.require('shaka.Player');
 goog.require('shaka.ads.AdsStats');
 goog.require('shaka.ads.ClientSideAdManager');
+goog.require('shaka.ads.InterstitialAdManager');
 goog.require('shaka.ads.MediaTailorAdManager');
+goog.require('shaka.ads.Utils');
 goog.require('shaka.ads.ServerSideAdManager');
 goog.require('shaka.log');
 goog.require('shaka.util.Error');
@@ -170,13 +172,13 @@ goog.require('shaka.util.IReleasable');
 
 
 /**
- * @event shaka.ads.AdManager.AdResumedEvent
+ * @event shaka.ads.AdManager.AdCuePointsChangedEvent
  * @description Fired when the ad cue points change, signalling ad breaks
  *  change.
  * @property {string} type
  *   'ad-cue-points-changed'
- * @property {Object} originalEvent
- *    The native SDK event, if available.
+ * @property {!Array.<!shaka.extern.AdCuePoint>} cuepoints
+ *    The ad cue points, if available.
  * @exportDoc
  */
 
@@ -318,7 +320,7 @@ goog.require('shaka.util.IReleasable');
 
 
 /**
- * @event shaka.ads.AdManager.AD_ERROR
+ * @event shaka.ads.Utils.AD_ERROR
  * @description Fired when a fatal error is encountered.
  * @property {string} type
  *   'ad-error'
@@ -370,6 +372,40 @@ goog.require('shaka.util.IReleasable');
  */
 
 
+/**
+ * @event shaka.ads.AdManager.AdContentPauseRequestedEvent
+ * @description Fired when the ad requires the main content to be paused.
+ *   Fired when the platform does not support multiple media elements.
+ * @property {string} type
+ *   'ad-content-pause-requested'
+ * @property {?boolean} saveLivePosition
+ *    Indicates whether the live position has to be saved or not.
+ * @exportDoc
+ */
+
+
+/**
+ * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
+ * @description Fired when the ad requires the main content to be resumed.
+ *   Fired when the platform does not support multiple media elements.
+ * @property {string} type
+ *   'ad-content-resume-requested'
+ * @property {?number} offset
+ *   Indicates the offset that should be applied to the previously saved time.
+ * @exportDoc
+ */
+
+
+/**
+ * @event shaka.ads.AdManager.AdContentResumeRequestedEvent
+ * @description Fired when the ad requires the video of the main content to be
+ *   attached.
+ * @property {string} type
+ *   'ad-content-attach-requested'
+ * @exportDoc
+ */
+
+
 /**
  * A class responsible for ad-related interactions.
  * @implements {shaka.extern.IAdManager}
@@ -380,6 +416,8 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   /** */
   constructor() {
     super();
+    /** @private {shaka.ads.InterstitialAdManager} */
+    this.interstitialAdManager_ = null;
     /** @private {shaka.ads.ClientSideAdManager} */
     this.csAdManager_ = null;
     /** @private {shaka.ads.MediaTailorAdManager} */
@@ -410,6 +448,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    */
   configure(config) {
     this.config_ = config;
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.configure(this.config_);
+    }
     if (this.csAdManager_) {
       this.csAdManager_.configure(this.config_);
     }
@@ -419,6 +460,26 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @override
+   * @export
+   */
+  initInterstitial(adContainer, basePlayer, baseVideo) {
+    if (!adContainer) {
+      shaka.log.info('Initializing interstitials without ad container');
+    }
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.release();
+    }
+    this.interstitialAdManager_ = new shaka.ads.InterstitialAdManager(
+        adContainer, basePlayer, baseVideo,
+        (e) => this.processAndDispatchEvent_(e));
+
+    goog.asserts.assert(this.config_, 'Config must not be null!');
+    this.interstitialAdManager_.configure(this.config_);
+  }
+
+
   /**
    * @override
    * @export
@@ -455,6 +516,10 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @export
    */
   release() {
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.release();
+      this.interstitialAdManager_ = null;
+    }
     if (this.csAdManager_) {
       this.csAdManager_.release();
       this.csAdManager_ = null;
@@ -476,6 +541,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   * @export
   */
   onAssetUnload() {
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.stop();
+    }
     if (this.csAdManager_) {
       this.csAdManager_.stop();
     }
@@ -487,7 +555,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     }
 
     this.dispatchEvent(
-        new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
+        new shaka.util.FakeEvent(shaka.ads.Utils.AD_STOPPED));
+    this.dispatchEvent(new shaka.util.FakeEvent(
+        shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED));
 
     this.stats_ = new shaka.ads.AdsStats();
   }
@@ -749,6 +819,19 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     }
   }
 
+  /**
+   * @override
+   * @export
+   */
+  onInterstitialMetadata(basePlayer, baseVideo, interstitial) {
+    if (!this.interstitialAdManager_) {
+      this.initInterstitial(/* adContainer= */ null, basePlayer, baseVideo);
+    }
+    if (this.interstitialAdManager_) {
+      this.interstitialAdManager_.addMetadata(interstitial);
+    }
+  }
+
   /**
    * @param {!shaka.util.FakeEvent} event
    * @private
@@ -756,20 +839,23 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   processAndDispatchEvent_(event) {
     if (event && event.type) {
       switch (event.type) {
-        case shaka.ads.AdManager.ADS_LOADED: {
+        case shaka.ads.Utils.ADS_LOADED: {
           const loadTime = (/** @type {!Object} */ (event))['loadTime'];
           this.stats_.addLoadTime(loadTime);
           break;
         }
-        case shaka.ads.AdManager.AD_STARTED:
+        case shaka.ads.Utils.AD_STARTED:
           this.stats_.incrementStarted();
           break;
-        case shaka.ads.AdManager.AD_COMPLETE:
+        case shaka.ads.Utils.AD_COMPLETE:
           this.stats_.incrementPlayedCompletely();
           break;
-        case shaka.ads.AdManager.AD_SKIPPED:
+        case shaka.ads.Utils.AD_SKIPPED:
           this.stats_.incrementSkipped();
           break;
+        case shaka.ads.Utils.AD_ERROR:
+          this.stats_.incrementErrors();
+          break;
       }
     }
     this.dispatchEvent(event);
@@ -779,16 +865,22 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 /**
  * The event name for when a sequence of ads has been loaded.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.ADS_LOADED = 'ads-loaded';
 
 /**
  * The event name for when an ad has started playing.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_STARTED = 'ad-started';
 
@@ -796,8 +888,11 @@ shaka.ads.AdManager.AD_STARTED = 'ad-started';
 /**
  * The event name for when an ad playhead crosses first quartile.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
 
@@ -805,8 +900,11 @@ shaka.ads.AdManager.AD_FIRST_QUARTILE = 'ad-first-quartile';
 /**
  * The event name for when an ad playhead crosses midpoint.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
 
@@ -814,8 +912,11 @@ shaka.ads.AdManager.AD_MIDPOINT = 'ad-midpoint';
 /**
  * The event name for when an ad playhead crosses third quartile.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
 
@@ -823,8 +924,11 @@ shaka.ads.AdManager.AD_THIRD_QUARTILE = 'ad-third-quartile';
 /**
  * The event name for when an ad has completed playing.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
 
@@ -834,17 +938,23 @@ shaka.ads.AdManager.AD_COMPLETE = 'ad-complete';
  * (played all the way through, was skipped, or was unable to proceed
  * due to an error).
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_STOPPED = 'ad-stopped';
 
 
 /**
- * The event name for when an ad is skipped by the user..
+ * The event name for when an ad is skipped by the user.
+ *
+ * Deprecated, please use {@link shaka.ads.Utils}
  *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
 
@@ -852,8 +962,11 @@ shaka.ads.AdManager.AD_SKIPPED = 'ad-skipped';
 /**
  * The event name for when the ad volume has changed.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
 
@@ -861,8 +974,11 @@ shaka.ads.AdManager.AD_VOLUME_CHANGED = 'ad-volume-changed';
 /**
  * The event name for when the ad was muted.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_MUTED = 'ad-muted';
 
@@ -870,8 +986,11 @@ shaka.ads.AdManager.AD_MUTED = 'ad-muted';
 /**
  * The event name for when the ad was paused.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
 
@@ -879,8 +998,11 @@ shaka.ads.AdManager.AD_PAUSED = 'ad-paused';
 /**
  * The event name for when the ad was resumed after a pause.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
 
@@ -889,8 +1011,11 @@ shaka.ads.AdManager.AD_RESUMED = 'ad-resumed';
  * The event name for when the ad's skip status changes
  * (usually it becomes skippable when it wasn't before).
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
 
@@ -899,8 +1024,11 @@ shaka.ads.AdManager.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
  * The event name for when the ad's cue points (start/end markers)
  * have changed.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
 
@@ -909,8 +1037,11 @@ shaka.ads.AdManager.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
  * The event name for when the native IMA ad manager object has
  * loaded and become available.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
 
@@ -919,8 +1050,11 @@ shaka.ads.AdManager.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
  * The event name for when the native IMA stream manager object has
  * loaded and become available.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
 
@@ -928,8 +1062,11 @@ shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
 /**
  * The event name for when the ad was clicked.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
 
@@ -937,8 +1074,11 @@ shaka.ads.AdManager.AD_CLICKED = 'ad-clicked';
 /**
  * The event name for when there is an update to the current ad's progress.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
 
@@ -946,8 +1086,11 @@ shaka.ads.AdManager.AD_PROGRESS = 'ad-progress';
 /**
  * The event name for when the ad is buffering.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
 
@@ -955,8 +1098,11 @@ shaka.ads.AdManager.AD_BUFFERING = 'ad-buffering';
 /**
  * The event name for when the ad's URL was hit.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
 
@@ -964,8 +1110,11 @@ shaka.ads.AdManager.AD_IMPRESSION = 'ad-impression';
 /**
  * The event name for when the ad's duration changed.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
 
@@ -973,8 +1122,11 @@ shaka.ads.AdManager.AD_DURATION_CHANGED = 'ad-duration-changed';
 /**
  * The event name for when the ad was closed by the user.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
 
@@ -982,8 +1134,11 @@ shaka.ads.AdManager.AD_CLOSED = 'ad-closed';
 /**
  * The event name for when the ad data becomes available.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
 
@@ -991,8 +1146,11 @@ shaka.ads.AdManager.AD_LOADED = 'ad-loaded';
 /**
  * The event name for when all the ads were completed.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
 
@@ -1000,8 +1158,11 @@ shaka.ads.AdManager.ALL_ADS_COMPLETED = 'all-ads-completed';
 /**
  * The event name for when the ad changes from or to linear.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
 
@@ -1009,8 +1170,11 @@ shaka.ads.AdManager.AD_LINEAR_CHANGED = 'ad-linear-changed';
 /**
  * The event name for when the ad's metadata becomes available.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
 
@@ -1019,16 +1183,22 @@ shaka.ads.AdManager.AD_METADATA = 'ad-metadata';
  * The event name for when the ad display encountered a recoverable
  * error.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
 
 /**
  * The event name for when the ad manager dispatch errors.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_ERROR = 'ad-error';
 
@@ -1036,8 +1206,11 @@ shaka.ads.AdManager.AD_ERROR = 'ad-error';
  * The event name for when the client side SDK signalled its readiness
  * to play a VPAID ad or an ad rule.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
 
@@ -1046,12 +1219,54 @@ shaka.ads.AdManager.AD_BREAK_READY = 'ad-break-ready';
  * The event name for when the interaction callback for the ad was
  * triggered.
  *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
  * @const {string}
  * @export
+ * @deprecated
  */
 shaka.ads.AdManager.AD_INTERACTION = 'ad-interaction';
 
 
+/**
+ * The name of the event for when an ad requires the main content to be paused.
+ * Fired when the platform does not support multiple media elements.
+ *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
+ * @const {string}
+ * @export
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_PAUSE_REQUESTED = 'ad-content-pause-requested';
+
+
+/**
+ * The name of the event for when an ad requires the main content to be resumed.
+ * Fired when the platform does not support multiple media elements.
+ *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
+ * @const {string}
+ * @export
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_RESUME_REQUESTED = 'ad-content-resume-requested';
+
+
+/**
+ * The name of the event for when an ad requires the video of the main content
+ * to be attached.
+ *
+ * Deprecated, please use {@link shaka.ads.Utils}
+ *
+ * @const {string}
+ * @export
+ * @deprecated
+ */
+shaka.ads.AdManager.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';
+
+
 /**
  * Set this is a default ad manager for the player.
  * Apps can also set their own ad manager, if they'd like.