Source: ui/mute_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.MuteButton');
  10. goog.require('shaka.ads.Utils');
  11. goog.require('shaka.ui.ContextMenu');
  12. goog.require('shaka.ui.Controls');
  13. goog.require('shaka.ui.Element');
  14. goog.require('shaka.ui.Enums');
  15. goog.require('shaka.ui.Locales');
  16. goog.require('shaka.ui.Localization');
  17. goog.require('shaka.ui.OverflowMenu');
  18. goog.require('shaka.util.Dom');
  21. /**
  22.  * @extends {shaka.ui.Element}
  23.  * @final
  24.  * @export
  25.  */
  26. shaka.ui.MuteButton = class extends shaka.ui.Element {
  27.   /**
  28.    * @param {!HTMLElement} parent
  29.    * @param {!shaka.ui.Controls} controls
  30.    */
  31.   constructor(parent, controls) {
  32.     super(parent, controls);
  34.     const LocIds = shaka.ui.Locales.Ids;
  35.     /** @private {!HTMLButtonElement} */
  36.     this.button_ = shaka.util.Dom.createButton();
  37.     this.button_.classList.add('shaka-mute-button');
  38.     this.button_.classList.add('shaka-tooltip');
  40.     /** @private {!HTMLElement} */
  41.     this.icon_ = shaka.util.Dom.createHTMLElement('i');
  42.     this.icon_.classList.add('material-icons-round');
  43.     this.icon_.textContent = shaka.ui.Enums.MaterialDesignIcons.MUTE;
  44.     this.button_.appendChild(this.icon_);
  46.     const label = shaka.util.Dom.createHTMLElement('label');
  47.     label.classList.add('shaka-overflow-button-label');
  48.     label.classList.add('shaka-overflow-menu-only');
  49.     this.nameSpan_ = shaka.util.Dom.createHTMLElement('span');
  50.     this.nameSpan_.textContent = this.localization.resolve(LocIds.MUTE);
  51.     label.appendChild(this.nameSpan_);
  53.     /** @private {!HTMLElement} */
  54.     this.currentState_ = shaka.util.Dom.createHTMLElement('span');
  55.     this.currentState_.classList.add('shaka-current-selection-span');
  56.     label.appendChild(this.currentState_);
  58.     this.button_.appendChild(label);
  60.     this.parent.appendChild(this.button_);
  61.     this.updateLocalizedStrings_();
  62.     this.updateIcon_();
  64.     this.eventManager.listen(
  65.         this.localization, shaka.ui.Localization.LOCALE_UPDATED, () => {
  66.           this.updateLocalizedStrings_();
  67.         });
  69.     this.eventManager.listen(
  70.         this.localization, shaka.ui.Localization.LOCALE_CHANGED, () => {
  71.           this.updateLocalizedStrings_();
  72.         });
  74.     this.eventManager.listen(this.button_, 'click', () => {
  75.       if (!this.controls.isOpaque()) {
  76.         return;
  77.       }
  78.       if (this.ad && this.ad.isLinear()) {
  79.         this.ad.setMuted(!this.ad.isMuted());
  80.       } else {
  81.         if (!this.video.muted && this.video.volume == 0) {
  82.           this.video.volume = 1;
  83.         } else {
  84.           this.video.muted = !this.video.muted;
  85.         }
  86.       }
  87.     });
  89.     this.eventManager.listen(this.video, 'volumechange', () => {
  90.       this.updateLocalizedStrings_();
  91.       this.updateIcon_();
  92.     });
  94.     this.eventManager.listen(this.player, 'loading', () => {
  95.       this.updateLocalizedStrings_();
  96.       this.updateIcon_();
  97.     });
  99.     this.eventManager.listen(this.controls, 'caststatuschanged', () => {
  100.       this.updateLocalizedStrings_();
  101.       this.updateIcon_();
  102.     });
  104.     this.eventManager.listen(this.adManager,
  105.         shaka.ads.Utils.AD_VOLUME_CHANGED, () => {
  106.           this.updateLocalizedStrings_();
  107.           this.updateIcon_();
  108.         });
  110.     this.eventManager.listen(this.adManager,
  111.         shaka.ads.Utils.AD_MUTED, () => {
  112.           this.updateLocalizedStrings_();
  113.           this.updateIcon_();
  114.         });
  116.     this.eventManager.listen(this.adManager,
  117.         shaka.ads.Utils.AD_STOPPED, () => {
  118.           // The base class also listens for this event and sets this.ad
  119.           // to null. This is a safeguard in case of a race condition as
  120.           // the label and icon code depends on this.ad being correctly
  121.           // updated at the time it runs.
  122.           this.ad = null;
  123.           this.updateLocalizedStrings_();
  124.           this.updateIcon_();
  125.         });
  126.   }
  128.   /**
  129.    * @private
  130.    */
  131.   updateLocalizedStrings_() {
  132.     const LocIds = shaka.ui.Locales.Ids;
  133.     let label;
  134.     if (this.ad) {
  135.       label = this.ad.isMuted() ? LocIds.UNMUTE : LocIds.MUTE;
  136.     } else {
  137.       label = (this.video.muted || this.video.volume == 0) ?
  138.           LocIds.UNMUTE : LocIds.MUTE;
  139.     }
  141.     this.button_.ariaLabel = this.localization.resolve(label);
  142.     this.nameSpan_.textContent = this.localization.resolve(label);
  143.   }
  145.   /**
  146.    * @private
  147.    */
  148.   updateIcon_() {
  149.     const Icons = shaka.ui.Enums.MaterialDesignIcons;
  150.     let icon;
  151.     if (this.ad) {
  152.       icon = this.ad.isMuted() ? Icons.UNMUTE : Icons.MUTE;
  153.     } else {
  154.       icon = (this.video.muted || this.video.volume == 0) ?
  155.           Icons.UNMUTE : Icons.MUTE;
  156.     }
  157.     this.icon_.textContent = icon;
  158.   }
  159. };
  162. /**
  163.  * @implements {shaka.extern.IUIElement.Factory}
  164.  * @final
  165.  */
  166. shaka.ui.MuteButton.Factory = class {
  167.   /** @override */
  168.   create(rootElement, controls) {
  169.     return new shaka.ui.MuteButton(rootElement, controls);
  170.   }
  171. };
  173. shaka.ui.OverflowMenu.registerElement(
  174.     'mute', new shaka.ui.MuteButton.Factory());
  176. shaka.ui.Controls.registerElement(
  177.     'mute', new shaka.ui.MuteButton.Factory());
  179. shaka.ui.ContextMenu.registerElement(
  180.     'mute', new shaka.ui.MuteButton.Factory());