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.     this.video_.volume = volume;
  159.     return this.manager_.setVolume(volume);
  160.   }
  162.   /**
  163.    * @override
  164.    * @export
  165.    */
  166.   isMuted() {
  167.     return this.manager_.getVolume() == 0;
  168.   }
  170.   /**
  171.    * @override
  172.    * @export
  173.    */
  174.   isLinear() {
  175.     return this.ad_.isLinear();
  176.   }
  179.   /**
  180.    * @override
  181.    * @export
  182.    */
  183.   resize(width, height) {
  184.     let isInFullscreen = false;
  185.     const video = /** @type {HTMLVideoElement} */(this.video_);
  186.     if (document.fullscreenEnabled) {
  187.       isInFullscreen = !!document.fullscreenElement;
  188.     } else if (video.webkitSupportsFullscreen) {
  189.       isInFullscreen = video.webkitDisplayingFullscreen;
  190.     }
  191.     const viewMode = isInFullscreen ?
  192.         google.ima.ViewMode.FULLSCREEN : google.ima.ViewMode.NORMAL;
  193.     this.manager_.resize(width, height, viewMode);
  194.   }
  196.   /**
  197.    * @override
  198.    * @export
  199.    */
  200.   setMuted(muted) {
  201.     this.video_.muted = muted;
  202.     // Emulate the "mute" functionality, where current, pre-mute
  203.     // volume is saved and can be restored on unmute.
  204.     if (muted) {
  205.       this.volume_ = this.getVolume();
  206.       this.manager_.setVolume(0);
  207.     } else {
  208.       this.manager_.setVolume(this.volume_);
  209.     }
  210.   }
  212.   /**
  213.    * It's required for a muted ad to start when autoplaying.
  214.    *
  215.    * @param {number} videoVolume
  216.    */
  217.   setInitialMuted(videoVolume) {
  218.     this.volume_ = videoVolume;
  219.     this.manager_.setVolume(0);
  220.   }
  222.   /**
  223.    * @override
  224.    * @export
  225.    */
  226.   getSequenceLength() {
  227.     const podInfo = this.ad_.getAdPodInfo();
  228.     if (podInfo == null) {
  229.       // No pod, just one ad.
  230.       return 1;
  231.     }
  233.     return podInfo.getTotalAds();
  234.   }
  236.   /**
  237.    * @override
  238.    * @export
  239.    */
  240.   getPositionInSequence() {
  241.     const podInfo = this.ad_.getAdPodInfo();
  242.     if (podInfo == null) {
  243.       // No pod, just one ad.
  244.       return 1;
  245.     }
  247.     return podInfo.getAdPosition();
  248.   }
  250.   /**
  251.    * @override
  252.    * @export
  253.    */
  254.   getTitle() {
  255.     return this.ad_.getTitle();
  256.   }
  258.   /**
  259.    * @override
  260.    * @export
  261.    */
  262.   getDescription() {
  263.     return this.ad_.getDescription();
  264.   }
  266.   /**
  267.    * @override
  268.    * @export
  269.    */
  270.   getVastMediaBitrate() {
  271.     return this.ad_.getVastMediaBitrate();
  272.   }
  274.   /**
  275.    * @override
  276.    * @export
  277.    */
  278.   getVastMediaHeight() {
  279.     return this.ad_.getVastMediaHeight();
  280.   }
  282.   /**
  283.    * @override
  284.    * @export
  285.    */
  286.   getVastMediaWidth() {
  287.     return this.ad_.getVastMediaWidth();
  288.   }
  290.   /**
  291.    * @override
  292.    * @export
  293.    */
  294.   getAdId() {
  295.     return this.ad_.getAdId();
  296.   }
  298.   /**
  299.    * @override
  300.    * @export
  301.    */
  302.   getCreativeAdId() {
  303.     return this.ad_.getCreativeAdId();
  304.   }
  306.   /**
  307.    * @override
  308.    * @export
  309.    */
  310.   getAdvertiserName() {
  311.     return this.ad_.getAdvertiserName();
  312.   }
  314.   /**
  315.    * @override
  316.    * @export
  317.    */
  318.   getMediaUrl() {
  319.     return this.ad_.getMediaUrl();
  320.   }
  322.   /**
  323.    * @override
  324.    * @export
  325.    */
  326.   getTimeOffset() {
  327.     const podInfo = this.ad_.getAdPodInfo();
  328.     if (podInfo == null) {
  329.       // Defaults to 0 if this ad is not part of a pod, or the pod is not part
  330.       // of an ad playlist.
  331.       return 0;
  332.     }
  334.     return podInfo.getTimeOffset();
  335.   }
  337.   /**
  338.    * @override
  339.    * @export
  340.    */
  341.   getPodIndex() {
  342.     const podInfo = this.ad_.getAdPodInfo();
  343.     if (podInfo == null) {
  344.       // Defaults to 0 if this ad is not part of a pod, or the pod is not part
  345.       // of an ad playlist.
  346.       return 0;
  347.     }
  349.     return podInfo.getPodIndex();
  350.   }
  352.   /**
  353.    * @override
  354.    * @export
  355.    */
  356.   release() {
  357.     this.ad_ = null;
  358.     this.manager_ = null;
  359.   }
  360. };