Source: ui/volume_bar.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.VolumeBar');
  10. goog.require('goog.asserts');
  11. goog.require('shaka.ads.Utils');
  12. goog.require('shaka.ui.Controls');
  13. goog.require('shaka.ui.Locales');
  14. goog.require('shaka.ui.Localization');
  15. goog.require('shaka.ui.RangeElement');
  18. /**
  19.  * @extends {shaka.ui.RangeElement}
  20.  * @final
  21.  * @export
  22.  */
  23. shaka.ui.VolumeBar = class extends shaka.ui.RangeElement {
  24.   /**
  25.    * @param {!HTMLElement} parent
  26.    * @param {!shaka.ui.Controls} controls
  27.    */
  28.   constructor(parent, controls) {
  29.     super(parent, controls,
  30.         ['shaka-volume-bar-container'], ['shaka-volume-bar']);
  32.     /** @private {!shaka.extern.UIConfiguration} */
  33.     this.config_ = this.controls.getConfig();
  35.     // We use a range of 100 to avoid problems with Firefox.
  36.     // See https://github.com/shaka-project/shaka-player/issues/3987
  37.     this.setRange(0, 100);
  39.     this.eventManager.listen(this.video,
  40.         'volumechange',
  41.         () => this.onPresentationVolumeChange_());
  43.     this.eventManager.listen(this.adManager,
  44.         shaka.ads.Utils.AD_VOLUME_CHANGED,
  45.         () => this.onAdVolumeChange_());
  47.     this.eventManager.listen(this.adManager,
  48.         shaka.ads.Utils.AD_MUTED,
  49.         () => this.onAdVolumeChange_());
  51.     this.eventManager.listen(this.adManager,
  52.         shaka.ads.Utils.AD_STOPPED,
  53.         () => this.onPresentationVolumeChange_());
  55.     this.eventManager.listen(this.localization,
  56.         shaka.ui.Localization.LOCALE_UPDATED,
  57.         () => this.updateAriaLabel_());
  59.     this.eventManager.listen(this.localization,
  60.         shaka.ui.Localization.LOCALE_CHANGED,
  61.         () => this.updateAriaLabel_());
  63.     // Initialize volume display and label.
  64.     this.onPresentationVolumeChange_();
  65.     this.updateAriaLabel_();
  67.     if (this.ad) {
  68.       // There was already an ad.
  69.       this.onChange();
  70.     }
  71.   }
  73.   /**
  74.    * Update the video element's state to match the input element's state.
  75.    * Called by the base class when the input element changes.
  76.    *
  77.    * @override
  78.    */
  79.   onChange() {
  80.     if (this.ad && this.ad.isLinear()) {
  81.       this.ad.setVolume(this.getValue() / 100);
  82.     } else {
  83.       this.video.volume = this.getValue() / 100;
  84.       if (this.video.volume > 0) {
  85.         this.video.muted = false;
  86.       }
  87.     }
  88.   }
  90.   /** @private */
  91.   onPresentationVolumeChange_() {
  92.     if (this.video.muted) {
  93.       this.setValue(0);
  94.     } else {
  95.       this.setValue(this.video.volume * 100);
  96.     }
  98.     this.updateColors_();
  99.   }
  101.   /** @private */
  102.   onAdVolumeChange_() {
  103.     goog.asserts.assert(this.ad != null,
  104.         'This.ad should exist at this point!');
  106.     const volume = this.ad.getVolume();
  107.     this.setValue(volume * 100);
  108.     this.updateColors_();
  109.   }
  111.   /** @private */
  112.   updateColors_() {
  113.     const colors = this.config_.volumeBarColors;
  114.     const gradient = ['to right'];
  115.     gradient.push(colors.level + this.getValue() + '%');
  116.     gradient.push(colors.base + this.getValue() + '%');
  117.     gradient.push(colors.base + '100%');
  119.     this.container.style.background =
  120.         'linear-gradient(' + gradient.join(',') + ')';
  121.   }
  123.   /** @private */
  124.   updateAriaLabel_() {
  125.     this.bar.ariaLabel = this.localization.resolve(shaka.ui.Locales.Ids.VOLUME);
  126.   }
  127. };
  129. /**
  130.  * @implements {shaka.extern.IUIElement.Factory}
  131.  * @final
  132.  */
  133. shaka.ui.VolumeBar.Factory = class {
  134.   /** @override */
  135.   create(rootElement, controls) {
  136.     return new shaka.ui.VolumeBar(rootElement, controls);
  137.   }
  138. };
  140. shaka.ui.Controls.registerElement('volume', new shaka.ui.VolumeBar.Factory());