Source: ui/loop_button.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.LoopButton');
  10. goog.require('shaka.ui.ContextMenu');
  11. goog.require('shaka.ui.Controls');
  12. goog.require('shaka.ui.Element');
  13. goog.require('shaka.ui.Enums');
  14. goog.require('shaka.ui.Locales');
  15. goog.require('shaka.ui.Localization');
  16. goog.require('shaka.ui.OverflowMenu');
  17. goog.require('shaka.util.Dom');
  18. goog.require('shaka.util.Timer');
  19. goog.requireType('shaka.ui.Controls');
  22. /**
  23.  * @extends {shaka.ui.Element}
  24.  * @final
  25.  * @export
  26.  */
  27. shaka.ui.LoopButton = class extends shaka.ui.Element {
  28.   /**
  29.    * @param {!HTMLElement} parent
  30.    * @param {!shaka.ui.Controls} controls
  31.    */
  32.   constructor(parent, controls) {
  33.     super(parent, controls);
  35.     const LocIds = shaka.ui.Locales.Ids;
  36.     /** @private {!HTMLButtonElement} */
  37.     this.button_ = shaka.util.Dom.createButton();
  38.     this.button_.classList.add('shaka-loop-button');
  39.     this.button_.classList.add('shaka-tooltip');
  41.     /** @private {!HTMLElement} */
  42.     this.icon_ = shaka.util.Dom.createHTMLElement('i');
  43.     this.icon_.classList.add('material-icons-round');
  44.     this.icon_.textContent = shaka.ui.Enums.MaterialDesignIcons.LOOP;
  45.     this.button_.appendChild(this.icon_);
  47.     const label = shaka.util.Dom.createHTMLElement('label');
  48.     label.classList.add('shaka-overflow-button-label');
  49.     label.classList.add('shaka-overflow-menu-only');
  50.     this.nameSpan_ = shaka.util.Dom.createHTMLElement('span');
  51.     this.nameSpan_.textContent = this.localization.resolve(LocIds.LOOP);
  52.     label.appendChild(this.nameSpan_);
  54.     /** @private {!HTMLElement} */
  55.     this.currentState_ = shaka.util.Dom.createHTMLElement('span');
  56.     this.currentState_.classList.add('shaka-current-selection-span');
  57.     label.appendChild(this.currentState_);
  59.     this.button_.appendChild(label);
  61.     this.updateLocalizedStrings_();
  63.     this.parent.appendChild(this.button_);
  65.     this.eventManager.listen(
  66.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  67.           this.updateLocalizedStrings_();
  68.         });
  70.     this.eventManager.listen(
  71.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  72.           this.updateLocalizedStrings_();
  73.         });
  75.     this.eventManager.listen(this.button_, 'click', () => {
  76.       if (!this.controls.isOpaque()) {
  77.         return;
  78.       }
  79.       this.onClick_();
  80.     });
  82.     /** @private {boolean} */
  83.     this.loopEnabled_ = this.video.loop;
  85.     // No event is fired when the video.loop property changes, so
  86.     // in order to detect a manual change to the property, we have
  87.     // two options:
  88.     // 1) set an observer that gets triggered every time the video
  89.     // object is mutated and check is the loop property was changed.
  90.     // 2) create a timer that checks the state of the loop property
  91.     // regularly.
  92.     // I (ismena) opted to go for #2 as at least video.currentTime
  93.     // will be changing constantly during playback, to say nothing
  94.     // about other video properties. I expect the timer to be less
  95.     // of a performance hit.
  96.     /**
  97.      * The timer that tracks down the ad progress.
  98.      *
  99.      * @private {shaka.util.Timer}
  100.      */
  101.     this.timer_ = new shaka.util.Timer(() => {
  102.       this.onTimerTick_();
  103.     });
  105.     this.timer_.tickEvery(1);
  106.   }
  108.   /**
  109.    * @override
  110.    */
  111.   release() {
  112.     this.timer_.stop();
  113.     this.timer_ = null;
  114.     super.release();
  115.   }
  118.   /** @private */
  119.   onClick_() {
  120.     this.video.loop = !this.video.loop;
  121.     this.timer_.tickNow();
  122.     this.timer_.tickEvery(1);
  123.   }
  126.   /** @private */
  127.   onTimerTick_() {
  128.     if (this.loopEnabled_ == this.video.loop) {
  129.       return;
  130.     }
  132.     this.updateLocalizedStrings_();
  133.     this.loopEnabled_ = this.video.loop;
  134.   }
  137.   /**
  138.    * @private
  139.    */
  140.   updateLocalizedStrings_() {
  141.     const LocIds = shaka.ui.Locales.Ids;
  142.     const Icons = shaka.ui.Enums.MaterialDesignIcons;
  144.     this.nameSpan_.textContent =
  145.         this.localization.resolve(LocIds.LOOP);
  147.     const labelText = this.video.loop ? LocIds.ON : LocIds.OFF;
  149.     this.currentState_.textContent = this.localization.resolve(labelText);
  151.     const icon = this.video.loop ? Icons.UNLOOP : Icons.LOOP;
  153.     this.icon_.textContent = icon;
  155.     const ariaText = this.video.loop ?
  156.         LocIds.EXIT_LOOP_MODE : LocIds.ENTER_LOOP_MODE;
  158.     this.button_.ariaLabel = this.localization.resolve(ariaText);
  159.   }
  160. };
  163. /**
  164.  * @implements {shaka.extern.IUIElement.Factory}
  165.  * @final
  166.  */
  167. shaka.ui.LoopButton.Factory = class {
  168.   /** @override */
  169.   create(rootElement, controls) {
  170.     return new shaka.ui.LoopButton(rootElement, controls);
  171.   }
  172. };
  174. shaka.ui.OverflowMenu.registerElement(
  175.     'loop', new shaka.ui.LoopButton.Factory());
  177. shaka.ui.Controls.registerElement(
  178.     'loop', new shaka.ui.LoopButton.Factory());
  180. shaka.ui.ContextMenu.registerElement(
  181.     'loop', new shaka.ui.LoopButton.Factory());