Source: ui/ad_info.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.AdInfo');
  10. goog.require('goog.asserts');
  11. goog.require('shaka.ads.Utils');
  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.AdInfo = 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.adInfo_ = shaka.util.Dom.createButton();
  36.     this.adInfo_.classList.add('shaka-ad-info');
  37.     this.adInfo_.disabled = true;
  38.     this.parent.appendChild(this.adInfo_);
  40.     /**
  41.      * The timer that tracks down the ad progress.
  42.      *
  43.      * @private {shaka.util.Timer}
  44.      */
  45.     this.timer_ = new shaka.util.Timer(() => {
  46.       this.onTimerTick_();
  47.     });
  49.     this.updateAriaLabel_();
  51.     this.eventManager.listen(
  52.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  53.           this.updateAriaLabel_();
  54.         });
  56.     this.eventManager.listen(
  57.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  58.           this.updateAriaLabel_();
  59.         });
  61.     this.eventManager.listen(
  62.         this.adManager, shaka.ads.Utils.AD_STARTED, () => {
  63.           this.onAdStarted_();
  64.         });
  66.     this.eventManager.listen(
  67.         this.adManager, shaka.ads.Utils.AD_STOPPED, () => {
  68.           this.reset_();
  69.         });
  71.     if (this.ad) {
  72.       // There was already an ad.
  73.       this.onAdStarted_();
  74.     }
  75.   }
  77.   /**
  78.    * @private
  79.    */
  80.   updateAriaLabel_() {
  81.     // TODO
  82.   }
  84.   /**
  85.    * @private
  86.    */
  87.   onAdStarted_() {
  88.     this.timer_.tickNow();
  89.     this.timer_.tickEvery(0.5);
  90.   }
  92.   /**
  93.    * @private
  94.    */
  95.   onTimerTick_() {
  96.     const LocIds = shaka.ui.Locales.Ids;
  98.     goog.asserts.assert(this.ad != null,
  99.         'this.ad should exist at this point');
  101.     if (!this.ad.isLinear()) {
  102.       // Do not show information for non-linear ads.
  103.       return;
  104.     }
  106.     let text = '';
  108.     const adsInAdPod = this.ad.getSequenceLength();
  109.     if (adsInAdPod > 1) {
  110.       // If it's a single ad, showing 'Ad 1 of 1' isn't helpful.
  111.       // Only show this element if there's more than 1 ad and it's a linear ad.
  112.       const adPosition = this.ad.getPositionInSequence();
  113.       text = this.localization.resolve(LocIds.AD_PROGRESS)
  114.           .replace('[AD_ON]', String(adPosition))
  115.           .replace('[NUM_ADS]', String(adsInAdPod));
  116.     }
  118.     const secondsLeft = Math.round(this.ad.getRemainingTime());
  119.     const adDuration = this.ad.getDuration();
  120.     if (secondsLeft == -1 || adDuration == -1) {
  121.       this.adInfo_.textContent = text;
  122.       shaka.ui.Utils.setDisplay(this.adInfo_, text != '');
  123.       return;
  124.     }
  126.     if (secondsLeft > 0) {
  127.       const timePassed = adDuration - secondsLeft;
  128.       const timePassedStr =
  129.           shaka.ui.Utils.buildTimeString(timePassed, /* showHour= */ false);
  130.       const adLength = shaka.ui.Utils.buildTimeString(
  131.           adDuration, /* showHour= */ false);
  132.       const timeString = timePassedStr + ' / ' + adLength;
  134.       // If there's more than one ad in the sequence, show the time
  135.       // without the word 'Ad' (it will be shown by another element).
  136.       // Otherwise, the format is "Ad: 0:05 / 0:10."
  137.       if (adsInAdPod > 1) {
  138.         text += '\u00A0\u00A0' + timeString;
  139.       } else {
  140.         text = this.localization.resolve(LocIds.AD_TIME)
  141.             .replace('[AD_TIME]', timeString);
  142.       }
  143.       this.adInfo_.textContent = text;
  144.       shaka.ui.Utils.setDisplay(this.adInfo_, text != '');
  145.     } else {
  146.       this.reset_();
  147.     }
  148.   }
  150.   /**
  151.    * @private
  152.    */
  153.   reset_() {
  154.     this.timer_.stop();
  155.     // Controls are going to hide the whole ad panel once the ad is over,
  156.     // this is just a safeguard.
  157.     this.adInfo_.textContent = '';
  158.   }
  160.   /**
  161.    * @override
  162.    */
  163.   release() {
  164.     this.timer_.stop();
  165.     this.timer_ = null;
  166.     super.release();
  167.   }
  168. };