shaka-player 4.4.3 → 4.5.0

package/lib/ads/ad_manager.js

@@ -8,9 +8,11 @@
 goog.provide('shaka.ads.AdManager');
 
 goog.require('goog.asserts');
+goog.require('shaka.Deprecate');
 goog.require('shaka.Player');
 goog.require('shaka.ads.AdsStats');
 goog.require('shaka.ads.ClientSideAdManager');
+goog.require('shaka.ads.MediaTailorAdManager');
 goog.require('shaka.ads.ServerSideAdManager');
 goog.require('shaka.log');
 goog.require('shaka.util.Error');
@@ -380,6 +382,8 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     super();
     /** @private {shaka.ads.ClientSideAdManager} */
     this.csAdManager_ = null;
+    /** @private {shaka.ads.MediaTailorAdManager} */
+    this.mtAdManager_ = null;
     /** @private {shaka.ads.ServerSideAdManager} */
     this.ssAdManager_ = null;
     /** @private {shaka.ads.AdsStats} */
@@ -439,28 +443,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 
     this.csAdManager_ = new shaka.ads.ClientSideAdManager(
         adContainer, video, this.locale_, adsRenderingSettings,
-        (e) => {
-          const event = /** @type {!shaka.util.FakeEvent} */ (e);
-          if (event && event.type) {
-            switch (event.type) {
-              case shaka.ads.AdManager.ADS_LOADED: {
-                const loadTime = (/** @type {!Object} */ (e))['loadTime'];
-                this.stats_.addLoadTime(loadTime);
-                break;
-              }
-              case shaka.ads.AdManager.AD_STARTED:
-                this.stats_.incrementStarted();
-                break;
-              case shaka.ads.AdManager.AD_COMPLETE:
-                this.stats_.incrementPlayedCompletely();
-                break;
-              case shaka.ads.AdManager.AD_SKIPPED:
-                this.stats_.incrementSkipped();
-                break;
-            }
-          }
-          this.dispatchEvent(event);
-        });
+        (e) => this.processAndDispatchEvent_(e));
 
     goog.asserts.assert(this.config_, 'Config must not be null!');
     this.csAdManager_.configure(this.config_);
@@ -476,6 +459,10 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
       this.csAdManager_.release();
       this.csAdManager_ = null;
     }
+    if (this.mtAdManager_) {
+      this.mtAdManager_.release();
+      this.mtAdManager_ = null;
+    }
     if (this.ssAdManager_) {
       this.ssAdManager_.release();
       this.ssAdManager_ = null;
@@ -492,6 +479,9 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     if (this.csAdManager_) {
       this.csAdManager_.stop();
     }
+    if (this.mtAdManager_) {
+      this.mtAdManager_.stop();
+    }
     if (this.ssAdManager_) {
       this.ssAdManager_.stop();
     }
@@ -535,6 +525,41 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
   }
 
 
+  /**
+   * @override
+   * @export
+   */
+  initMediaTailor(adContainer, networkingEngine, video) {
+    if (this.mtAdManager_) {
+      this.mtAdManager_.release();
+    }
+
+    this.mtAdManager_ = new shaka.ads.MediaTailorAdManager(
+        adContainer, networkingEngine, video,
+        (e) => this.processAndDispatchEvent_(e));
+  }
+
+
+  /**
+   * @param {string} url
+   * @param {Object} adsParams
+   * @param {string=} backupUrl
+   * @return {!Promise.<string>}
+   * @override
+   * @export
+   */
+  requestMediaTailorStream(url, adsParams, backupUrl = '') {
+    if (!this.mtAdManager_) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.RECOVERABLE,
+          shaka.util.Error.Category.ADS,
+          shaka.util.Error.Code.MT_AD_MANAGER_NOT_INITIALIZED);
+    }
+
+    return this.mtAdManager_.streamRequest(url, adsParams, backupUrl);
+  }
+
+
   /**
    * @override
    * @export
@@ -559,28 +584,7 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
 
     this.ssAdManager_ = new shaka.ads.ServerSideAdManager(
         adContainer, video, this.locale_,
-        (e) => {
-          const event = /** @type {!shaka.util.FakeEvent} */ (e);
-          if (event && event.type) {
-            switch (event.type) {
-              case shaka.ads.AdManager.ADS_LOADED: {
-                const loadTime = (/** @type {!Object} */ (e))['loadTime'];
-                this.stats_.addLoadTime(loadTime);
-                break;
-              }
-              case shaka.ads.AdManager.AD_STARTED:
-                this.stats_.incrementStarted();
-                break;
-              case shaka.ads.AdManager.AD_COMPLETE:
-                this.stats_.incrementPlayedCompletely();
-                break;
-              case shaka.ads.AdManager.AD_SKIPPED:
-                this.stats_.incrementSkipped();
-                break;
-            }
-          }
-          this.dispatchEvent(event);
-        });
+        (e) => this.processAndDispatchEvent_(e));
 
     goog.asserts.assert(this.config_, 'Config must not be null!');
     this.ssAdManager_.configure(this.config_);
@@ -651,13 +655,27 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
    * @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);
+    shaka.Deprecate.deprecateFeature(5,
+        'AdManager',
+        'Please use getCuePoints function.');
+    return this.getCuePoints();
+  }
+
+
+  /**
+   * @return {!Array.<!shaka.extern.AdCuePoint>}
+   * @override
+   * @export
+   */
+  getCuePoints() {
+    let cuepoints = [];
+    if (this.ssAdManager_) {
+      cuepoints = cuepoints.concat(this.ssAdManager_.getCuePoints());
     }
-    return this.ssAdManager_.getCuePoints();
+    if (this.mtAdManager_) {
+      cuepoints = cuepoints.concat(this.mtAdManager_.getCuePoints());
+    }
+    return cuepoints;
   }
 
 
@@ -670,6 +688,16 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
     return this.stats_.getBlob();
   }
 
+  /**
+   * @override
+   * @export
+   */
+  onManifestUpdated(isLive) {
+    if (this.mtAdManager_) {
+      this.mtAdManager_.onManifestUpdated(isLive);
+    }
+  }
+
   /**
    * @override
    * @export
@@ -703,6 +731,32 @@ shaka.ads.AdManager = class extends shaka.util.FakeEventTarget {
       this.ssAdManager_.onCueMetadataChange(value);
     }
   }
+
+  /**
+   * @param {!shaka.util.FakeEvent} event
+   * @private
+   */
+  processAndDispatchEvent_(event) {
+    if (event && event.type) {
+      switch (event.type) {
+        case shaka.ads.AdManager.ADS_LOADED: {
+          const loadTime = (/** @type {!Object} */ (event))['loadTime'];
+          this.stats_.addLoadTime(loadTime);
+          break;
+        }
+        case shaka.ads.AdManager.AD_STARTED:
+          this.stats_.incrementStarted();
+          break;
+        case shaka.ads.AdManager.AD_COMPLETE:
+          this.stats_.incrementPlayedCompletely();
+          break;
+        case shaka.ads.AdManager.AD_SKIPPED:
+          this.stats_.incrementSkipped();
+          break;
+      }
+    }
+    this.dispatchEvent(event);
+  }
 };
 
 /**

package/lib/ads/media_tailor_ad.js

@@ -0,0 +1,297 @@
+/*! @license
+ * Shaka Player
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+
+goog.provide('shaka.ads.MediaTailorAd');
+
+/**
+ * @implements {shaka.extern.IAd}
+ * @export
+ */
+shaka.ads.MediaTailorAd = class {
+  /**
+   * @param {mediaTailor.Ad} mediaTailorAd
+   * @param {number} adPosition
+   * @param {number} totalAds
+   * @param {HTMLMediaElement} video
+   */
+  constructor(mediaTailorAd, adPosition, totalAds, isLinear, video) {
+    /** @private {?mediaTailor.Ad} */
+    this.ad_ = mediaTailorAd;
+
+    /** @private {HTMLMediaElement} */
+    this.video_ = video;
+
+    /** @private {?number} */
+    this.adPosition_ = adPosition;
+
+    /** @private {?number} */
+    this.totalAds_ = totalAds;
+
+    /** @private {boolean} */
+    this.isLinear_ = isLinear;
+  }
+
+
+  /**
+   * @override
+   * @export
+   */
+  getDuration() {
+    return this.ad_.durationInSeconds;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getMinSuggestedDuration() {
+    return this.getDuration();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getRemainingTime() {
+    const endTime = this.ad_.startTimeInSeconds + this.ad_.durationInSeconds;
+    return endTime - this.video_.currentTime;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  isPaused() {
+    return this.video_.paused;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  isSkippable() {
+    if (this.ad_.skipOffset) {
+      return true;
+    }
+    return false;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getTimeUntilSkippable() {
+    if (!this.ad_.skipOffset) {
+      return this.getRemainingTime();
+    }
+    const canSkipIn = this.getRemainingTime() - this.ad_.skipOffset;
+    return Math.max(canSkipIn, 0);
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  canSkipNow() {
+    return this.getTimeUntilSkippable() == 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  skip() {
+    this.video_.currentTime += this.getRemainingTime();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  pause() {
+    return this.video_.pause();
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  play() {
+    return this.video_.play();
+  }
+
+
+  /**
+   * @override
+   * @export
+   */
+  getVolume() {
+    return this.video_.volume;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  setVolume(volume) {
+    this.video_.volume = volume;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  isMuted() {
+    return this.video_.muted;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  isLinear() {
+    return this.isLinear_;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  resize(width, height) {
+    // Nothing
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  setMuted(muted) {
+    this.video_.muted = muted;
+  }
+
+
+  /**
+   * @override
+   * @export
+   */
+  getSequenceLength() {
+    if (!this.totalAds_) {
+      return 1;
+    }
+    return this.totalAds_;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getPositionInSequence() {
+    if (!this.adPosition_) {
+      return 1;
+    }
+    return this.adPosition_;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getTitle() {
+    return this.ad_.adTitle;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getDescription() {
+    return '';
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaBitrate() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaHeight() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getVastMediaWidth() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdId() {
+    return this.ad_.adId;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getCreativeAdId() {
+    return this.ad_.creativeId;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getAdvertiserName() {
+    return '';
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getMediaUrl() {
+    return null;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getTimeOffset() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  getPodIndex() {
+    return 0;
+  }
+
+  /**
+   * @override
+   * @export
+   */
+  release() {
+    this.ad_ = null;
+    this.video_ = null;
+    this.adPosition_ = null;
+    this.totalAds_ = null;
+  }
+};