Source: ui/text_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.TextSelection');
  10. goog.require('shaka.ui.Controls');
  11. goog.require('shaka.ui.Enums');
  12. goog.require('shaka.ui.LanguageUtils');
  13. goog.require('shaka.ui.Locales');
  14. goog.require('shaka.ui.Localization');
  15. goog.require('shaka.ui.OverflowMenu');
  16. goog.require('shaka.ui.SettingsMenu');
  17. goog.require('shaka.ui.Utils');
  18. goog.require('shaka.util.Dom');
  19. goog.require('shaka.util.FakeEvent');
  20. goog.requireType('shaka.ui.Controls');
  23. /**
  24.  * @extends {shaka.ui.SettingsMenu}
  25.  * @final
  26.  * @export
  27.  */
  28. shaka.ui.TextSelection = class extends shaka.ui.SettingsMenu {
  29.   /**
  30.    * @param {!HTMLElement} parent
  31.    * @param {!shaka.ui.Controls} controls
  32.    */
  33.   constructor(parent, controls) {
  34.     super(parent,
  35.         controls, shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS);
  37.     this.button.classList.add('shaka-caption-button');
  38.     this.button.classList.add('shaka-tooltip-status');
  39.     this.menu.classList.add('shaka-text-languages');
  41.     if (this.player && this.player.isTextTrackVisible()) {
  42.       this.button.ariaPressed = 'true';
  43.     } else {
  44.       this.button.ariaPressed = 'false';
  45.     }
  47.     this.addOffOption_();
  49.     this.eventManager.listen(
  50.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  51.           this.updateLocalizedStrings_();
  52.           // If captions/subtitles are off, this string needs localization.
  53.           // TODO: is there a more efficient way of updating just the strings
  54.           // we need instead of running the whole language update?
  55.           this.updateTextLanguages_();
  56.         });
  58.     this.eventManager.listen(
  59.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  60.           this.updateLocalizedStrings_();
  61.           // If captions/subtitles are off, this string needs localization.
  62.           // TODO: is there a more efficient way of updating just the strings
  63.           // we need instead of running the whole language update?
  64.           this.updateTextLanguages_();
  65.         });
  67.     this.eventManager.listen(this.player, 'texttrackvisibility', () => {
  68.       this.onCaptionStateChange_();
  69.       this.updateTextLanguages_();
  70.     });
  72.     this.eventManager.listen(this.player, 'textchanged', () => {
  73.       this.updateTextLanguages_();
  74.     });
  76.     this.eventManager.listen(this.player, 'trackschanged', () => {
  77.       this.onTracksChanged_();
  78.     });
  80.     // Initialize caption state with a fake event.
  81.     this.onCaptionStateChange_();
  83.     // Set up all the strings in the user's preferred language.
  84.     this.updateLocalizedStrings_();
  86.     this.updateTextLanguages_();
  88.     this.onTracksChanged_();
  89.   }
  92.   /**
  93.    * @private
  94.    */
  95.   addOffOption_() {
  96.     const off = shaka.util.Dom.createButton();
  97.     off.ariaSelected = 'true';
  98.     this.menu.appendChild(off);
  100.     off.appendChild(shaka.ui.Utils.checkmarkIcon());
  102.     /** @private {!HTMLElement} */
  103.     this.captionsOffSpan_ = shaka.util.Dom.createHTMLElement('span');
  105.     this.captionsOffSpan_.classList.add('shaka-auto-span');
  106.     off.appendChild(this.captionsOffSpan_);
  107.   }
  110.   /** @private */
  111.   onCaptionStateChange_() {
  112.     if (this.player.isTextTrackVisible()) {
  113.       this.icon.textContent =
  114.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS;
  115.       this.button.ariaPressed = 'true';
  116.     } else {
  117.       this.icon.textContent =
  118.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS_OFF;
  119.       this.button.ariaPressed = 'false';
  120.     }
  122.     this.controls.dispatchEvent(
  123.         new shaka.util.FakeEvent('captionselectionupdated'));
  124.   }
  126.   /** @private */
  127.   updateTextLanguages_() {
  128.     const tracks = this.player.getTextTracks();
  130.     shaka.ui.LanguageUtils.updateTracks(tracks, this.menu,
  131.         (track) => this.onTextTrackSelected_(track),
  133.         // Don't mark current text language as chosen unless captions are
  134.         // enabled
  135.         this.player.isTextTrackVisible(),
  136.         this.currentSelection,
  137.         this.localization,
  138.         this.controls.getConfig().trackLabelFormat);
  140.     // Add the Off button
  141.     const offButton = shaka.util.Dom.createButton();
  142.     offButton.classList.add('shaka-turn-captions-off-button');
  143.     this.eventManager.listen(offButton, 'click', () => {
  144.       this.player.setTextTrackVisibility(false);
  145.       this.updateTextLanguages_();
  146.     });
  148.     offButton.appendChild(this.captionsOffSpan_);
  150.     this.menu.appendChild(offButton);
  152.     if (!this.player.isTextTrackVisible()) {
  153.       offButton.ariaSelected = 'true';
  154.       offButton.appendChild(shaka.ui.Utils.checkmarkIcon());
  155.       this.captionsOffSpan_.classList.add('shaka-chosen-item');
  156.       this.currentSelection.textContent =
  157.           this.localization.resolve(shaka.ui.Locales.Ids.OFF);
  158.     }
  160.     this.button.setAttribute('shaka-status', this.currentSelection.textContent);
  162.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  164.     this.controls.dispatchEvent(
  165.         new shaka.util.FakeEvent('captionselectionupdated'));
  166.   }
  169.   /**
  170.    * @param {!shaka.extern.Track} track
  171.    * @return {!Promise}
  172.    * @private
  173.    */
  174.   async onTextTrackSelected_(track) {
  175.     // setTextTrackVisibility should be called after selectTextTrack.
  176.     // selectTextTrack sets a text stream, and setTextTrackVisiblity(true)
  177.     // will set a text stream if it isn't already set. Consequently, reversing
  178.     // the order of these calls makes two languages display simultaneously
  179.     // if captions are turned off -> on in a different language.
  180.     this.player.selectTextTrack(track);
  181.     await this.player.setTextTrackVisibility(true);
  182.   }
  185.   /**
  186.    * @private
  187.    */
  188.   updateLocalizedStrings_() {
  189.     const LocIds = shaka.ui.Locales.Ids;
  191.     this.button.ariaLabel = this.localization.resolve(LocIds.CAPTIONS);
  192.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  193.     this.nameSpan.textContent =
  194.         this.localization.resolve(LocIds.CAPTIONS);
  195.     this.backSpan.textContent =
  196.         this.localization.resolve(LocIds.CAPTIONS);
  197.     this.captionsOffSpan_.textContent =
  198.         this.localization.resolve(LocIds.OFF);
  199.   }
  202.   /** @private */
  203.   onTracksChanged_() {
  204.     const hasText = this.player.getTextTracks().length > 0;
  205.     shaka.ui.Utils.setDisplay(this.button, hasText);
  206.     this.updateTextLanguages_();
  207.   }
  208. };
  211. /**
  212.  * @implements {shaka.extern.IUIElement.Factory}
  213.  * @final
  214.  */
  215. shaka.ui.TextSelection.Factory = class {
  216.   /** @override */
  217.   create(rootElement, controls) {
  218.     return new shaka.ui.TextSelection(rootElement, controls);
  219.   }
  220. };
  222. shaka.ui.OverflowMenu.registerElement(
  223.     'captions', new shaka.ui.TextSelection.Factory());
  225. shaka.ui.Controls.registerElement(
  226.     'captions', new shaka.ui.TextSelection.Factory());