Source: lib/ads/client_side_ad.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ads.ClientSideAd');
  10. goog.require('shaka.util.EventManager');
  13. /**
  14.  * @implements {shaka.extern.IAd}
  15.  * @export
  16.  */
  17. shaka.ads.ClientSideAd = class {
  18.   /**
  19.    * @param {!google.ima.Ad} imaAd
  20.    * @param {!google.ima.AdsManager} imaAdManager
  21.    */
  22.   constructor(imaAd, imaAdManager) {
  23.     /** @private {google.ima.Ad} */
  24.     this.ad_ = imaAd;
  26.     /** @private {google.ima.AdsManager} */
  27.     this.manager_ = imaAdManager;
  29.     /** @private {boolean} */
  30.     this.isPaused_ = false;
  32.     /** @private {number} */
  33.     this.volume_ = this.manager_.getVolume();
  35.     /** @private {shaka.util.EventManager} */
  36.     this.eventManager_ = new shaka.util.EventManager();
  38.     this.eventManager_.listen(this.manager_,
  39.         google.ima.AdEvent.Type.PAUSED, () => {
  40.           this.isPaused_ = true;
  41.         });
  43.     this.eventManager_.listen(this.manager_,
  44.         google.ima.AdEvent.Type.RESUMED, () => {
  45.           this.isPaused_ = false;
  46.         });
  47.   }
  49.   /**
  50.    * @override
  51.    * @export
  52.    */
  53.   getDuration() {
  54.     return this.ad_.getDuration();
  55.   }
  57.   /**
  58.    * @override
  59.    * @export
  60.    */
  61.   getMinSuggestedDuration() {
  62.     return this.ad_.getMinSuggestedDuration();
  63.   }
  65.   /**
  66.    * @override
  67.    * @export
  68.    */
  69.   getRemainingTime() {
  70.     return this.manager_.getRemainingTime();
  71.   }
  73.   /**
  74.    * @override
  75.    * @export
  76.    */
  77.   isPaused() {
  78.     return this.isPaused_;
  79.   }
  81.   /**
  82.    * @override
  83.    * @export
  84.    */
  85.   isSkippable() {
  86.     // IMA returns -1 for non-skippable ads. Any positive number is a genuine
  87.     // skip offset, meaning the ad is skippable.
  88.     return this.ad_.getSkipTimeOffset() >= 0;
  89.   }
  91.   /**
  92.    * @override
  93.    * @export
  94.    */
  95.   getTimeUntilSkippable() {
  96.     const skipOffset = this.ad_.getSkipTimeOffset();
  97.     const canSkipIn = this.getRemainingTime() - skipOffset;
  98.     return Math.max(canSkipIn, 0);
  99.   }
  101.   /**
  102.    * @override
  103.    * @export
  104.    */
  105.   canSkipNow() {
  106.     return this.manager_.getAdSkippableState();
  107.   }
  109.   /**
  110.    * @override
  111.    * @export
  112.    */
  113.   skip() {
  114.     return this.manager_.skip();
  115.   }
  117.   /**
  118.    * @param {boolean} paused
  119.    */
  120.   setPaused(paused) {
  121.     this.isPaused_ = paused;
  122.   }
  124.   /**
  125.    * @override
  126.    * @export
  127.    */
  128.   pause() {
  129.     return this.manager_.pause();
  130.   }
  132.   /**
  133.    * @override
  134.    * @export
  135.    */
  136.   play() {
  137.     return this.manager_.resume();
  138.   }
  141.   /**
  142.    * @override
  143.    * @export
  144.    */
  145.   getVolume() {
  146.     return this.manager_.getVolume();
  147.   }
  149.   /**
  150.    * @override
  151.    * @export
  152.    */
  153.   setVolume(volume) {
  154.     return this.manager_.setVolume(volume);
  155.   }
  157.   /**
  158.    * @override
  159.    * @export
  160.    */
  161.   isMuted() {
  162.     return this.manager_.getVolume() == 0;
  163.   }
  166.   /**
  167.    * @override
  168.    * @export
  169.    */
  170.   resize(width, height) {
  171.     const viewMode = document.fullscreenElement ?
  172.         google.ima.ViewMode.FULLSCREEN : google.ima.ViewMode.NORMAL;
  173.     this.manager_.resize(width, height, viewMode);
  174.   }
  176.   /**
  177.    * @override
  178.    * @export
  179.    */
  180.   setMuted(muted) {
  181.     // Emulate the "mute" functionality, where current, pre-mute
  182.     // volume is saved and can be restored on unmute.
  183.     if (muted) {
  184.       this.volume_ = this.getVolume();
  185.       this.setVolume(0);
  186.     } else {
  187.       this.setVolume(this.volume_);
  188.     }
  189.   }
  192.   /**
  193.    * @override
  194.    * @export
  195.    */
  196.   getSequenceLength() {
  197.     const podInfo = this.ad_.getAdPodInfo();
  198.     if (podInfo == null) {
  199.       // No pod, just one ad.
  200.       return 1;
  201.     }
  203.     return podInfo.getTotalAds();
  204.   }
  206.   /**
  207.    * @override
  208.    * @export
  209.    */
  210.   getPositionInSequence() {
  211.     const podInfo = this.ad_.getAdPodInfo();
  212.     if (podInfo == null) {
  213.       // No pod, just one ad.
  214.       return 1;
  215.     }
  217.     return podInfo.getAdPosition();
  218.   }
  221.   /**
  222.    * @override
  223.    * @export
  224.    */
  225.   release() {
  226.     this.ad_ = null;
  227.     this.manager_ = null;
  228.   }
  229. };