shaka-player 4.9.13 → 4.10.1

package/lib/ads/ad_utils.js

@@ -0,0 +1,323 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+goog.provide('shaka.ads.Utils');
+
+
+/**
+ * A class responsible for ad utils.
+ * @export
+ */
+shaka.ads.Utils = class {
+
+};
+
+/**
+ * The event name for when a sequence of ads has been loaded.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.ADS_LOADED = 'ads-loaded';
+
+/**
+ * The event name for when an ad has started playing.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_STARTED = 'ad-started';
+
+
+/**
+ * The event name for when an ad playhead crosses first quartile.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_FIRST_QUARTILE = 'ad-first-quartile';
+
+
+/**
+ * The event name for when an ad playhead crosses midpoint.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_MIDPOINT = 'ad-midpoint';
+
+
+/**
+ * The event name for when an ad playhead crosses third quartile.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_THIRD_QUARTILE = 'ad-third-quartile';
+
+
+/**
+ * The event name for when an ad has completed playing.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_COMPLETE = 'ad-complete';
+
+
+/**
+ * The event name for when an ad has finished playing
+ * (played all the way through, was skipped, or was unable to proceed
+ * due to an error).
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_STOPPED = 'ad-stopped';
+
+
+/**
+ * The event name for when an ad is skipped by the user..
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_SKIPPED = 'ad-skipped';
+
+
+/**
+ * The event name for when the ad volume has changed.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_VOLUME_CHANGED = 'ad-volume-changed';
+
+
+/**
+ * The event name for when the ad was muted.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_MUTED = 'ad-muted';
+
+
+/**
+ * The event name for when the ad was paused.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_PAUSED = 'ad-paused';
+
+
+/**
+ * The event name for when the ad was resumed after a pause.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_RESUMED = 'ad-resumed';
+
+
+/**
+ * The event name for when the ad's skip status changes
+ * (usually it becomes skippable when it wasn't before).
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_SKIP_STATE_CHANGED = 'ad-skip-state-changed';
+
+
+/**
+ * The event name for when the ad's cue points (start/end markers)
+ * have changed.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.CUEPOINTS_CHANGED = 'ad-cue-points-changed';
+
+
+/**
+ * The event name for when the native IMA ad manager object has
+ * loaded and become available.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.IMA_AD_MANAGER_LOADED = 'ima-ad-manager-loaded';
+
+
+/**
+ * The event name for when the native IMA stream manager object has
+ * loaded and become available.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.IMA_STREAM_MANAGER_LOADED = 'ima-stream-manager-loaded';
+
+
+/**
+ * The event name for when the ad was clicked.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_CLICKED = 'ad-clicked';
+
+
+/**
+ * The event name for when there is an update to the current ad's progress.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_PROGRESS = 'ad-progress';
+
+
+/**
+ * The event name for when the ad is buffering.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_BUFFERING = 'ad-buffering';
+
+
+/**
+ * The event name for when the ad's URL was hit.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_IMPRESSION = 'ad-impression';
+
+
+/**
+ * The event name for when the ad's duration changed.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_DURATION_CHANGED = 'ad-duration-changed';
+
+
+/**
+ * The event name for when the ad was closed by the user.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_CLOSED = 'ad-closed';
+
+
+/**
+ * The event name for when the ad data becomes available.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_LOADED = 'ad-loaded';
+
+
+/**
+ * The event name for when all the ads were completed.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.ALL_ADS_COMPLETED = 'all-ads-completed';
+
+
+/**
+ * The event name for when the ad changes from or to linear.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_LINEAR_CHANGED = 'ad-linear-changed';
+
+
+/**
+ * The event name for when the ad's metadata becomes available.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_METADATA = 'ad-metadata';
+
+
+/**
+ * The event name for when the ad display encountered a recoverable
+ * error.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_RECOVERABLE_ERROR = 'ad-recoverable-error';
+
+/**
+ * The event name for when the ad manager dispatch errors.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.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.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_BREAK_READY = 'ad-break-ready';
+
+
+/**
+ * The event name for when the interaction callback for the ad was
+ * triggered.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.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.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.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.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.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.
+ *
+ * @const {string}
+ * @export
+ */
+shaka.ads.Utils.AD_CONTENT_ATTACH_REQUESTED = 'ad-content-attach-requested';
+

package/lib/ads/ads_stats.js

@@ -24,6 +24,8 @@ shaka.ads.AdsStats = class {
     this.playedCompletely_ = 0;
     /** @private {number} */
     this.skipped_ = 0;
+    /** @private {number} */
+    this.errors_ = 0;
   }
 
   /**
@@ -56,6 +58,26 @@ shaka.ads.AdsStats = class {
     this.skipped_++;
   }
 
+  /**
+   * Increase the number of ads with error by one.
+   */
+  incrementErrors() {
+    this.errors_++;
+  }
+
+  /**
+   * @return {number}
+   * @private
+   */
+  getAverageLoadTime_() {
+    if (!this.loadTimes_.length) {
+      return 0;
+    }
+    const sum = this.loadTimes_.reduce(
+        (accumulator, currentValue) => accumulator + currentValue, 0);
+    return sum / this.loadTimes_.length;
+  }
+
   /**
    * Create a stats blob that we can pass up to the app. This blob will not
    * reference any internal data.
@@ -65,9 +87,11 @@ shaka.ads.AdsStats = class {
   getBlob() {
     return {
       loadTimes: this.loadTimes_,
+      averageLoadTime: this.getAverageLoadTime_(),
       started: this.started_,
       playedCompletely: this.playedCompletely_,
       skipped: this.skipped_,
+      errors: this.errors_,
     };
   }
 };

package/lib/ads/client_side_ad_manager.js

@@ -4,15 +4,13 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-/**
- * @fileoverview
- * @suppress {missingRequire} TODO(b/152540451): this shouldn't be needed
- */
 
 goog.provide('shaka.ads.ClientSideAdManager');
 
 goog.require('goog.asserts');
+goog.require('shaka.Player');
 goog.require('shaka.ads.ClientSideAd');
+goog.require('shaka.ads.Utils');
 goog.require('shaka.log');
 goog.require('shaka.util.Dom');
 goog.require('shaka.util.EventManager');
@@ -190,12 +188,12 @@ shaka.ads.ClientSideAdManager = class {
     shaka.log.warning('Resuming playback.');
 
     const data = (new Map()).set('originalEvent', e);
-    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_ERROR, data));
+    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.Utils.AD_ERROR, data));
 
     this.onAdComplete_(/* adEvent= */ null);
     // Remove ad breaks from the timeline
     this.onEvent_(
-        new shaka.util.FakeEvent(shaka.ads.AdManager.CUEPOINTS_CHANGED,
+        new shaka.util.FakeEvent(shaka.ads.Utils.CUEPOINTS_CHANGED,
             (new Map()).set('cuepoints', [])));
   }
 
@@ -209,7 +207,7 @@ shaka.ads.ClientSideAdManager = class {
 
     const now = Date.now() / 1000;
     const loadTime = now - this.requestAdsStartTime_;
-    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.ADS_LOADED,
+    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.Utils.ADS_LOADED,
         (new Map()).set('loadTime', loadTime)));
 
     if (!this.config_.customPlayheadTracker) {
@@ -247,7 +245,7 @@ shaka.ads.ClientSideAdManager = class {
     }
 
     this.onEvent_(new shaka.util.FakeEvent(
-        shaka.ads.AdManager.IMA_AD_MANAGER_LOADED,
+        shaka.ads.Utils.IMA_AD_MANAGER_LOADED,
         (new Map()).set('imaAdManager', this.imaAdsManager_)));
 
     const cuePointStarts = this.imaAdsManager_.getCuePoints();
@@ -264,7 +262,7 @@ shaka.ads.ClientSideAdManager = class {
       }
 
       this.onEvent_(new shaka.util.FakeEvent(
-          shaka.ads.AdManager.CUEPOINTS_CHANGED,
+          shaka.ads.Utils.CUEPOINTS_CHANGED,
           (new Map()).set('cuepoints', cuePoints)));
     }
 
@@ -374,22 +372,22 @@ shaka.ads.ClientSideAdManager = class {
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.FIRST_QUARTILE, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_FIRST_QUARTILE);
+          convertEventAndSend(e, shaka.ads.Utils.AD_FIRST_QUARTILE);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.MIDPOINT, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_MIDPOINT);
+          convertEventAndSend(e, shaka.ads.Utils.AD_MIDPOINT);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.THIRD_QUARTILE, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_THIRD_QUARTILE);
+          convertEventAndSend(e, shaka.ads.Utils.AD_THIRD_QUARTILE);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.COMPLETE, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_COMPLETE);
+          convertEventAndSend(e, shaka.ads.Utils.AD_COMPLETE);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
@@ -404,24 +402,24 @@ shaka.ads.ClientSideAdManager = class {
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.SKIPPED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_SKIPPED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_SKIPPED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.VOLUME_CHANGED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_VOLUME_CHANGED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_VOLUME_CHANGED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.VOLUME_MUTED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_MUTED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_MUTED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.PAUSED, (e) => {
           if (this.ad_) {
             this.ad_.setPaused(true);
-            convertEventAndSend(e, shaka.ads.AdManager.AD_PAUSED);
+            convertEventAndSend(e, shaka.ads.Utils.AD_PAUSED);
           }
         });
 
@@ -429,80 +427,80 @@ shaka.ads.ClientSideAdManager = class {
         google.ima.AdEvent.Type.RESUMED, (e) => {
           if (this.ad_) {
             this.ad_.setPaused(false);
-            convertEventAndSend(e, shaka.ads.AdManager.AD_RESUMED);
+            convertEventAndSend(e, shaka.ads.Utils.AD_RESUMED);
           }
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.SKIPPABLE_STATE_CHANGED, (e) => {
           if (this.ad_) {
-            convertEventAndSend(e, shaka.ads.AdManager.AD_SKIP_STATE_CHANGED);
+            convertEventAndSend(e, shaka.ads.Utils.AD_SKIP_STATE_CHANGED);
           }
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.CLICK, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_CLICKED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_CLICKED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.AD_PROGRESS, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_PROGRESS);
+          convertEventAndSend(e, shaka.ads.Utils.AD_PROGRESS);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.AD_BUFFERING, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_BUFFERING);
+          convertEventAndSend(e, shaka.ads.Utils.AD_BUFFERING);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.IMPRESSION, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_IMPRESSION);
+          convertEventAndSend(e, shaka.ads.Utils.AD_IMPRESSION);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.DURATION_CHANGE, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_DURATION_CHANGED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_DURATION_CHANGED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.USER_CLOSE, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_CLOSED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_CLOSED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.LOADED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_LOADED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_LOADED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.ALL_ADS_COMPLETED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.ALL_ADS_COMPLETED);
+          convertEventAndSend(e, shaka.ads.Utils.ALL_ADS_COMPLETED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.LINEAR_CHANGED, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_LINEAR_CHANGED);
+          convertEventAndSend(e, shaka.ads.Utils.AD_LINEAR_CHANGED);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.AD_METADATA, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_METADATA);
+          convertEventAndSend(e, shaka.ads.Utils.AD_METADATA);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.LOG, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_RECOVERABLE_ERROR);
+          convertEventAndSend(e, shaka.ads.Utils.AD_RECOVERABLE_ERROR);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.AD_BREAK_READY, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_BREAK_READY);
+          convertEventAndSend(e, shaka.ads.Utils.AD_BREAK_READY);
         });
 
     this.eventManager_.listen(this.imaAdsManager_,
         google.ima.AdEvent.Type.INTERACTION, (e) => {
-          convertEventAndSend(e, shaka.ads.AdManager.AD_INTERACTION);
+          convertEventAndSend(e, shaka.ads.Utils.AD_INTERACTION);
         });
   }
 
@@ -527,12 +525,17 @@ shaka.ads.ClientSideAdManager = class {
 
     this.ad_ = new shaka.ads.ClientSideAd(imaAd,
         this.imaAdsManager_, this.video_);
+    if (e.type == google.ima.AdEvent.Type.CONTENT_PAUSE_REQUESTED &&
+        !this.config_.supportsMultipleMediaElements ) {
+      this.onEvent_(new shaka.util.FakeEvent(
+          shaka.ads.Utils.AD_CONTENT_PAUSE_REQUESTED));
+    }
     const data = new Map()
         .set('ad', this.ad_)
         .set('sdkAdObject', imaAd)
         .set('originalEvent', e);
     this.onEvent_(new shaka.util.FakeEvent(
-        shaka.ads.AdManager.AD_STARTED, data));
+        shaka.ads.Utils.AD_STARTED, data));
     if (this.ad_.isLinear()) {
       this.adContainer_.setAttribute('ad-active', 'true');
       if (!this.config_.customPlayheadTracker) {
@@ -551,7 +554,12 @@ shaka.ads.ClientSideAdManager = class {
    * @private
    */
   onAdComplete_(e) {
-    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED,
+    if (e && e.type == google.ima.AdEvent.Type.CONTENT_RESUME_REQUESTED &&
+        !this.config_.supportsMultipleMediaElements) {
+      this.onEvent_(new shaka.util.FakeEvent(
+          shaka.ads.Utils.AD_CONTENT_RESUME_REQUESTED));
+    }
+    this.onEvent_(new shaka.util.FakeEvent(shaka.ads.Utils.AD_STOPPED,
         (new Map()).set('originalEvent', e)));
     if (this.ad_ && this.ad_.isLinear()) {
       this.adContainer_.removeAttribute('ad-active');