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.onCaptionStateChange_();
  69.       this.updateTextLanguages_();
  70.     });
  72.     this.eventManager.listen(this.player, 'loaded', () => {
  73.       this.onCaptionStateChange_();
  74.       this.updateTextLanguages_();
  75.     });
  77.     this.eventManager.listen(this.player, 'unloading', () => {
  78.       this.onCaptionStateChange_();
  79.       this.updateTextLanguages_();
  80.     });
  82.     this.eventManager.listen(this.player, 'texttrackvisibility', () => {
  83.       this.onCaptionStateChange_();
  84.       this.updateTextLanguages_();
  85.     });
  87.     this.eventManager.listen(this.player, 'textchanged', () => {
  88.       this.updateTextLanguages_();
  89.     });
  91.     this.eventManager.listen(this.player, 'trackschanged', () => {
  92.       this.updateTextLanguages_();
  93.     });
  95.     // Initialize caption state with a fake event.
  96.     this.onCaptionStateChange_();
  98.     // Set up all the strings in the user's preferred language.
  99.     this.updateLocalizedStrings_();
  101.     this.updateTextLanguages_();
  102.   }
  105.   /**
  106.    * @private
  107.    */
  108.   addOffOption_() {
  109.     const off = shaka.util.Dom.createButton();
  110.     off.ariaSelected = 'true';
  111.     this.menu.appendChild(off);
  113.     off.appendChild(shaka.ui.Utils.checkmarkIcon());
  115.     /** @private {!HTMLElement} */
  116.     this.captionsOffSpan_ = shaka.util.Dom.createHTMLElement('span');
  118.     off.appendChild(this.captionsOffSpan_);
  119.   }
  122.   /** @private */
  123.   onCaptionStateChange_() {
  124.     if (this.player.isTextTrackVisible()) {
  125.       this.icon.textContent =
  126.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS;
  127.       this.button.ariaPressed = 'true';
  128.     } else {
  129.       this.icon.textContent =
  130.           shaka.ui.Enums.MaterialDesignIcons.CLOSED_CAPTIONS_OFF;
  131.       this.button.ariaPressed = 'false';
  132.     }
  134.     this.controls.dispatchEvent(
  135.         new shaka.util.FakeEvent('captionselectionupdated'));
  136.   }
  138.   /** @private */
  139.   updateTextLanguages_() {
  140.     const tracks = this.player.getTextTracks() || [];
  142.     shaka.ui.LanguageUtils.updateTextTracks(tracks, this.menu,
  143.         (track) => this.onTextTrackSelected_(track),
  145.         // Don't mark current text language as chosen unless captions are
  146.         // enabled
  147.         this.player.isTextTrackVisible(),
  148.         this.currentSelection,
  149.         this.localization,
  150.         this.controls.getConfig().textTrackLabelFormat);
  152.     // Add the Off button
  153.     const offButton = shaka.util.Dom.createButton();
  154.     offButton.classList.add('shaka-turn-captions-off-button');
  155.     this.eventManager.listen(offButton, 'click', () => {
  156.       this.player.setTextTrackVisibility(false);
  157.       this.updateTextLanguages_();
  158.     });
  160.     offButton.appendChild(this.captionsOffSpan_);
  162.     this.menu.appendChild(offButton);
  164.     if (!this.player.isTextTrackVisible()) {
  165.       offButton.ariaSelected = 'true';
  166.       offButton.appendChild(shaka.ui.Utils.checkmarkIcon());
  167.       this.captionsOffSpan_.classList.add('shaka-chosen-item');
  168.       this.currentSelection.textContent =
  169.           this.localization.resolve(shaka.ui.Locales.Ids.OFF);
  170.     } else {
  171.       this.captionsOffSpan_.classList.remove('shaka-chosen-item');
  172.     }
  174.     this.button.setAttribute('shaka-status', this.currentSelection.textContent);
  176.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  178.     this.controls.dispatchEvent(
  179.         new shaka.util.FakeEvent('captionselectionupdated'));
  181.     shaka.ui.Utils.setDisplay(this.button, tracks.length > 0);
  182.   }
  185.   /**
  186.    * @param {!shaka.extern.TextTrack} track
  187.    * @return {!Promise}
  188.    * @private
  189.    */
  190.   async onTextTrackSelected_(track) {
  191.     // setTextTrackVisibility should be called after selectTextTrack.
  192.     // selectTextTrack sets a text stream, and setTextTrackVisibility(true)
  193.     // will set a text stream if it isn't already set. Consequently, reversing
  194.     // the order of these calls makes two languages display simultaneously
  195.     // if captions are turned off -> on in a different language.
  196.     this.player.selectTextTrack(track);
  197.     await this.player.setTextTrackVisibility(true);
  199.     // Set text preference for when reloading the stream (e.g. casting), keep
  200.     // this selection.
  201.     this.player.configure('preferredTextLanguage', track.language);
  202.     this.player.configure('preferForcedSubs', track.forced);
  203.   }
  206.   /**
  207.    * @private
  208.    */
  209.   updateLocalizedStrings_() {
  210.     const LocIds = shaka.ui.Locales.Ids;
  212.     this.button.ariaLabel = this.localization.resolve(LocIds.CAPTIONS);
  213.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  214.     this.nameSpan.textContent =
  215.         this.localization.resolve(LocIds.CAPTIONS);
  216.     this.backSpan.textContent =
  217.         this.localization.resolve(LocIds.CAPTIONS);
  218.     this.captionsOffSpan_.textContent =
  219.         this.localization.resolve(LocIds.OFF);
  220.   }
  221. };
  224. /**
  225.  * @implements {shaka.extern.IUIElement.Factory}
  226.  * @final
  227.  */
  228. shaka.ui.TextSelection.Factory = class {
  229.   /** @override */
  230.   create(rootElement, controls) {
  231.     return new shaka.ui.TextSelection(rootElement, controls);
  232.   }
  233. };
  235. shaka.ui.OverflowMenu.registerElement(
  236.     'captions', new shaka.ui.TextSelection.Factory());
  238. shaka.ui.Controls.registerElement(
  239.     'captions', new shaka.ui.TextSelection.Factory());