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.     if (!Array.from(parent.classList).includes('shaka-overflow-menu')) {
  38.       this.playbackRateMark = shaka.util.Dom.createHTMLElement('span');
  39.       this.playbackRateMark.classList.add('shaka-overflow-playback-rate-mark');
  40.       this.button.appendChild(this.playbackRateMark);
  41.     }
  43.     this.eventManager.listen(
  44.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  45.           this.updateLocalizedStrings_();
  46.         });
  48.     this.eventManager.listen(
  49.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  50.           this.updateLocalizedStrings_();
  51.         });
  53.     this.eventManager.listen(this.player, 'loaded', () => {
  54.       this.updatePlaybackRateSelection_();
  55.     });
  57.     this.eventManager.listen(this.player, 'ratechange', () => {
  58.       this.updatePlaybackRateSelection_();
  59.     });
  61.     // Set up all the strings in the user's preferred language.
  62.     this.updateLocalizedStrings_();
  63.     this.addPlaybackRates_();
  64.     this.updatePlaybackRateSelection_();
  65.   }
  67.   /**
  68.    * @private
  69.    */
  70.   updateLocalizedStrings_() {
  71.     const LocIds = shaka.ui.Locales.Ids;
  73.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  74.     this.button.ariaLabel = this.localization.resolve(LocIds.PLAYBACK_RATE);
  75.     this.nameSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  76.     this.backSpan.textContent = this.localization.resolve(LocIds.PLAYBACK_RATE);
  77.   }
  79.   /**
  80.    * Update checkmark icon and related class and attribute for the chosen rate
  81.    * button.
  82.    * @private
  83.    */
  84.   updatePlaybackRateSelection_() {
  85.     const rate = this.player.getPlaybackRate();
  86.     // Remove the old checkmark icon and related tags and classes if it exists.
  87.     const checkmarkIcon = shaka.ui.Utils.getDescendantIfExists(
  88.         this.menu, 'material-icons-round shaka-chosen-item');
  89.     if (checkmarkIcon) {
  90.       const previouslySelectedButton = checkmarkIcon.parentElement;
  91.       previouslySelectedButton.removeAttribute('aria-selected');
  92.       const previouslySelectedSpan =
  93.           previouslySelectedButton.getElementsByTagName('span')[0];
  94.       previouslySelectedSpan.classList.remove('shaka-chosen-item');
  95.       previouslySelectedButton.removeChild(checkmarkIcon);
  96.     }
  97.     // Find the button that represents the newly selected playback rate.
  98.     // Add the checkmark icon, related tags and classes to the newly selected
  99.     // button.
  100.     const span = Array.from(this.menu.querySelectorAll('span')).find((el) => {
  101.       return el.textContent == (rate + 'x');
  102.     });
  103.     if (span) {
  104.       const button = span.parentElement;
  105.       button.appendChild(shaka.ui.Utils.checkmarkIcon());
  106.       button.ariaSelected = 'true';
  107.       span.classList.add('shaka-chosen-item');
  108.     }
  110.     // Set the label to display the current playback rate in the overflow menu,
  111.     // in the format of '1x', '1.5x', etc.
  112.     this.currentSelection.textContent = rate + 'x';
  113.     this.button.setAttribute('shaka-status', rate + 'x');
  114.     if (this.playbackRateMark) {
  115.       this.playbackRateMark.textContent = rate + 'x';
  116.     }
  117.   }
  119.   /** @private */
  120.   addPlaybackRates_() {
  121.     for (const rate of this.controls.getConfig().playbackRates) {
  122.       const button = shaka.util.Dom.createButton();
  123.       const span = shaka.util.Dom.createHTMLElement('span');
  124.       span.textContent = rate + 'x';
  125.       button.appendChild(span);
  127.       this.eventManager.listen(button, 'click', () => {
  128.         if (rate == this.video.defaultPlaybackRate) {
  129.           this.player.cancelTrickPlay();
  130.         } else {
  131.           this.player.trickPlay(rate, /* useTrickPlayTrack= */ false);
  132.         }
  133.       });
  135.       this.menu.appendChild(button);
  136.     }
  137.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  138.   }
  139. };
  141. /**
  142.  * @implements {shaka.extern.IUIElement.Factory}
  143.  * @final
  144.  */
  145. shaka.ui.PlaybackRateSelection.Factory = class {
  146.   /** @override */
  147.   create(rootElement, controls) {
  148.     return new shaka.ui.PlaybackRateSelection(rootElement, controls);
  149.   }
  150. };
  152. shaka.ui.OverflowMenu.registerElement(
  153.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());
  155. shaka.ui.Controls.registerElement(
  156.     'playback_rate', new shaka.ui.PlaybackRateSelection.Factory());