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, 'loading', () => {
  68.       this.onTracksChanged_();
  69.     });
  71.     this.eventManager.listen(this.player, 'texttrackvisibility', () => {
  72.       this.onCaptionStateChange_();
  73.       this.updateTextLanguages_();
  74.     });
  76.     this.eventManager.listen(this.player, 'textchanged', () => {
  77.       this.updateTextLanguages_();
  78.     });
  80.     this.eventManager.listen(this.player, 'trackschanged', () => {
  81.       this.onTracksChanged_();
  82.     });
  84.     // Initialize caption state with a fake event.
  85.     this.onCaptionStateChange_();
  87.     // Set up all the strings in the user's preferred language.
  88.     this.updateLocalizedStrings_();
  90.     this.updateTextLanguages_();
  92.     this.onTracksChanged_();
  93.   }
  96.   /**
  97.    * @private
  98.    */
  99.   addOffOption_() {
  100.     const off = shaka.util.Dom.createButton();
  101.     off.ariaSelected = 'true';
  102.     this.menu.appendChild(off);
  104.     off.appendChild(shaka.ui.Utils.checkmarkIcon());
  106.     /** @private {!HTMLElement} */
  107.     this.captionsOffSpan_ = shaka.util.Dom.createHTMLElement('span');
  109.     this.captionsOffSpan_.classList.add('shaka-auto-span');
  110.     off.appendChild(this.captionsOffSpan_);
  111.   }
  114.   /** @private */
  115.   onCaptionStateChange_() {
  116.     if (this.player.isTextTrackVisible()) {
  117.       this.icon.textContent =
  118.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS;
  119.       this.button.ariaPressed = 'true';
  120.     } else {
  121.       this.icon.textContent =
  122.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS_OFF;
  123.       this.button.ariaPressed = 'false';
  124.     }
  126.     this.controls.dispatchEvent(
  127.         new shaka.util.FakeEvent('captionselectionupdated'));
  128.   }
  130.   /** @private */
  131.   updateTextLanguages_() {
  132.     const tracks = this.player.getTextTracks();
  134.     shaka.ui.LanguageUtils.updateTextTracks(tracks, this.menu,
  135.         (track) => this.onTextTrackSelected_(track),
  137.         // Don't mark current text language as chosen unless captions are
  138.         // enabled
  139.         this.player.isTextTrackVisible(),
  140.         this.currentSelection,
  141.         this.localization,
  142.         this.controls.getConfig().textTrackLabelFormat);
  144.     // Add the Off button
  145.     const offButton = shaka.util.Dom.createButton();
  146.     offButton.classList.add('shaka-turn-captions-off-button');
  147.     this.eventManager.listen(offButton, 'click', () => {
  148.       this.player.setTextTrackVisibility(false);
  149.       this.updateTextLanguages_();
  150.     });
  152.     offButton.appendChild(this.captionsOffSpan_);
  154.     this.menu.appendChild(offButton);
  156.     if (!this.player.isTextTrackVisible()) {
  157.       offButton.ariaSelected = 'true';
  158.       offButton.appendChild(shaka.ui.Utils.checkmarkIcon());
  159.       this.captionsOffSpan_.classList.add('shaka-chosen-item');
  160.       this.currentSelection.textContent =
  161.           this.localization.resolve(shaka.ui.Locales.Ids.OFF);
  162.     }
  164.     this.button.setAttribute('shaka-status', this.currentSelection.textContent);
  166.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  168.     this.controls.dispatchEvent(
  169.         new shaka.util.FakeEvent('captionselectionupdated'));
  170.   }
  173.   /**
  174.    * @param {!shaka.extern.Track} track
  175.    * @return {!Promise}
  176.    * @private
  177.    */
  178.   async onTextTrackSelected_(track) {
  179.     // setTextTrackVisibility should be called after selectTextTrack.
  180.     // selectTextTrack sets a text stream, and setTextTrackVisibility(true)
  181.     // will set a text stream if it isn't already set. Consequently, reversing
  182.     // the order of these calls makes two languages display simultaneously
  183.     // if captions are turned off -> on in a different language.
  184.     this.player.selectTextTrack(track);
  185.     await this.player.setTextTrackVisibility(true);
  186.   }
  189.   /**
  190.    * @private
  191.    */
  192.   updateLocalizedStrings_() {
  193.     const LocIds = shaka.ui.Locales.Ids;
  195.     this.button.ariaLabel = this.localization.resolve(LocIds.CAPTIONS);
  196.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  197.     this.nameSpan.textContent =
  198.         this.localization.resolve(LocIds.CAPTIONS);
  199.     this.backSpan.textContent =
  200.         this.localization.resolve(LocIds.CAPTIONS);
  201.     this.captionsOffSpan_.textContent =
  202.         this.localization.resolve(LocIds.OFF);
  203.   }
  206.   /** @private */
  207.   onTracksChanged_() {
  208.     const hasText = this.player.getTextTracks().length > 0;
  209.     shaka.ui.Utils.setDisplay(this.button, hasText);
  210.     this.updateTextLanguages_();
  211.   }
  212. };
  215. /**
  216.  * @implements {shaka.extern.IUIElement.Factory}
  217.  * @final
  218.  */
  219. shaka.ui.TextSelection.Factory = class {
  220.   /** @override */
  221.   create(rootElement, controls) {
  222.     return new shaka.ui.TextSelection(rootElement, controls);
  223.   }
  224. };
  226. shaka.ui.OverflowMenu.registerElement(
  227.     'captions', new shaka.ui.TextSelection.Factory());
  229. shaka.ui.Controls.registerElement(
  230.     'captions', new shaka.ui.TextSelection.Factory());