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