Source: lib/ads/interstitial_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.InterstitialAd');
  10. /**
  11.  * @implements {shaka.extern.IAd}
  12.  * @export
  13.  */
  14. shaka.ads.InterstitialAd = class {
  15.   /**
  16.    * @param {HTMLMediaElement} video
  17.    * @param {boolean} isSkippable
  18.    * @param {?number} skipOffset
  19.    * @param {function()} onSkip
  20.    * @param {number} sequenceLength
  21.    * @param {number} adPosition
  22.    */
  23.   constructor(video, isSkippable, skipOffset, onSkip,
  24.       sequenceLength, adPosition) {
  25.     /** @private {HTMLMediaElement} */
  26.     this.video_ = video;
  28.     /** @private {boolean} */
  29.     this.isSkippable_ = isSkippable;
  31.     /** @private {?number} */
  32.     this.skipOffset_ = skipOffset;
  34.     /** @private {function()} */
  35.     this.onSkip_ = onSkip;
  37.     /** @private {number} */
  38.     this.sequenceLength_ = sequenceLength;
  40.     /** @private {number} */
  41.     this.adPosition_ = adPosition;
  42.   }
  44.   /**
  45.    * @override
  46.    * @export
  47.    */
  48.   needsSkipUI() {
  49.     return true;
  50.   }
  52.   /**
  53.    * @override
  54.    * @export
  55.    */
  56.   getDuration() {
  57.     const duration = this.video_.duration;
  58.     if (isNaN(duration)) {
  59.       return -1;
  60.     }
  61.     return duration;
  62.   }
  64.   /**
  65.    * @override
  66.    * @export
  67.    */
  68.   getMinSuggestedDuration() {
  69.     return this.getDuration();
  70.   }
  72.   /**
  73.    * @override
  74.    * @export
  75.    */
  76.   getRemainingTime() {
  77.     const duration = this.video_.duration;
  78.     if (isNaN(duration)) {
  79.       return -1;
  80.     }
  81.     return duration - this.video_.currentTime;
  82.   }
  84.   /**
  85.    * @override
  86.    * @export
  87.    */
  88.   isPaused() {
  89.     return this.video_.paused;
  90.   }
  92.   /**
  93.    * @override
  94.    * @export
  95.    */
  96.   isSkippable() {
  97.     return this.isSkippable_;
  98.   }
  100.   /**
  101.    * @override
  102.    * @export
  103.    */
  104.   getTimeUntilSkippable() {
  105.     if (this.isSkippable_) {
  106.       const canSkipIn =
  107.           this.getRemainingTime() + this.skipOffset_ - this.getDuration();
  108.       return Math.max(canSkipIn, 0);
  109.     }
  110.     return Math.max(this.getRemainingTime(), 0);
  111.   }
  113.   /**
  114.    * @override
  115.    * @export
  116.    */
  117.   canSkipNow() {
  118.     return this.getTimeUntilSkippable() == 0;
  119.   }
  121.   /**
  122.    * @override
  123.    * @export
  124.    */
  125.   skip() {
  126.     this.onSkip_();
  127.   }
  129.   /**
  130.    * @override
  131.    * @export
  132.    */
  133.   pause() {
  134.     return this.video_.pause();
  135.   }
  137.   /**
  138.    * @override
  139.    * @export
  140.    */
  141.   play() {
  142.     return this.video_.play();
  143.   }
  146.   /**
  147.    * @override
  148.    * @export
  149.    */
  150.   getVolume() {
  151.     return this.video_.volume;
  152.   }
  154.   /**
  155.    * @override
  156.    * @export
  157.    */
  158.   setVolume(volume) {
  159.     this.video_.volume = volume;
  160.   }
  162.   /**
  163.    * @override
  164.    * @export
  165.    */
  166.   isMuted() {
  167.     return this.video_.muted;
  168.   }
  170.   /**
  171.    * @override
  172.    * @export
  173.    */
  174.   isLinear() {
  175.     return true;
  176.   }
  178.   /**
  179.    * @override
  180.    * @export
  181.    */
  182.   resize(width, height) {
  183.     // Nothing
  184.   }
  186.   /**
  187.    * @override
  188.    * @export
  189.    */
  190.   setMuted(muted) {
  191.     this.video_.muted = muted;
  192.   }
  195.   /**
  196.    * @override
  197.    * @export
  198.    */
  199.   getSequenceLength() {
  200.     return this.sequenceLength_;
  201.   }
  203.   /**
  204.    * @override
  205.    * @export
  206.    */
  207.   getPositionInSequence() {
  208.     return this.adPosition_;
  209.   }
  211.   /**
  212.    * @override
  213.    * @export
  214.    */
  215.   getTitle() {
  216.     return '';
  217.   }
  219.   /**
  220.    * @override
  221.    * @export
  222.    */
  223.   getDescription() {
  224.     return '';
  225.   }
  227.   /**
  228.    * @override
  229.    * @export
  230.    */
  231.   getVastMediaBitrate() {
  232.     return 0;
  233.   }
  235.   /**
  236.    * @override
  237.    * @export
  238.    */
  239.   getVastMediaHeight() {
  240.     return 0;
  241.   }
  243.   /**
  244.    * @override
  245.    * @export
  246.    */
  247.   getVastMediaWidth() {
  248.     return 0;
  249.   }
  251.   /**
  252.    * @override
  253.    * @export
  254.    */
  255.   getAdId() {
  256.     return '';
  257.   }
  259.   /**
  260.    * @override
  261.    * @export
  262.    */
  263.   getCreativeAdId() {
  264.     return '';
  265.   }
  267.   /**
  268.    * @override
  269.    * @export
  270.    */
  271.   getAdvertiserName() {
  272.     return '';
  273.   }
  275.   /**
  276.    * @override
  277.    * @export
  278.    */
  279.   getMediaUrl() {
  280.     return null;
  281.   }
  283.   /**
  284.    * @override
  285.    * @export
  286.    */
  287.   getTimeOffset() {
  288.     return 0;
  289.   }
  291.   /**
  292.    * @override
  293.    * @export
  294.    */
  295.   getPodIndex() {
  296.     return 0;
  297.   }
  299.   /**
  300.    * @override
  301.    * @export
  302.    */
  303.   release() {
  304.     this.video_ = null;
  305.   }
  306. };