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 {function()} onSkip
  19.    * @param {number} sequenceLength
  20.    * @param {number} adPosition
  21.    */
  22.   constructor(video, isSkippable, onSkip, sequenceLength, adPosition) {
  23.     /** @private {HTMLMediaElement} */
  24.     this.video_ = video;
  26.     /** @private {boolean} */
  27.     this.isSkippable_ = isSkippable;
  29.     /** @private {function()} */
  30.     this.onSkip_ = onSkip;
  32.     /** @private {number} */
  33.     this.sequenceLength_ = sequenceLength;
  35.     /** @private {number} */
  36.     this.adPosition_ = adPosition;
  37.   }
  39.   /**
  40.    * @override
  41.    * @export
  42.    */
  43.   needsSkipUI() {
  44.     return true;
  45.   }
  47.   /**
  48.    * @override
  49.    * @export
  50.    */
  51.   isClientRendering() {
  52.     return true;
  53.   }
  55.   /**
  56.    * @override
  57.    * @export
  58.    */
  59.   getDuration() {
  60.     const duration = this.video_.duration;
  61.     if (isNaN(duration)) {
  62.       return -1;
  63.     }
  64.     return duration;
  65.   }
  67.   /**
  68.    * @override
  69.    * @export
  70.    */
  71.   getMinSuggestedDuration() {
  72.     return this.getDuration();
  73.   }
  75.   /**
  76.    * @override
  77.    * @export
  78.    */
  79.   getRemainingTime() {
  80.     const duration = this.video_.duration;
  81.     if (isNaN(duration)) {
  82.       return -1;
  83.     }
  84.     return duration - this.video_.currentTime;
  85.   }
  87.   /**
  88.    * @override
  89.    * @export
  90.    */
  91.   isPaused() {
  92.     return this.video_.paused;
  93.   }
  95.   /**
  96.    * @override
  97.    * @export
  98.    */
  99.   isSkippable() {
  100.     return this.isSkippable_;
  101.   }
  103.   /**
  104.    * @override
  105.    * @export
  106.    */
  107.   getTimeUntilSkippable() {
  108.     if (this.isSkippable_) {
  109.       return 0;
  110.     }
  111.     return Math.max(this.getRemainingTime(), 0);
  112.   }
  114.   /**
  115.    * @override
  116.    * @export
  117.    */
  118.   canSkipNow() {
  119.     return this.getTimeUntilSkippable() == 0;
  120.   }
  122.   /**
  123.    * @override
  124.    * @export
  125.    */
  126.   skip() {
  127.     this.onSkip_();
  128.   }
  130.   /**
  131.    * @override
  132.    * @export
  133.    */
  134.   pause() {
  135.     return this.video_.pause();
  136.   }
  138.   /**
  139.    * @override
  140.    * @export
  141.    */
  142.   play() {
  143.     return this.video_.play();
  144.   }
  147.   /**
  148.    * @override
  149.    * @export
  150.    */
  151.   getVolume() {
  152.     return this.video_.volume;
  153.   }
  155.   /**
  156.    * @override
  157.    * @export
  158.    */
  159.   setVolume(volume) {
  160.     this.video_.volume = volume;
  161.   }
  163.   /**
  164.    * @override
  165.    * @export
  166.    */
  167.   isMuted() {
  168.     return this.video_.muted;
  169.   }
  171.   /**
  172.    * @override
  173.    * @export
  174.    */
  175.   isLinear() {
  176.     return true;
  177.   }
  179.   /**
  180.    * @override
  181.    * @export
  182.    */
  183.   resize(width, height) {
  184.     // Nothing
  185.   }
  187.   /**
  188.    * @override
  189.    * @export
  190.    */
  191.   setMuted(muted) {
  192.     this.video_.muted = muted;
  193.   }
  196.   /**
  197.    * @override
  198.    * @export
  199.    */
  200.   getSequenceLength() {
  201.     return this.sequenceLength_;
  202.   }
  204.   /**
  205.    * @override
  206.    * @export
  207.    */
  208.   getPositionInSequence() {
  209.     return this.adPosition_;
  210.   }
  212.   /**
  213.    * @override
  214.    * @export
  215.    */
  216.   getTitle() {
  217.     return '';
  218.   }
  220.   /**
  221.    * @override
  222.    * @export
  223.    */
  224.   getDescription() {
  225.     return '';
  226.   }
  228.   /**
  229.    * @override
  230.    * @export
  231.    */
  232.   getVastMediaBitrate() {
  233.     return 0;
  234.   }
  236.   /**
  237.    * @override
  238.    * @export
  239.    */
  240.   getVastMediaHeight() {
  241.     return 0;
  242.   }
  244.   /**
  245.    * @override
  246.    * @export
  247.    */
  248.   getVastMediaWidth() {
  249.     return 0;
  250.   }
  252.   /**
  253.    * @override
  254.    * @export
  255.    */
  256.   getAdId() {
  257.     return '';
  258.   }
  260.   /**
  261.    * @override
  262.    * @export
  263.    */
  264.   getCreativeAdId() {
  265.     return '';
  266.   }
  268.   /**
  269.    * @override
  270.    * @export
  271.    */
  272.   getAdvertiserName() {
  273.     return '';
  274.   }
  276.   /**
  277.    * @override
  278.    * @export
  279.    */
  280.   getMediaUrl() {
  281.     return null;
  282.   }
  284.   /**
  285.    * @override
  286.    * @export
  287.    */
  288.   getTimeOffset() {
  289.     return 0;
  290.   }
  292.   /**
  293.    * @override
  294.    * @export
  295.    */
  296.   getPodIndex() {
  297.     return 0;
  298.   }
  300.   /**
  301.    * @override
  302.    * @export
  303.    */
  304.   release() {
  305.     this.video_ = null;
  306.   }
  307. };