Source: ui/ad_counter.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.AdCounter');
  10. goog.require('goog.asserts');
  11. goog.require('shaka.ads.AdManager');
  12. goog.require('shaka.ui.Element');
  13. goog.require('shaka.ui.Locales');
  14. goog.require('shaka.ui.Localization');
  15. goog.require('shaka.ui.Utils');
  16. goog.require('shaka.util.Dom');
  17. goog.require('shaka.util.Timer');
  18. goog.requireType('shaka.ui.Controls');
  21. /**
  22.  * @extends {shaka.ui.Element}
  23.  * @final
  24.  * @export
  25.  */
  26. shaka.ui.AdCounter = class extends shaka.ui.Element {
  27.   /**
  28.    * @param {!HTMLElement} parent
  29.    * @param {!shaka.ui.Controls} controls
  30.    */
  31.   constructor(parent, controls) {
  32.     super(parent, controls);
  34.     /** @private {!HTMLElement} */
  35.     this.container_ = shaka.util.Dom.createHTMLElement('div');
  36.     this.container_.classList.add('shaka-ad-counter');
  37.     this.parent.appendChild(this.container_);
  39.     /** @private {!HTMLElement} */
  40.     this.span_ = shaka.util.Dom.createHTMLElement('span');
  41.     this.span_.classList.add('shaka-ad-counter-span');
  42.     this.container_.appendChild(this.span_);
  44.     /**
  45.      * The timer that tracks down the ad progress.
  46.      *
  47.      * @private {shaka.util.Timer}
  48.      */
  49.     this.timer_ = new shaka.util.Timer(() => {
  50.       this.onTimerTick_();
  51.     });
  53.     this.updateAriaLabel_();
  55.     this.eventManager.listen(
  56.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  57.           this.updateAriaLabel_();
  58.         });
  60.     this.eventManager.listen(
  61.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  62.           this.updateAriaLabel_();
  63.         });
  65.     this.eventManager.listen(
  66.         this.adManager, shaka.ads.AdManager.AD_STARTED, () => {
  67.           this.onAdStarted_();
  68.         });
  70.     this.eventManager.listen(
  71.         this.adManager, shaka.ads.AdManager.AD_STOPPED, () => {
  72.           this.reset_();
  73.         });
  75.     if (this.ad) {
  76.       // There was already an ad.
  77.       this.onAdStarted_();
  78.     }
  79.   }
  81.   /**
  82.    * @private
  83.    */
  84.   updateAriaLabel_() {
  85.     // TODO
  86.   }
  88.   /**
  89.    * @private
  90.    */
  91.   onAdStarted_() {
  92.     this.timer_.tickNow();
  93.     this.timer_.tickEvery(0.5);
  94.   }
  96.   /**
  97.    * @private
  98.    */
  99.   onTimerTick_() {
  100.     goog.asserts.assert(this.ad != null,
  101.         'this.ad should exist at this point');
  103.     const secondsLeft = Math.round(this.ad.getRemainingTime());
  104.     const adDuration = this.ad.getDuration();
  105.     if (secondsLeft == -1 || adDuration == -1) {
  106.       // Not enough information about the ad. Don't show the
  107.       // counter just yet.
  108.       return;
  109.     }
  111.     if (secondsLeft > 0) {
  112.       const timePassed = adDuration - secondsLeft;
  113.       const timePassedStr =
  114.           shaka.ui.Utils.buildTimeString(timePassed, /* showHour= */ false);
  115.       const adLength = shaka.ui.Utils.buildTimeString(
  116.           adDuration, /* showHour= */ false);
  117.       const timeString = timePassedStr + ' / ' + adLength;
  119.       const adsInAdPod = this.ad.getSequenceLength();
  120.       // If there's more than one ad in the sequence, show the time
  121.       // without the word 'Ad' (it will be shown by another element).
  122.       // Otherwise, the format is "Ad: 0:05 / 0:10."
  123.       if (adsInAdPod > 1) {
  124.         this.span_.textContent = timeString;
  125.       } else {
  126.         const LocIds = shaka.ui.Locales.Ids;
  127.         const raw = this.localization.resolve(LocIds.AD_TIME);
  128.         this.span_.textContent = raw.replace('[AD_TIME]', timeString);
  129.       }
  130.     } else {
  131.       this.reset_();
  132.     }
  133.   }
  135.   /**
  136.    * @private
  137.    */
  138.   reset_() {
  139.     this.timer_.stop();
  140.     // Controls are going to hide the whole ad panel once the ad is over,
  141.     // this is just a safeguard.
  142.     this.span_.textContent = '';
  143.   }
  145.   /**
  146.    * @override
  147.    */
  148.   release() {
  149.     this.timer_.stop();
  150.     this.timer_ = null;
  151.     super.release();
  152.   }
  153. };