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.Enums');
  11. goog.require('shaka.ui.LanguageUtils');
  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.require('shaka.util.FakeEvent');
  19. goog.requireType('shaka.ui.Controls');
  22. /**
  23.  * @extends {shaka.ui.SettingsMenu}
  24.  * @final
  25.  * @export
  26.  */
  27. shaka.ui.TextSelection = class extends shaka.ui.SettingsMenu {
  28.   /**
  29.    * @param {!HTMLElement} parent
  30.    * @param {!shaka.ui.Controls} controls
  31.    */
  32.   constructor(parent, controls) {
  33.     super(parent,
  34.         controls, shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS);
  36.     this.button.classList.add('shaka-caption-button');
  37.     this.menu.classList.add('shaka-text-languages');
  39.     if (this.player && this.player.isTextTrackVisible()) {
  40.       this.button.ariaPressed = 'true';
  41.     } else {
  42.       this.button.ariaPressed = 'false';
  43.     }
  45.     this.addOffOption_();
  47.     this.eventManager.listen(
  48.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  49.           this.updateLocalizedStrings_();
  50.           // If captions/subtitles are off, this string needs localization.
  51.           // TODO: is there a more efficient way of updating just the strings
  52.           // we need instead of running the whole language update?
  53.           this.updateTextLanguages_();
  54.         });
  56.     this.eventManager.listen(
  57.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  58.           this.updateLocalizedStrings_();
  59.           // If captions/subtitles are off, this string needs localization.
  60.           // TODO: is there a more efficient way of updating just the strings
  61.           // we need instead of running the whole language update?
  62.           this.updateTextLanguages_();
  63.         });
  65.     this.eventManager.listen(this.player, 'texttrackvisibility', () => {
  66.       this.onCaptionStateChange_();
  67.     });
  69.     this.eventManager.listen(this.player, 'textchanged', () => {
  70.       this.updateTextLanguages_();
  71.     });
  73.     this.eventManager.listen(this.player, 'trackschanged', () => {
  74.       this.onTracksChanged_();
  75.     });
  77.     // Initialize caption state with a fake event.
  78.     this.onCaptionStateChange_();
  80.     // Set up all the strings in the user's preferred language.
  81.     this.updateLocalizedStrings_();
  83.     this.updateTextLanguages_();
  85.     this.onTracksChanged_();
  86.   }
  89.   /**
  90.    * @private
  91.    */
  92.   addOffOption_() {
  93.     const off = shaka.util.Dom.createButton();
  94.     off.ariaSelected = 'true';
  95.     this.menu.appendChild(off);
  97.     off.appendChild(shaka.ui.Utils.checkmarkIcon());
  99.     /** @private {!HTMLElement} */
  100.     this.captionsOffSpan_ = shaka.util.Dom.createHTMLElement('span');
  102.     this.captionsOffSpan_.classList.add('shaka-auto-span');
  103.     off.appendChild(this.captionsOffSpan_);
  104.   }
  107.   /** @private */
  108.   onCaptionStateChange_() {
  109.     if (this.player.isTextTrackVisible()) {
  110.       this.icon.classList.add('shaka-captions-on');
  111.       this.icon.classList.remove('shaka-captions-off');
  112.       this.button.ariaPressed = 'true';
  113.     } else {
  114.       this.icon.classList.add('shaka-captions-off');
  115.       this.icon.classList.remove('shaka-captions-on');
  116.       this.button.ariaPressed = 'false';
  117.     }
  119.     this.controls.dispatchEvent(
  120.         new shaka.util.FakeEvent('captionselectionupdated'));
  121.   }
  123.   /** @private */
  124.   updateTextLanguages_() {
  125.     const tracks = this.player.getTextTracks();
  127.     shaka.ui.LanguageUtils.updateTracks(tracks, this.menu,
  128.         (track) => this.onTextTrackSelected_(track),
  130.         // Don't mark current text language as chosen unless captions are
  131.         // enabled
  132.         this.player.isTextTrackVisible(),
  133.         this.currentSelection,
  134.         this.localization,
  135.         this.controls.getConfig().trackLabelFormat);
  137.     // Add the Off button
  138.     const offButton = shaka.util.Dom.createButton();
  139.     offButton.classList.add('shaka-turn-captions-off-button');
  140.     this.eventManager.listen(offButton, 'click', () => {
  141.       this.player.setTextTrackVisibility(false);
  142.       this.updateTextLanguages_();
  143.     });
  145.     offButton.appendChild(this.captionsOffSpan_);
  147.     this.menu.appendChild(offButton);
  149.     if (!this.player.isTextTrackVisible()) {
  150.       offButton.ariaSelected = 'true';
  151.       offButton.appendChild(shaka.ui.Utils.checkmarkIcon());
  152.       this.captionsOffSpan_.classList.add('shaka-chosen-item');
  153.       this.currentSelection.textContent =
  154.           this.localization.resolve(shaka.ui.Locales.Ids.OFF);
  155.     }
  157.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  159.     this.controls.dispatchEvent(
  160.         new shaka.util.FakeEvent('captionselectionupdated'));
  161.   }
  164.   /**
  165.    * @param {!shaka.extern.Track} track
  166.    * @return {!Promise}
  167.    * @private
  168.    */
  169.   async onTextTrackSelected_(track) {
  170.     // setTextTrackVisibility should be called after selectTextTrack.
  171.     // selectTextTrack sets a text stream, and setTextTrackVisiblity(true)
  172.     // will set a text stream if it isn't already set. Consequently, reversing
  173.     // the order of these calls makes two languages display simultaneously
  174.     // if captions are turned off -> on in a different language.
  175.     this.player.selectTextTrack(track);
  176.     await this.player.setTextTrackVisibility(true);
  177.   }
  180.   /**
  181.    * @private
  182.    */
  183.   updateLocalizedStrings_() {
  184.     const LocIds = shaka.ui.Locales.Ids;
  186.     this.button.ariaLabel = this.localization.resolve(LocIds.CAPTIONS);
  187.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  188.     this.nameSpan.textContent =
  189.         this.localization.resolve(LocIds.CAPTIONS);
  190.     this.backSpan.textContent =
  191.         this.localization.resolve(LocIds.CAPTIONS);
  192.     this.captionsOffSpan_.textContent =
  193.         this.localization.resolve(LocIds.OFF);
  194.   }
  197.   /** @private */
  198.   onTracksChanged_() {
  199.     const hasText = this.player.getTextTracks().length > 0;
  200.     shaka.ui.Utils.setDisplay(this.button, hasText);
  201.     this.updateTextLanguages_();
  202.   }
  203. };
  206. /**
  207.  * @implements {shaka.extern.IUIElement.Factory}
  208.  * @final
  209.  */
  210. shaka.ui.TextSelection.Factory = class {
  211.   /** @override */
  212.   create(rootElement, controls) {
  213.     return new shaka.ui.TextSelection(rootElement, controls);
  214.   }
  215. };
  217. shaka.ui.OverflowMenu.registerElement(
  218.     'captions', new shaka.ui.TextSelection.Factory());