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;
  37.     /** @private {boolean} */
  38.     this.isSkipped_ = false;
  39.   }
  42.   /**
  43.    * @override
  44.    * @export
  45.    */
  46.   getDuration() {
  47.     return this.ad_.durationInSeconds;
  48.   }
  50.   /**
  51.    * @override
  52.    * @export
  53.    */
  54.   getMinSuggestedDuration() {
  55.     return this.getDuration();
  56.   }
  58.   /**
  59.    * @override
  60.    * @export
  61.    */
  62.   getRemainingTime() {
  63.     const endTime = this.ad_.startTimeInSeconds + this.ad_.durationInSeconds;
  64.     return endTime - this.video_.currentTime;
  65.   }
  67.   /**
  68.    * @override
  69.    * @export
  70.    */
  71.   isPaused() {
  72.     return this.video_.paused;
  73.   }
  75.   /**
  76.    * @override
  77.    * @export
  78.    */
  79.   isSkippable() {
  80.     if (this.ad_.skipOffset) {
  81.       return true;
  82.     }
  83.     return false;
  84.   }
  86.   /**
  87.    * @override
  88.    * @export
  89.    */
  90.   getTimeUntilSkippable() {
  91.     if (!this.ad_.skipOffset) {
  92.       return this.getRemainingTime();
  93.     }
  94.     const canSkipIn = this.getRemainingTime() - this.ad_.skipOffset;
  95.     return Math.max(canSkipIn, 0);
  96.   }
  98.   /**
  99.    * @override
  100.    * @export
  101.    */
  102.   canSkipNow() {
  103.     return this.getTimeUntilSkippable() == 0;
  104.   }
  106.   /**
  107.    * @override
  108.    * @export
  109.    */
  110.   skip() {
  111.     this.isSkipped_ = true;
  112.     this.video_.currentTime += this.getRemainingTime();
  113.   }
  115.   /**
  116.    * @override
  117.    * @export
  118.    */
  119.   pause() {
  120.     return this.video_.pause();
  121.   }
  123.   /**
  124.    * @override
  125.    * @export
  126.    */
  127.   play() {
  128.     return this.video_.play();
  129.   }
  132.   /**
  133.    * @override
  134.    * @export
  135.    */
  136.   getVolume() {
  137.     return this.video_.volume;
  138.   }
  140.   /**
  141.    * @override
  142.    * @export
  143.    */
  144.   setVolume(volume) {
  145.     this.video_.volume = volume;
  146.   }
  148.   /**
  149.    * @override
  150.    * @export
  151.    */
  152.   isMuted() {
  153.     return this.video_.muted;
  154.   }
  156.   /**
  157.    * @override
  158.    * @export
  159.    */
  160.   isLinear() {
  161.     return this.isLinear_;
  162.   }
  164.   /**
  165.    * @override
  166.    * @export
  167.    */
  168.   resize(width, height) {
  169.     // Nothing
  170.   }
  172.   /**
  173.    * @override
  174.    * @export
  175.    */
  176.   setMuted(muted) {
  177.     this.video_.muted = muted;
  178.   }
  181.   /**
  182.    * @override
  183.    * @export
  184.    */
  185.   getSequenceLength() {
  186.     if (!this.totalAds_) {
  187.       return 1;
  188.     }
  189.     return this.totalAds_;
  190.   }
  192.   /**
  193.    * @override
  194.    * @export
  195.    */
  196.   getPositionInSequence() {
  197.     if (!this.adPosition_) {
  198.       return 1;
  199.     }
  200.     return this.adPosition_;
  201.   }
  203.   /**
  204.    * @override
  205.    * @export
  206.    */
  207.   getTitle() {
  208.     return this.ad_.adTitle;
  209.   }
  211.   /**
  212.    * @override
  213.    * @export
  214.    */
  215.   getDescription() {
  216.     return '';
  217.   }
  219.   /**
  220.    * @override
  221.    * @export
  222.    */
  223.   getVastMediaBitrate() {
  224.     return 0;
  225.   }
  227.   /**
  228.    * @override
  229.    * @export
  230.    */
  231.   getVastMediaHeight() {
  232.     return 0;
  233.   }
  235.   /**
  236.    * @override
  237.    * @export
  238.    */
  239.   getVastMediaWidth() {
  240.     return 0;
  241.   }
  243.   /**
  244.    * @override
  245.    * @export
  246.    */
  247.   getAdId() {
  248.     return this.ad_.adId;
  249.   }
  251.   /**
  252.    * @override
  253.    * @export
  254.    */
  255.   getCreativeAdId() {
  256.     return this.ad_.creativeId;
  257.   }
  259.   /**
  260.    * @override
  261.    * @export
  262.    */
  263.   getAdvertiserName() {
  264.     return '';
  265.   }
  267.   /**
  268.    * @override
  269.    * @export
  270.    */
  271.   getMediaUrl() {
  272.     return null;
  273.   }
  275.   /**
  276.    * @override
  277.    * @export
  278.    */
  279.   getTimeOffset() {
  280.     return 0;
  281.   }
  283.   /**
  284.    * @override
  285.    * @export
  286.    */
  287.   getPodIndex() {
  288.     return 0;
  289.   }
  291.   /**
  292.    * @override
  293.    * @export
  294.    */
  295.   release() {
  296.     this.ad_ = null;
  297.     this.video_ = null;
  298.     this.adPosition_ = null;
  299.     this.totalAds_ = null;
  300.   }
  302.   /**
  303.    * @return {boolean}
  304.    */
  305.   isSkipped() {
  306.     return this.isSkipped_;
  307.   }
  308. };