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