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