Source: lib/ads/server_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.ServerSideAd');
  10. /**
  11.  * @implements {shaka.extern.IAd}
  12.  * @export
  13.  */
  14. shaka.ads.ServerSideAd = class {
  15.   /**
  16.    * @param {google.ima.dai.api.Ad} imaAd
  17.    * @param {HTMLMediaElement} video
  18.    */
  19.   constructor(imaAd, video) {
  20.     /** @private {google.ima.dai.api.Ad} */
  21.     this.ad_ = imaAd;
  23.     /** @private {?google.ima.dai.api.AdProgressData} */
  24.     this.adProgressData_ = null;
  26.     /** @private {HTMLMediaElement} */
  27.     this.video_ = video;
  28.   }
  31.   /**
  32.    * @param {google.ima.dai.api.AdProgressData} data
  33.    */
  34.   setProgressData(data) {
  35.     this.adProgressData_ = data;
  36.   }
  39.   /**
  40.    * @override
  41.    * @export
  42.    */
  43.   getDuration() {
  44.     if (!this.adProgressData_) {
  45.       // Unknown yet
  46.       return -1;
  47.     }
  48.     return this.adProgressData_.duration;
  49.   }
  51.   /**
  52.    * @override
  53.    * @export
  54.    */
  55.   getMinSuggestedDuration() {
  56.     return this.getDuration();
  57.   }
  59.   /**
  60.    * @override
  61.    * @export
  62.    */
  63.   getRemainingTime() {
  64.     if (!this.adProgressData_) {
  65.       // Unknown yet
  66.       return -1;
  67.     }
  69.     return this.adProgressData_.duration - this.adProgressData_.currentTime;
  70.   }
  72.   /**
  73.    * @override
  74.    * @export
  75.    */
  76.   isPaused() {
  77.     return this.video_.paused;
  78.   }
  80.   /**
  81.    * @override
  82.    * @export
  83.    */
  84.   isSkippable() {
  85.     return this.ad_.isSkippable();
  86.   }
  88.   /**
  89.    * @override
  90.    * @export
  91.    */
  92.   getTimeUntilSkippable() {
  93.     const skipOffset = this.ad_.getSkipTimeOffset();
  94.     const canSkipIn = this.getRemainingTime() - 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.video_.currentTime += this.getRemainingTime();
  112.   }
  114.   /**
  115.    * @override
  116.    * @export
  117.    */
  118.   pause() {
  119.     return this.video_.pause();
  120.   }
  122.   /**
  123.    * @override
  124.    * @export
  125.    */
  126.   play() {
  127.     return this.video_.play();
  128.   }
  131.   /**
  132.    * @override
  133.    * @export
  134.    */
  135.   getVolume() {
  136.     return this.video_.volume;
  137.   }
  139.   /**
  140.    * @override
  141.    * @export
  142.    */
  143.   setVolume(volume) {
  144.     this.video_.volume = volume;
  145.   }
  147.   /**
  148.    * @override
  149.    * @export
  150.    */
  151.   isMuted() {
  152.     return this.video_.muted;
  153.   }
  155.   /**
  156.    * @override
  157.    * @export
  158.    */
  159.   isLinear() {
  160.     return true;
  161.   }
  163.   /**
  164.    * @override
  165.    * @export
  166.    */
  167.   resize(width, height) {
  168.     // Nothing
  169.   }
  171.   /**
  172.    * @override
  173.    * @export
  174.    */
  175.   setMuted(muted) {
  176.     this.video_.muted = muted;
  177.   }
  180.   /**
  181.    * @override
  182.    * @export
  183.    */
  184.   getSequenceLength() {
  185.     const podInfo = this.ad_.getAdPodInfo();
  186.     if (podInfo == null) {
  187.       // No pod, just one ad.
  188.       return 1;
  189.     }
  191.     return podInfo.getTotalAds();
  192.   }
  194.   /**
  195.    * @override
  196.    * @export
  197.    */
  198.   getPositionInSequence() {
  199.     const podInfo = this.ad_.getAdPodInfo();
  200.     if (podInfo == null) {
  201.       // No pod, just one ad.
  202.       return 1;
  203.     }
  205.     return podInfo.getAdPosition();
  206.   }
  209.   /**
  210.    * @override
  211.    * @export
  212.    */
  213.   release() {
  214.     this.ad_ = null;
  215.     this.adProgressData_ = null;
  216.     this.video_ = null;
  217.   }
  218. };