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.     label.classList.add('shaka-simple-overflow-button-label-inline');
  51.     this.nameSpan_ = shaka.util.Dom.createHTMLElement('span');
  52.     this.nameSpan_.textContent = this.localization.resolve(LocIds.LOOP);
  53.     label.appendChild(this.nameSpan_);
  55.     /** @private {!HTMLElement} */
  56.     this.currentState_ = shaka.util.Dom.createHTMLElement('span');
  57.     this.currentState_.classList.add('shaka-current-selection-span');
  58.     label.appendChild(this.currentState_);
  60.     this.button_.appendChild(label);
  62.     this.updateLocalizedStrings_();
  64.     this.parent.appendChild(this.button_);
  66.     this.eventManager.listen(
  67.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  68.           this.updateLocalizedStrings_();
  69.         });
  71.     this.eventManager.listen(
  72.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  73.           this.updateLocalizedStrings_();
  74.         });
  76.     this.eventManager.listen(this.button_, 'click', () => {
  77.       if (!this.controls.isOpaque()) {
  78.         return;
  79.       }
  80.       this.onClick_();
  81.     });
  83.     /** @private {boolean} */
  84.     this.loopEnabled_ = this.video.loop;
  86.     // No event is fired when the video.loop property changes, so
  87.     // in order to detect a manual change to the property, we have
  88.     // two options:
  89.     // 1) set an observer that gets triggered every time the video
  90.     // object is mutated and check is the loop property was changed.
  91.     // 2) create a timer that checks the state of the loop property
  92.     // regularly.
  93.     // I (ismena) opted to go for #2 as at least video.currentTime
  94.     // will be changing constantly during playback, to say nothing
  95.     // about other video properties. I expect the timer to be less
  96.     // of a performance hit.
  97.     /**
  98.      * The timer that tracks down the ad progress.
  99.      *
  100.      * @private {shaka.util.Timer}
  101.      */
  102.     this.timer_ = new shaka.util.Timer(() => {
  103.       this.onTimerTick_();
  104.     });
  106.     this.timer_.tickEvery(1);
  107.   }
  109.   /**
  110.    * @override
  111.    */
  112.   release() {
  113.     this.timer_.stop();
  114.     this.timer_ = null;
  115.     super.release();
  116.   }
  119.   /** @private */
  120.   onClick_() {
  121.     this.video.loop = !this.video.loop;
  122.     this.timer_.tickNow();
  123.     this.timer_.tickEvery(1);
  124.   }
  127.   /** @private */
  128.   onTimerTick_() {
  129.     if (this.loopEnabled_ == this.video.loop) {
  130.       return;
  131.     }
  133.     this.updateLocalizedStrings_();
  134.     this.loopEnabled_ = this.video.loop;
  135.   }
  138.   /**
  139.    * @private
  140.    */
  141.   updateLocalizedStrings_() {
  142.     const LocIds = shaka.ui.Locales.Ids;
  143.     const Icons = shaka.ui.Enums.MaterialDesignIcons;
  145.     this.nameSpan_.textContent =
  146.         this.localization.resolve(LocIds.LOOP);
  148.     const labelText = this.video.loop ? LocIds.ON : LocIds.OFF;
  150.     this.currentState_.textContent = this.localization.resolve(labelText);
  152.     const icon = this.video.loop ? Icons.UNLOOP : Icons.LOOP;
  154.     this.icon_.textContent = icon;
  156.     const ariaText = this.video.loop ?
  157.         LocIds.EXIT_LOOP_MODE : LocIds.ENTER_LOOP_MODE;
  159.     this.button_.ariaLabel = this.localization.resolve(ariaText);
  160.   }
  161. };
  164. /**
  165.  * @implements {shaka.extern.IUIElement.Factory}
  166.  * @final
  167.  */
  168. shaka.ui.LoopButton.Factory = class {
  169.   /** @override */
  170.   create(rootElement, controls) {
  171.     return new shaka.ui.LoopButton(rootElement, controls);
  172.   }
  173. };
  175. shaka.ui.OverflowMenu.registerElement(
  176.     'loop', new shaka.ui.LoopButton.Factory());
  178. shaka.ui.Controls.registerElement(
  179.     'loop', new shaka.ui.LoopButton.Factory());
  181. shaka.ui.ContextMenu.registerElement(
  182.     'loop', new shaka.ui.LoopButton.Factory());