Source: ui/chapter_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.ChapterSelection');
  10. goog.require('shaka.ui.Controls');
  11. goog.require('shaka.ui.Enums');
  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.requireType('shaka.ui.Controls');
  20. /**
  21.  * @extends {shaka.ui.SettingsMenu}
  22.  * @final
  23.  * @export
  24.  */
  25. shaka.ui.ChapterSelection = class extends shaka.ui.SettingsMenu {
  26.   /**
  27.    * @param {!HTMLElement} parent
  28.    * @param {!shaka.ui.Controls} controls
  29.    */
  30.   constructor(parent, controls) {
  31.     super(parent, controls, shaka.ui.Enums.MaterialDesignIcons.CHAPTER);
  33.     this.button.classList.add('shaka-chapter-button');
  34.     this.menu.classList.add('shaka-chapters');
  35.     this.button.classList.add('shaka-tooltip-status');
  37.     /** @type {!Array<shaka.extern.Chapter>} */
  38.     this.chapters_ = [];
  40.     this.chaptersLanguage_ = 'und';
  42.     this.eventManager.listen(
  43.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  44.           this.updateLocalizedStrings_();
  45.           this.updateChapters_();
  46.         });
  48.     this.eventManager.listen(
  49.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  50.           this.updateLocalizedStrings_();
  51.           this.updateChapters_();
  52.         });
  54.     this.eventManager.listen(this.player, 'unloading', () => {
  55.       this.deletePreviousChapters_();
  56.       this.chaptersLanguage_ = 'und';
  57.       this.chapters_ = [];
  58.     });
  60.     this.eventManager.listen(this.player, 'trackschanged', () => {
  61.       this.updateChapters_();
  62.     });
  64.     // Set up all the strings in the user's preferred language.
  65.     this.updateLocalizedStrings_();
  67.     this.updateChapters_();
  68.   }
  70.   /**
  71.    * @private
  72.    */
  73.   updateLocalizedStrings_() {
  74.     const LocIds = shaka.ui.Locales.Ids;
  76.     this.backButton.ariaLabel = this.localization.resolve(LocIds.BACK);
  77.     this.button.ariaLabel = this.localization.resolve(LocIds.CHAPTERS);
  78.     this.nameSpan.textContent = this.localization.resolve(LocIds.CHAPTERS);
  79.     this.backSpan.textContent = this.localization.resolve(LocIds.CHAPTERS);
  80.   }
  82.   /**
  83.    * @private
  84.    */
  85.   deletePreviousChapters_() {
  86.     // 1. Save the back to menu button
  87.     const backButton = shaka.ui.Utils.getFirstDescendantWithClassName(
  88.         this.menu, 'shaka-back-to-overflow-button');
  90.     // 2. Remove everything
  91.     shaka.util.Dom.removeAllChildren(this.menu);
  93.     // 3. Add the backTo Menu button back
  94.     this.menu.appendChild(backButton);
  96.     // 4. Hidden button
  97.     shaka.ui.Utils.setDisplay(this.button, false);
  98.   }
  100.   /**
  101.    * @private
  102.    */
  103.   updateChapters_() {
  104.     /**
  105.      * Does a value compare on chapters.
  106.      * @param {shaka.extern.Chapter} a
  107.      * @param {shaka.extern.Chapter} b
  108.      * @return {boolean}
  109.      */
  110.     const chaptersEqual = (a, b) => {
  111.       return (!a && !b) || (a.id === b.id && a.title === b.title &&
  112.           a.startTime === b.startTime && a.endTime === b.endTime);
  113.     };
  115.     let nextLanguage = 'und';
  116.     /** @type {!Array<shaka.extern.Chapter>} */
  117.     let nextChapters = [];
  119.     const currentLocales = this.localization.getCurrentLocales();
  120.     for (const locale of Array.from(currentLocales)) {
  121.       nextLanguage = locale;
  122.       nextChapters = this.player.getChapters(nextLanguage);
  123.       if (nextChapters.length) {
  124.         break;
  125.       }
  126.     }
  127.     if (!nextChapters.length) {
  128.       nextLanguage = 'und';
  129.       nextChapters = this.player.getChapters(nextLanguage);
  130.     }
  132.     const languageChanged = nextLanguage !== this.chaptersLanguage_;
  133.     const chaptersChanged = this.chapters_.length !== nextChapters.length ||
  134.       !this.chapters_.some((c, idx) => {
  135.         const n = nextChapters.at(idx);
  136.         return chaptersEqual(c, n) ||
  137.           nextChapters.some((n) => chaptersEqual(c, n));
  138.       });
  140.     this.chaptersLanguage_ = nextLanguage;
  141.     this.chapters_ = nextChapters;
  142.     if (!nextChapters.length) {
  143.       this.deletePreviousChapters_();
  144.     } else if (languageChanged || chaptersChanged) {
  145.       for (const chapter of this.chapters_) {
  146.         const button = shaka.util.Dom.createButton();
  147.         const span = shaka.util.Dom.createHTMLElement('span');
  148.         span.classList.add('shaka-chapter');
  149.         span.textContent = chapter.title;
  150.         button.appendChild(span);
  152.         this.eventManager.listen(button, 'click', () => {
  153.           this.video.currentTime = chapter.startTime;
  154.         });
  156.         this.menu.appendChild(button);
  157.       }
  158.       shaka.ui.Utils.setDisplay(this.button, true);
  159.       shaka.ui.Utils.focusOnTheChosenItem(this.menu);
  160.     }
  161.   }
  162. };
  164. /**
  165.  * @implements {shaka.extern.IUIElement.Factory}
  166.  * @final
  167.  */
  168. shaka.ui.ChapterSelection.Factory = class {
  169.   /** @override */
  170.   create(rootElement, controls) {
  171.     return new shaka.ui.ChapterSelection(rootElement, controls);
  172.   }
  173. };
  175. shaka.ui.OverflowMenu.registerElement(
  176.     'chapter', new shaka.ui.ChapterSelection.Factory());
  178. shaka.ui.Controls.registerElement(
  179.     'chapter', new shaka.ui.ChapterSelection.Factory());