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.    * @param {HTMLMediaElement} video
  22.    */
  23.   constructor(imaAd, imaAdManager, video) {
  24.     /** @private {google.ima.Ad} */
  25.     this.ad_ = imaAd;
  27.     /** @private {google.ima.AdsManager} */
  28.     this.manager_ = imaAdManager;
  30.     /** @private {HTMLMediaElement} */
  31.     this.video_ = video;
  33.     /** @private {boolean} */
  34.     this.isPaused_ = false;
  36.     /** @private {number} */
  37.     this.volume_ = this.manager_.getVolume();
  39.     /** @private {shaka.util.EventManager} */
  40.     this.eventManager_ = new shaka.util.EventManager();
  42.     this.eventManager_.listen(this.manager_,
  43.         google.ima.AdEvent.Type.PAUSED, () => {
  44.           this.isPaused_ = true;
  45.         });
  47.     this.eventManager_.listen(this.manager_,
  48.         google.ima.AdEvent.Type.RESUMED, () => {
  49.           this.isPaused_ = false;
  50.         });
  51.   }
  53.   /**
  54.    * @override
  55.    * @export
  56.    */
  57.   getDuration() {
  58.     return this.ad_.getDuration();
  59.   }
  61.   /**
  62.    * @override
  63.    * @export
  64.    */
  65.   getMinSuggestedDuration() {
  66.     return this.ad_.getMinSuggestedDuration();
  67.   }
  69.   /**
  70.    * @override
  71.    * @export
  72.    */
  73.   getRemainingTime() {
  74.     return this.manager_.getRemainingTime();
  75.   }
  77.   /**
  78.    * @override
  79.    * @export
  80.    */
  81.   isPaused() {
  82.     return this.isPaused_;
  83.   }
  85.   /**
  86.    * @override
  87.    * @export
  88.    */
  89.   isSkippable() {
  90.     // IMA returns -1 for non-skippable ads. Any positive number is a genuine
  91.     // skip offset, meaning the ad is skippable.
  92.     return this.ad_.getSkipTimeOffset() >= 0;
  93.   }
  95.   /**
  96.    * @override
  97.    * @export
  98.    */
  99.   getTimeUntilSkippable() {
  100.     const skipOffset = this.ad_.getSkipTimeOffset();
  101.     const canSkipIn = this.getRemainingTime() - skipOffset;
  102.     return Math.max(canSkipIn, 0);
  103.   }
  105.   /**
  106.    * @override
  107.    * @export
  108.    */
  109.   canSkipNow() {
  110.     return this.manager_.getAdSkippableState();
  111.   }
  113.   /**
  114.    * @override
  115.    * @export
  116.    */
  117.   skip() {
  118.     return this.manager_.skip();
  119.   }
  121.   /**
  122.    * @param {boolean} paused
  123.    */
  124.   setPaused(paused) {
  125.     this.isPaused_ = paused;
  126.   }
  128.   /**
  129.    * @override
  130.    * @export
  131.    */
  132.   pause() {
  133.     return this.manager_.pause();
  134.   }
  136.   /**
  137.    * @override
  138.    * @export
  139.    */
  140.   play() {
  141.     return this.manager_.resume();
  142.   }
  145.   /**
  146.    * @override
  147.    * @export
  148.    */
  149.   getVolume() {
  150.     return this.manager_.getVolume();
  151.   }
  153.   /**
  154.    * @override
  155.    * @export
  156.    */
  157.   setVolume(volume) {
  158.     return this.manager_.setVolume(volume);
  159.   }
  161.   /**
  162.    * @override
  163.    * @export
  164.    */
  165.   isMuted() {
  166.     return this.manager_.getVolume() == 0;
  167.   }
  169.   /**
  170.    * @override
  171.    * @export
  172.    */
  173.   isLinear() {
  174.     return this.ad_.isLinear();
  175.   }
  178.   /**
  179.    * @override
  180.    * @export
  181.    */
  182.   resize(width, height) {
  183.     let isInFullscreen = false;
  184.     const video = /** @type {HTMLVideoElement} */(this.video_);
  185.     if (document.fullscreenEnabled) {
  186.       isInFullscreen = !!document.fullscreenElement;
  187.     } else if (video.webkitSupportsFullscreen) {
  188.       isInFullscreen = video.webkitDisplayingFullscreen;
  189.     }
  190.     const viewMode = isInFullscreen ?
  191.         google.ima.ViewMode.FULLSCREEN : google.ima.ViewMode.NORMAL;
  192.     this.manager_.resize(width, height, viewMode);
  193.   }
  195.   /**
  196.    * @override
  197.    * @export
  198.    */
  199.   setMuted(muted) {
  200.     // Emulate the "mute" functionality, where current, pre-mute
  201.     // volume is saved and can be restored on unmute.
  202.     if (muted) {
  203.       this.volume_ = this.getVolume();
  204.       this.setVolume(0);
  205.     } else {
  206.       this.setVolume(this.volume_);
  207.     }
  208.   }
  211.   /**
  212.    * @override
  213.    * @export
  214.    */
  215.   getSequenceLength() {
  216.     const podInfo = this.ad_.getAdPodInfo();
  217.     if (podInfo == null) {
  218.       // No pod, just one ad.
  219.       return 1;
  220.     }
  222.     return podInfo.getTotalAds();
  223.   }
  225.   /**
  226.    * @override
  227.    * @export
  228.    */
  229.   getPositionInSequence() {
  230.     const podInfo = this.ad_.getAdPodInfo();
  231.     if (podInfo == null) {
  232.       // No pod, just one ad.
  233.       return 1;
  234.     }
  236.     return podInfo.getAdPosition();
  237.   }
  240.   /**
  241.    * @override
  242.    * @export
  243.    */
  244.   release() {
  245.     this.ad_ = null;
  246.     this.manager_ = null;
  247.   }
  248. };