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.   needsSkipUI() {
  58.     return false;
  59.   }
  61.   /**
  62.    * @override
  63.    * @export
  64.    */
  65.   getDuration() {
  66.     return this.ad_.getDuration();
  67.   }
  69.   /**
  70.    * @override
  71.    * @export
  72.    */
  73.   getMinSuggestedDuration() {
  74.     return this.ad_.getMinSuggestedDuration();
  75.   }
  77.   /**
  78.    * @override
  79.    * @export
  80.    */
  81.   getRemainingTime() {
  82.     return this.manager_.getRemainingTime();
  83.   }
  85.   /**
  86.    * @override
  87.    * @export
  88.    */
  89.   isPaused() {
  90.     return this.isPaused_;
  91.   }
  93.   /**
  94.    * @override
  95.    * @export
  96.    */
  97.   isSkippable() {
  98.     // IMA returns -1 for non-skippable ads. Any positive number is a genuine
  99.     // skip offset, meaning the ad is skippable.
  100.     return this.ad_.getSkipTimeOffset() >= 0;
  101.   }
  103.   /**
  104.    * @override
  105.    * @export
  106.    */
  107.   getTimeUntilSkippable() {
  108.     const skipOffset = this.ad_.getSkipTimeOffset();
  109.     const canSkipIn = this.getRemainingTime() - skipOffset;
  110.     return Math.max(canSkipIn, 0);
  111.   }
  113.   /**
  114.    * @override
  115.    * @export
  116.    */
  117.   canSkipNow() {
  118.     return this.manager_.getAdSkippableState();
  119.   }
  121.   /**
  122.    * @override
  123.    * @export
  124.    */
  125.   skip() {
  126.     return this.manager_.skip();
  127.   }
  129.   /**
  130.    * @param {boolean} paused
  131.    */
  132.   setPaused(paused) {
  133.     this.isPaused_ = paused;
  134.   }
  136.   /**
  137.    * @override
  138.    * @export
  139.    */
  140.   pause() {
  141.     return this.manager_.pause();
  142.   }
  144.   /**
  145.    * @override
  146.    * @export
  147.    */
  148.   play() {
  149.     return this.manager_.resume();
  150.   }
  153.   /**
  154.    * @override
  155.    * @export
  156.    */
  157.   getVolume() {
  158.     return this.manager_.getVolume();
  159.   }
  161.   /**
  162.    * @override
  163.    * @export
  164.    */
  165.   setVolume(volume) {
  166.     this.video_.volume = volume;
  167.     return this.manager_.setVolume(volume);
  168.   }
  170.   /**
  171.    * @override
  172.    * @export
  173.    */
  174.   isMuted() {
  175.     return this.manager_.getVolume() == 0;
  176.   }
  178.   /**
  179.    * @override
  180.    * @export
  181.    */
  182.   isLinear() {
  183.     return this.ad_.isLinear();
  184.   }
  187.   /**
  188.    * @override
  189.    * @export
  190.    */
  191.   resize(width, height) {
  192.     let isInFullscreen = false;
  193.     const video = /** @type {HTMLVideoElement} */(this.video_);
  194.     if (document.fullscreenEnabled) {
  195.       isInFullscreen = !!document.fullscreenElement;
  196.     } else if (video.webkitSupportsFullscreen) {
  197.       isInFullscreen = video.webkitDisplayingFullscreen;
  198.     }
  199.     const viewMode = isInFullscreen ?
  200.         google.ima.ViewMode.FULLSCREEN : google.ima.ViewMode.NORMAL;
  201.     this.manager_.resize(width, height, viewMode);
  202.   }
  204.   /**
  205.    * @override
  206.    * @export
  207.    */
  208.   setMuted(muted) {
  209.     this.video_.muted = muted;
  210.     // Emulate the "mute" functionality, where current, pre-mute
  211.     // volume is saved and can be restored on unmute.
  212.     if (muted) {
  213.       this.volume_ = this.getVolume();
  214.       this.manager_.setVolume(0);
  215.     } else {
  216.       this.manager_.setVolume(this.volume_);
  217.     }
  218.   }
  220.   /**
  221.    * It's required for a muted ad to start when autoplaying.
  222.    *
  223.    * @param {number} videoVolume
  224.    */
  225.   setInitialMuted(videoVolume) {
  226.     this.volume_ = videoVolume;
  227.     this.manager_.setVolume(0);
  228.   }
  230.   /**
  231.    * @override
  232.    * @export
  233.    */
  234.   getSequenceLength() {
  235.     const podInfo = this.ad_.getAdPodInfo();
  236.     if (podInfo == null) {
  237.       // No pod, just one ad.
  238.       return 1;
  239.     }
  241.     return podInfo.getTotalAds();
  242.   }
  244.   /**
  245.    * @override
  246.    * @export
  247.    */
  248.   getPositionInSequence() {
  249.     const podInfo = this.ad_.getAdPodInfo();
  250.     if (podInfo == null) {
  251.       // No pod, just one ad.
  252.       return 1;
  253.     }
  255.     return podInfo.getAdPosition();
  256.   }
  258.   /**
  259.    * @override
  260.    * @export
  261.    */
  262.   getTitle() {
  263.     return this.ad_.getTitle();
  264.   }
  266.   /**
  267.    * @override
  268.    * @export
  269.    */
  270.   getDescription() {
  271.     return this.ad_.getDescription();
  272.   }
  274.   /**
  275.    * @override
  276.    * @export
  277.    */
  278.   getVastMediaBitrate() {
  279.     return this.ad_.getVastMediaBitrate();
  280.   }
  282.   /**
  283.    * @override
  284.    * @export
  285.    */
  286.   getVastMediaHeight() {
  287.     return this.ad_.getVastMediaHeight();
  288.   }
  290.   /**
  291.    * @override
  292.    * @export
  293.    */
  294.   getVastMediaWidth() {
  295.     return this.ad_.getVastMediaWidth();
  296.   }
  298.   /**
  299.    * @override
  300.    * @export
  301.    */
  302.   getAdId() {
  303.     return this.ad_.getAdId();
  304.   }
  306.   /**
  307.    * @override
  308.    * @export
  309.    */
  310.   getCreativeAdId() {
  311.     return this.ad_.getCreativeAdId();
  312.   }
  314.   /**
  315.    * @override
  316.    * @export
  317.    */
  318.   getAdvertiserName() {
  319.     return this.ad_.getAdvertiserName();
  320.   }
  322.   /**
  323.    * @override
  324.    * @export
  325.    */
  326.   getMediaUrl() {
  327.     return this.ad_.getMediaUrl();
  328.   }
  330.   /**
  331.    * @override
  332.    * @export
  333.    */
  334.   getTimeOffset() {
  335.     const podInfo = this.ad_.getAdPodInfo();
  336.     if (podInfo == null) {
  337.       // Defaults to 0 if this ad is not part of a pod, or the pod is not part
  338.       // of an ad playlist.
  339.       return 0;
  340.     }
  342.     return podInfo.getTimeOffset();
  343.   }
  345.   /**
  346.    * @override
  347.    * @export
  348.    */
  349.   getPodIndex() {
  350.     const podInfo = this.ad_.getAdPodInfo();
  351.     if (podInfo == null) {
  352.       // Defaults to 0 if this ad is not part of a pod, or the pod is not part
  353.       // of an ad playlist.
  354.       return 0;
  355.     }
  357.     return podInfo.getPodIndex();
  358.   }
  360.   /**
  361.    * @override
  362.    * @export
  363.    */
  364.   release() {
  365.     this.ad_ = null;
  366.     this.manager_ = null;
  367.   }
  368. };