Source: lib/ads/media_tailor_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.MediaTailorAd');
  10. /**
  11.  * @implements {shaka.extern.IAd}
  12.  * @export
  13.  */
  14. shaka.ads.MediaTailorAd = class {
  15.   /**
  16.    * @param {mediaTailor.Ad} mediaTailorAd
  17.    * @param {number} adPosition
  18.    * @param {number} totalAds
  19.    * @param {HTMLMediaElement} video
  20.    */
  21.   constructor(mediaTailorAd, adPosition, totalAds, isLinear, video) {
  22.     /** @private {?mediaTailor.Ad} */
  23.     this.ad_ = mediaTailorAd;
  25.     /** @private {HTMLMediaElement} */
  26.     this.video_ = video;
  28.     /** @private {?number} */
  29.     this.adPosition_ = adPosition;
  31.     /** @private {?number} */
  32.     this.totalAds_ = totalAds;
  34.     /** @private {boolean} */
  35.     this.isLinear_ = isLinear;
  36.   }
  39.   /**
  40.    * @override
  41.    * @export
  42.    */
  43.   getDuration() {
  44.     return this.ad_.durationInSeconds;
  45.   }
  47.   /**
  48.    * @override
  49.    * @export
  50.    */
  51.   getMinSuggestedDuration() {
  52.     return this.getDuration();
  53.   }
  55.   /**
  56.    * @override
  57.    * @export
  58.    */
  59.   getRemainingTime() {
  60.     const endTime = this.ad_.startTimeInSeconds + this.ad_.durationInSeconds;
  61.     return endTime - this.video_.currentTime;
  62.   }
  64.   /**
  65.    * @override
  66.    * @export
  67.    */
  68.   isPaused() {
  69.     return this.video_.paused;
  70.   }
  72.   /**
  73.    * @override
  74.    * @export
  75.    */
  76.   isSkippable() {
  77.     if (this.ad_.skipOffset) {
  78.       return true;
  79.     }
  80.     return false;
  81.   }
  83.   /**
  84.    * @override
  85.    * @export
  86.    */
  87.   getTimeUntilSkippable() {
  88.     if (!this.ad_.skipOffset) {
  89.       return this.getRemainingTime();
  90.     }
  91.     const canSkipIn = this.getRemainingTime() - this.ad_.skipOffset;
  92.     return Math.max(canSkipIn, 0);
  93.   }
  95.   /**
  96.    * @override
  97.    * @export
  98.    */
  99.   canSkipNow() {
  100.     return this.getTimeUntilSkippable() == 0;
  101.   }
  103.   /**
  104.    * @override
  105.    * @export
  106.    */
  107.   skip() {
  108.     this.video_.currentTime += this.getRemainingTime();
  109.   }
  111.   /**
  112.    * @override
  113.    * @export
  114.    */
  115.   pause() {
  116.     return this.video_.pause();
  117.   }
  119.   /**
  120.    * @override
  121.    * @export
  122.    */
  123.   play() {
  124.     return this.video_.play();
  125.   }
  128.   /**
  129.    * @override
  130.    * @export
  131.    */
  132.   getVolume() {
  133.     return this.video_.volume;
  134.   }
  136.   /**
  137.    * @override
  138.    * @export
  139.    */
  140.   setVolume(volume) {
  141.     this.video_.volume = volume;
  142.   }
  144.   /**
  145.    * @override
  146.    * @export
  147.    */
  148.   isMuted() {
  149.     return this.video_.muted;
  150.   }
  152.   /**
  153.    * @override
  154.    * @export
  155.    */
  156.   isLinear() {
  157.     return this.isLinear_;
  158.   }
  160.   /**
  161.    * @override
  162.    * @export
  163.    */
  164.   resize(width, height) {
  165.     // Nothing
  166.   }
  168.   /**
  169.    * @override
  170.    * @export
  171.    */
  172.   setMuted(muted) {
  173.     this.video_.muted = muted;
  174.   }
  177.   /**
  178.    * @override
  179.    * @export
  180.    */
  181.   getSequenceLength() {
  182.     if (!this.totalAds_) {
  183.       return 1;
  184.     }
  185.     return this.totalAds_;
  186.   }
  188.   /**
  189.    * @override
  190.    * @export
  191.    */
  192.   getPositionInSequence() {
  193.     if (!this.adPosition_) {
  194.       return 1;
  195.     }
  196.     return this.adPosition_;
  197.   }
  199.   /**
  200.    * @override
  201.    * @export
  202.    */
  203.   getTitle() {
  204.     return this.ad_.adTitle;
  205.   }
  207.   /**
  208.    * @override
  209.    * @export
  210.    */
  211.   getDescription() {
  212.     return '';
  213.   }
  215.   /**
  216.    * @override
  217.    * @export
  218.    */
  219.   getVastMediaBitrate() {
  220.     return 0;
  221.   }
  223.   /**
  224.    * @override
  225.    * @export
  226.    */
  227.   getVastMediaHeight() {
  228.     return 0;
  229.   }
  231.   /**
  232.    * @override
  233.    * @export
  234.    */
  235.   getVastMediaWidth() {
  236.     return 0;
  237.   }
  239.   /**
  240.    * @override
  241.    * @export
  242.    */
  243.   getAdId() {
  244.     return this.ad_.adId;
  245.   }
  247.   /**
  248.    * @override
  249.    * @export
  250.    */
  251.   getCreativeAdId() {
  252.     return this.ad_.creativeId;
  253.   }
  255.   /**
  256.    * @override
  257.    * @export
  258.    */
  259.   getAdvertiserName() {
  260.     return '';
  261.   }
  263.   /**
  264.    * @override
  265.    * @export
  266.    */
  267.   getMediaUrl() {
  268.     return null;
  269.   }
  271.   /**
  272.    * @override
  273.    * @export
  274.    */
  275.   getTimeOffset() {
  276.     return 0;
  277.   }
  279.   /**
  280.    * @override
  281.    * @export
  282.    */
  283.   getPodIndex() {
  284.     return 0;
  285.   }
  287.   /**
  288.    * @override
  289.    * @export
  290.    */
  291.   release() {
  292.     this.ad_ = null;
  293.     this.video_ = null;
  294.     this.adPosition_ = null;
  295.     this.totalAds_ = null;
  296.   }
  297. };