Source: ui/playback_rate_selection.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.PlaybackRateSelection');
  10. goog.require('shaka.ui.Controls');
  11. goog.require('shaka.ui.Enums');
  12. goog.require('shaka.ui.Locales');
  13. goog.require('shaka.ui.Localization');
  14. goog.require('shaka.ui.OverflowMenu');
  15. goog.require('shaka.ui.SettingsMenu');
  16. goog.require('shaka.ui.Utils');
  17. goog.require('shaka.util.Dom');
  18. goog.requireType('shaka.ui.Controls');
  20. /**
  21.  * @extends {shaka.ui.SettingsMenu}
  22.  * @final
  23.  * @export
  24.  */
  25. shaka.ui.PlaybackRateSelection = class extends shaka.ui.SettingsMenu {
  26.   /**
  27.    * @param {!HTMLElement} parent
  28.    * @param {!shaka.ui.Controls} controls
  29.    */
  30.   constructor(parent, controls) {
  31.     super(parent, controls, shaka.ui.Enums.MaterialDesignIcons.PLAYBACK_RATE);
  33.     this.button.classList.add('shaka-playbackrate-button');
  34.     this.menu.classList.add('shaka-playback-rates');
  35.     this.button.classList.add('shaka-tooltip-status');
  37.     this.eventManager.listen(
  38.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  39.           this.updateLocalizedStrings_();
  40.         });
  42.     this.eventManager.listen(
  43.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  44.           this.updateLocalizedStrings_();
  45.         });
  47.     this.eventManager.listen(this.player, 'loaded', () => {
  48.       this.updatePlaybackRateSelection_();
  49.     });
  51.     this.eventManager.listen(this.player, 'ratechange', () => {
  52.       this.updatePlaybackRateSelection_();
  53.     });
  55.     // Set up all the strings in the user's preferred language.
  56.     this.updateLocalizedStrings_();
  57.     this.addPlaybackRates_();
  58.     this.updatePlaybackRateSelection_();
  59.   }
  61.   /**
  62.    * @private
  63.    */
  64.   updateLocalizedStrings_() {
  65.     const LocIds = shaka.ui.Locales.Ids;
  67.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  68.     this.button.ariaLabel = this.localization.resolve(LocIds.PLAYBACK_RATE);
  69.     this.nameSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  70.     this.backSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  71.   }
  73.   /**
  74.    * Update checkmark icon and related class and attribute for the chosen rate
  75.    * button.
  76.    * @private
  77.    */
  78.   updatePlaybackRateSelection_() {
  79.     const rate = this.player.getPlaybackRate();
  80.     // Remove the old checkmark icon and related tags and classes if it exists.
  81.     const checkmarkIcon = shaka.ui.Utils.getDescendantIfExists(
  82.         this.menu, 'material-icons-round shaka-chosen-item');
  83.     if (checkmarkIcon) {
  84.       const previouslySelectedButton = checkmarkIcon.parentElement;
  85.       previouslySelectedButton.removeAttribute('aria-selected');
  86.       const previouslySelectedSpan =
  87.           previouslySelectedButton.getElementsByTagName('span')[0];
  88.       previouslySelectedSpan.classList.remove('shaka-chosen-item');
  89.       previouslySelectedButton.removeChild(checkmarkIcon);
  90.     }
  91.     // Find the button that represents the newly selected playback rate.
  92.     // Add the checkmark icon, related tags and classes to the newly selected
  93.     // button.
  94.     const span = Array.from(this.menu.querySelectorAll('span')).find((el) => {
  95.       return el.textContent == (rate + 'x');
  96.     });
  97.     if (span) {
  98.       const button = span.parentElement;
  99.       button.appendChild(shaka.ui.Utils.checkmarkIcon());
  100.       button.ariaSelected = 'true';
  101.       span.classList.add('shaka-chosen-item');
  102.     }
  104.     // Set the label to display the current playback rate in the overflow menu,
  105.     // in the format of '1x', '1.5x', etc.
  106.     this.currentSelection.textContent = rate + 'x';
  107.     this.button.setAttribute('shaka-status', rate + 'x');
  108.   }
  110.   /** @private */
  111.   addPlaybackRates_() {
  112.     for (const rate of this.controls.getConfig().playbackRates) {
  113.       const button = shaka.util.Dom.createButton();
  114.       const span = shaka.util.Dom.createHTMLElement('span');
  115.       span.textContent = rate + 'x';
  116.       button.appendChild(span);
  118.       this.eventManager.listen(button, 'click', () => {
  119.         if (rate == this.video.defaultPlaybackRate) {
  120.           this.player.cancelTrickPlay();
  121.         } else {
  122.           this.player.trickPlay(rate, /* useTrickPlayTrack= */ false);
  123.         }
  124.       });
  126.       this.menu.appendChild(button);
  127.     }
  128.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  129.   }
  130. };
  132. /**
  133.  * @implements {shaka.extern.IUIElement.Factory}
  134.  * @final
  135.  */
  136. shaka.ui.PlaybackRateSelection.Factory = class {
  137.   /** @override */
  138.   create(rootElement, controls) {
  139.     return new shaka.ui.PlaybackRateSelection(rootElement, controls);
  140.   }
  141. };
  143. shaka.ui.OverflowMenu.registerElement(
  144.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());
  146. shaka.ui.Controls.registerElement(
  147.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());