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_(this.player.getPlaybackRate());
  49.     });
  51.     this.eventManager.listen(this.player, 'ratechange', () => {
  52.       this.updatePlaybackRateSelection_(this.player.getPlaybackRate());
  53.     });
  55.     /** @type {!Map.<string, number>} */
  56.     this.playbackRates_ = new Map(this.controls.getConfig().playbackRates
  57.         .map((rate) => [rate + 'x', rate]));
  59.     // Set up all the strings in the user's preferred language.
  60.     this.updateLocalizedStrings_();
  61.     this.addPlaybackRates_();
  62.     this.updatePlaybackRateSelection_(this.player.getPlaybackRate());
  63.   }
  65.   /**
  66.    * @private
  67.    */
  68.   updateLocalizedStrings_() {
  69.     const LocIds = shaka.ui.Locales.Ids;
  71.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  72.     this.button.ariaLabel = this.localization.resolve(LocIds.PLAYBACK_RATE);
  73.     this.nameSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  74.     this.backSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  75.   }
  77.   /**
  78.    * Update checkmark icon and related class and attribute for the chosen rate
  79.    * button.
  80.    * @param {number} rate The video playback rate.
  81.    * @private
  82.    */
  83.   updatePlaybackRateSelection_(rate) {
  84.     // Remove the old checkmark icon and related tags and classes if it exists.
  85.     const checkmarkIcon = shaka.ui.Utils.getDescendantIfExists(
  86.         this.menu, 'material-icons-round shaka-chosen-item');
  87.     if (checkmarkIcon) {
  88.       const previouslySelectedButton = checkmarkIcon.parentElement;
  89.       previouslySelectedButton.removeAttribute('aria-selected');
  90.       const previouslySelectedSpan =
  91.           previouslySelectedButton.getElementsByTagName('span')[0];
  92.       previouslySelectedSpan.classList.remove('shaka-chosen-item');
  93.       previouslySelectedButton.removeChild(checkmarkIcon);
  94.     }
  95.     // Find the button that represents the newly selected playback rate.
  96.     // Add the checkmark icon, related tags and classes to the newly selected
  97.     // button.
  98.     const span = Array.from(this.menu.querySelectorAll('span')).find((el) => {
  99.       return this.playbackRates_.get(el.textContent) == rate;
  100.     });
  101.     if (span) {
  102.       const button = span.parentElement;
  103.       button.appendChild(shaka.ui.Utils.checkmarkIcon());
  104.       button.ariaSelected = 'true';
  105.       span.classList.add('shaka-chosen-item');
  106.     }
  108.     // Set the label to display the current playback rate in the overflow menu,
  109.     // in the format of '1x', '1.5x', etc.
  110.     this.currentSelection.textContent = rate + 'x';
  111.     this.button.setAttribute('shaka-status', rate + 'x');
  112.   }
  114.   /** @private */
  115.   addPlaybackRates_() {
  116.     for (const rateStr of this.playbackRates_.keys()) {
  117.       const button = shaka.util.Dom.createButton();
  118.       const span = shaka.util.Dom.createHTMLElement('span');
  119.       span.textContent = rateStr;
  120.       button.appendChild(span);
  122.       this.eventManager.listen(button, 'click', () => {
  123.         this.video.playbackRate = this.playbackRates_.get(rateStr);
  124.         this.video.defaultPlaybackRate = this.playbackRates_.get(rateStr);
  125.       });
  127.       this.menu.appendChild(button);
  128.     }
  129.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  130.   }
  131. };
  133. /**
  134.  * @implements {shaka.extern.IUIElement.Factory}
  135.  * @final
  136.  */
  137. shaka.ui.PlaybackRateSelection.Factory = class {
  138.   /** @override */
  139.   create(rootElement, controls) {
  140.     return new shaka.ui.PlaybackRateSelection(rootElement, controls);
  141.   }
  142. };
  144. shaka.ui.OverflowMenu.registerElement(
  145.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());
  147. shaka.ui.Controls.registerElement(
  148.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());