Source: ui/cast_button.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.CastButton');
  10. goog.require('shaka.cast.CastProxy');
  11. goog.require('shaka.ui.Controls');
  12. goog.require('shaka.ui.Element');
  13. goog.require('shaka.ui.Enums');
  14. goog.require('shaka.ui.Locales');
  15. goog.require('shaka.ui.Localization');
  16. goog.require('shaka.ui.OverflowMenu');
  17. goog.require('shaka.ui.Utils');
  18. goog.require('shaka.util.Dom');
  19. goog.require('shaka.util.Error');
  20. goog.require('shaka.util.FakeEvent');
  21. goog.requireType('shaka.cast.CastProxy');
  22. goog.requireType('shaka.ui.Controls');
  25. /**
  26.  * @extends {shaka.ui.Element}
  27.  * @final
  28.  * @export
  29.  */
  30. shaka.ui.CastButton = class extends shaka.ui.Element {
  31.   /**
  32.    * @param {!HTMLElement} parent
  33.    * @param {!shaka.ui.Controls} controls
  34.    */
  35.   constructor(parent, controls) {
  36.     super(parent, controls);
  38.     /** @private {shaka.cast.CastProxy} */
  39.     this.castProxy_ = this.controls.getCastProxy();
  41.     /** @private {!HTMLButtonElement} */
  42.     this.castButton_ = shaka.util.Dom.createButton();
  43.     this.castButton_.classList.add('shaka-cast-button');
  44.     this.castButton_.classList.add('shaka-tooltip');
  45.     this.castButton_.ariaPressed = 'false';
  47.     /** @private {!HTMLElement} */
  48.     this.castIcon_ = shaka.util.Dom.createHTMLElement('i');
  49.     this.castIcon_.classList.add('material-icons-round');
  50.     this.castIcon_.textContent = shaka.ui.Enums.MaterialDesignIcons.CAST;
  51.     this.castButton_.appendChild(this.castIcon_);
  53.     const label = shaka.util.Dom.createHTMLElement('label');
  54.     label.classList.add('shaka-overflow-button-label');
  55.     label.classList.add('shaka-overflow-menu-only');
  56.     this.castNameSpan_ = shaka.util.Dom.createHTMLElement('span');
  57.     label.appendChild(this.castNameSpan_);
  59.     this.castCurrentSelectionSpan_ =
  60.       shaka.util.Dom.createHTMLElement('span');
  61.     this.castCurrentSelectionSpan_.classList.add(
  62.         'shaka-current-selection-span');
  63.     label.appendChild(this.castCurrentSelectionSpan_);
  64.     this.castButton_.appendChild(label);
  65.     this.parent.appendChild(this.castButton_);
  67.     // Setup strings in the correct language
  68.     this.updateLocalizedStrings_();
  70.     // Setup button display and state according to the current cast status
  71.     this.onCastStatusChange_();
  73.     this.eventManager.listen(
  74.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  75.           this.updateLocalizedStrings_();
  76.         });
  78.     this.eventManager.listen(
  79.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  80.           this.updateLocalizedStrings_();
  81.         });
  83.     this.eventManager.listen(this.castButton_, 'click', () => {
  84.       this.onCastClick_();
  85.     });
  87.     this.eventManager.listen(this.controls, 'caststatuschanged', () => {
  88.       this.onCastStatusChange_();
  89.     });
  90.   }
  93.   /** @private */
  94.   async onCastClick_() {
  95.     if (this.castProxy_.isCasting()) {
  96.       this.castProxy_.suggestDisconnect();
  97.     } else {
  98.       try {
  99.         this.castButton_.disabled = true;
  100.         await this.castProxy_.cast();
  101.         this.castButton_.disabled = false;
  102.       } catch (error) {
  103.         this.castButton_.disabled = false;
  104.         if (error.code != shaka.util.Error.Code.CAST_CANCELED_BY_USER) {
  105.           this.controls.dispatchEvent(new shaka.util.FakeEvent(
  106.               'error', (new Map()).set('detail', error)));
  107.         }
  108.       }
  109.     }
  110.   }
  113.   /**
  114.    * @private
  115.    */
  116.   onCastStatusChange_() {
  117.     const canCast = this.castProxy_.canCast() && this.controls.isCastAllowed();
  118.     const isCasting = this.castProxy_.isCasting();
  119.     const materialDesignIcons = shaka.ui.Enums.MaterialDesignIcons;
  120.     shaka.ui.Utils.setDisplay(this.castButton_, canCast);
  121.     this.castIcon_.textContent = isCasting ?
  122.                                    materialDesignIcons.EXIT_CAST :
  123.                                    materialDesignIcons.CAST;
  125.     // Aria-pressed set to true when casting, set to false otherwise.
  126.     if (canCast) {
  127.       if (isCasting) {
  128.         this.castButton_.ariaPressed = 'true';
  129.       } else {
  130.         this.castButton_.ariaPressed = 'false';
  131.       }
  132.     }
  134.     this.setCurrentCastSelection_();
  135.   }
  138.   /**
  139.    * @private
  140.    */
  141.   setCurrentCastSelection_() {
  142.     if (this.castProxy_.isCasting()) {
  143.       this.castCurrentSelectionSpan_.textContent =
  144.           this.castProxy_.receiverName();
  145.     } else {
  146.       this.castCurrentSelectionSpan_.textContent =
  147.           this.localization.resolve(shaka.ui.Locales.Ids.OFF);
  148.     }
  149.   }
  152.   /**
  153.    * @private
  154.    */
  155.   updateLocalizedStrings_() {
  156.     const LocIds = shaka.ui.Locales.Ids;
  158.     this.castButton_.ariaLabel = this.localization.resolve(LocIds.CAST);
  159.     this.castNameSpan_.textContent =
  160.         this.localization.resolve(LocIds.CAST);
  162.     // If we're not casting, string "not casting" will be displayed,
  163.     // which needs localization.
  164.     this.setCurrentCastSelection_();
  165.   }
  166. };
  169. /**
  170.  * @implements {shaka.extern.IUIElement.Factory}
  171.  * @final
  172.  */
  173. shaka.ui.CastButton.Factory = class {
  174.   /** @override */
  175.   create(rootElement, controls) {
  176.     return new shaka.ui.CastButton(rootElement, controls);
  177.   }
  178. };
  180. shaka.ui.OverflowMenu.registerElement(
  181.     'cast', new shaka.ui.CastButton.Factory());
  183. shaka.ui.Controls.registerElement(
  184.     'cast', new shaka.ui.CastButton.Factory());