Source: ui/presentation_time.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.PresentationTimeTracker');
  10. goog.require('shaka.ads.Utils');
  11. goog.require('shaka.ui.Controls');
  12. goog.require('shaka.ui.Element');
  13. goog.require('shaka.ui.Locales');
  14. goog.require('shaka.ui.Utils');
  15. goog.require('shaka.util.Dom');
  18. /**
  19.  * @extends {shaka.ui.Element}
  20.  * @final
  21.  * @export
  22.  */
  23. shaka.ui.PresentationTimeTracker = class extends shaka.ui.Element {
  24.   /**
  25.    * @param {!HTMLElement} parent
  26.    * @param {!shaka.ui.Controls} controls
  27.    */
  28.   constructor(parent, controls) {
  29.     super(parent, controls);
  31.     /** @type {!HTMLButtonElement} */
  32.     this.currentTime_ = shaka.util.Dom.createButton();
  33.     this.currentTime_.classList.add('shaka-current-time');
  34.     this.setValue_('0:00');
  35.     this.parent.appendChild(this.currentTime_);
  37.     this.eventManager.listen(this.currentTime_, 'click', () => {
  38.       if (!this.controls.isOpaque()) {
  39.         return;
  40.       }
  41.       // Jump to LIVE if the user clicks on the current time.
  42.       if (this.player.isLive()) {
  43.         this.video.currentTime = this.player.seekRange().end;
  44.       }
  45.     });
  47.     this.eventManager.listen(this.player, 'loading', () => {
  48.       shaka.ui.Utils.setDisplay(this.currentTime_, true);
  49.     });
  51.     this.eventManager.listen(this.controls, 'timeandseekrangeupdated', () => {
  52.       this.updateTime_();
  53.     });
  55.     this.eventManager.listen(this.player, 'trackschanged', () => {
  56.       this.onTracksChanged_();
  57.     });
  59.     this.eventManager.listen(
  60.         this.adManager, shaka.ads.Utils.AD_STARTED, () => {
  61.           shaka.ui.Utils.setDisplay(this.currentTime_, !this.ad.isLinear());
  62.         });
  64.     this.eventManager.listen(
  65.         this.adManager, shaka.ads.Utils.AD_STOPPED, () => {
  66.           shaka.ui.Utils.setDisplay(this.currentTime_, true);
  67.         });
  68.   }
  70.   /**
  71.    * @param {string} value
  72.    * @private
  73.    */
  74.   setValue_(value) {
  75.     // To avoid constant updates to the DOM, which makes debugging more
  76.     // difficult, only set the value if it has changed.  If we don't do this
  77.     // check, the DOM updates constantly, this element flashes in the debugger
  78.     // in Chrome, and you can't make changes in the CSS panel.
  79.     if (value != this.currentTime_.textContent) {
  80.       this.currentTime_.textContent = value;
  81.     }
  82.   }
  84.   /** @private */
  85.   updateTime_() {
  86.     const isSeeking = this.controls.isSeeking();
  87.     let displayTime = this.controls.getDisplayTime();
  88.     const seekRange = this.player.seekRange();
  89.     const seekRangeSize = seekRange.end - seekRange.start;
  90.     const Utils = shaka.ui.Utils;
  92.     if (!isFinite(seekRangeSize)) {
  93.       this.setValue_(this.localization.resolve(shaka.ui.Locales.Ids.LIVE));
  94.       this.currentTime_.disabled = true;
  95.     } else if (this.player.isLive()) {
  96.       // The amount of time we are behind the live edge.
  97.       const behindLive = Math.floor(seekRange.end - displayTime);
  98.       displayTime = Math.max(0, behindLive);
  100.       const showHour = seekRangeSize >= 3600;
  102.       // Consider "LIVE" when less than 1 second behind the live-edge.  Always
  103.       // show the full time string when seeking, including the leading '-';
  104.       // otherwise, the time string "flickers" near the live-edge.
  105.       // The button should only be clickable when it's live stream content, and
  106.       // the current play time is behind live edge.
  107.       if ((displayTime >= 1) || isSeeking) {
  108.         this.setValue_('- ' + Utils.buildTimeString(displayTime, showHour));
  109.         this.currentTime_.disabled = false;
  110.       } else {
  111.         this.setValue_(this.localization.resolve(shaka.ui.Locales.Ids.LIVE));
  112.         this.currentTime_.disabled = true;
  113.       }
  114.     } else {
  115.       const showHour = seekRangeSize >= 3600;
  117.       const currentTime = Math.max(0, displayTime - seekRange.start);
  118.       let value = Utils.buildTimeString(currentTime, showHour);
  119.       if (seekRangeSize) {
  120.         value += ' / ' + Utils.buildTimeString(seekRangeSize, showHour);
  121.       }
  122.       this.setValue_(value);
  123.       this.currentTime_.disabled = true;
  124.     }
  125.   }
  127.   /**
  128.    * Set the aria label to be 'Live' when the content is live stream.
  129.    * @private
  130.    */
  131.   onTracksChanged_() {
  132.     if (this.player.isLive()) {
  133.       const ariaLabel = shaka.ui.Locales.Ids.SKIP_TO_LIVE;
  134.       this.currentTime_.ariaLabel = this.localization.resolve(ariaLabel);
  135.     }
  136.   }
  137. };
  140. /**
  141.  * @implements {shaka.extern.IUIElement.Factory}
  142.  * @final
  143.  */
  144. shaka.ui.PresentationTimeTracker.Factory = class {
  145.   /** @override */
  146.   create(rootElement, controls) {
  147.     return new shaka.ui.PresentationTimeTracker(rootElement, controls);
  148.   }
  149. };
  151. shaka.ui.Controls.registerElement(
  152.     'time_and_duration', new shaka.ui.PresentationTimeTracker.Factory());