Source: ui/audio_language_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.AudioLanguageSelection');
  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.FakeEvent');
  19. goog.requireType('shaka.ui.Controls');
  21. /**
  22.  * @extends {shaka.ui.SettingsMenu}
  23.  * @final
  24.  * @export
  25.  */
  26. shaka.ui.AudioLanguageSelection = class extends shaka.ui.SettingsMenu {
  27.   /**
  28.    * @param {!HTMLElement} parent
  29.    * @param {!shaka.ui.Controls} controls
  30.    */
  31.   constructor(parent, controls) {
  32.     super(parent, controls, shaka.ui.Enums.MaterialDesignIcons.LANGUAGE);
  34.     this.button.classList.add('shaka-language-button');
  35.     this.button.classList.add('shaka-tooltip-status');
  36.     this.menu.classList.add('shaka-audio-languages');
  38.     this.eventManager.listen(
  39.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  40.           this.updateLocalizedStrings_();
  41.         });
  43.     this.eventManager.listen(
  44.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  45.           this.updateLocalizedStrings_();
  46.         });
  49.     this.eventManager.listen(this.player, 'loading', () => {
  50.       this.onAudioTracksChanged_();
  51.     });
  53.     this.eventManager.listen(this.player, 'loaded', () => {
  54.       this.onAudioTracksChanged_();
  55.     });
  57.     this.eventManager.listen(this.player, 'unloading', () => {
  58.       this.onAudioTracksChanged_();
  59.     });
  61.     this.eventManager.listen(this.player, 'audiotrackschanged', () => {
  62.       this.onAudioTracksChanged_();
  63.     });
  65.     // Set up all the strings in the user's preferred language.
  66.     this.updateLocalizedStrings_();
  68.     this.onAudioTracksChanged_();
  69.   }
  72.   /** @private */
  73.   onAudioTracksChanged_() {
  74.     const audioTracks = this.player.getAudioTracks() || [];
  76.     shaka.ui.LanguageUtils.updateAudioTracks(audioTracks, this.menu,
  77.         (track) => this.onAudioTrackSelected_(track),
  78.         /* updateChosen= */ true, this.currentSelection, this.localization,
  79.         this.controls.getConfig().trackLabelFormat,
  80.         this.controls.getConfig().showAudioChannelCountVariants,
  81.         this.controls.getConfig().showAudioCodec);
  82.     shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  84.     this.controls.dispatchEvent(
  85.         new shaka.util.FakeEvent('languageselectionupdated'));
  87.     this.button.setAttribute('shaka-status', this.currentSelection.innerText);
  89.     const numberOfItems = this.menu.getElementsByTagName('button').length;
  90.     shaka.ui.Utils.setDisplay(this.button, numberOfItems > 2);
  91.   }
  93.   /**
  94.    * @param {!shaka.extern.AudioTrack} audioTrack
  95.    * @private
  96.    */
  97.   onAudioTrackSelected_(audioTrack) {
  98.     this.player.selectAudioTrack(audioTrack);
  100.     // Set audio preference for when reloading the stream (e.g. casting), keep
  101.     // this selection.
  102.     this.player.configure('preferredAudioLanguage', audioTrack.language);
  103.     if (audioTrack.label) {
  104.       this.player.configure('preferredAudioLabel', audioTrack.label);
  105.     }
  106.     if (audioTrack.channelsCount) {
  107.       this.player.configure('preferredAudioChannelCount',
  108.           audioTrack.channelsCount);
  109.     }
  110.     this.player.configure('preferSpatialAudio', audioTrack.spatialAudio);
  111.   }
  114.   /**
  115.    * @private
  116.    */
  117.   updateLocalizedStrings_() {
  118.     const LocIds = shaka.ui.Locales.Ids;
  120.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  121.     this.button.ariaLabel = this.localization.resolve(LocIds.LANGUAGE);
  122.     this.nameSpan.textContent =
  123.         this.localization.resolve(LocIds.LANGUAGE);
  124.     this.backSpan.textContent =
  125.         this.localization.resolve(LocIds.LANGUAGE);
  126.   }
  127. };
  130. /**
  131.  * @implements {shaka.extern.IUIElement.Factory}
  132.  * @final
  133.  */
  134. shaka.ui.AudioLanguageSelection.Factory = class {
  135.   /** @override */
  136.   create(rootElement, controls) {
  137.     return new shaka.ui.AudioLanguageSelection(rootElement, controls);
  138.   }
  139. };
  141. shaka.ui.OverflowMenu.registerElement(
  142.     'language', new shaka.ui.AudioLanguageSelection.Factory());
  144. shaka.ui.Controls.registerElement(
  145.     'language', new shaka.ui.AudioLanguageSelection.Factory());