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.AdManager');
  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.     this.eventManager.listen(this.video,
  36.         'volumechange',
  37.         () => this.onPresentationVolumeChange_());
  39.     this.eventManager.listen(this.adManager,
  40.         shaka.ads.AdManager.AD_VOLUME_CHANGED,
  41.         () => this.onAdVolumeChange_());
  43.     this.eventManager.listen(this.adManager,
  44.         shaka.ads.AdManager.AD_MUTED,
  45.         () => this.onAdVolumeChange_());
  47.     this.eventManager.listen(this.adManager,
  48.         shaka.ads.AdManager.AD_STOPPED,
  49.         () => this.onPresentationVolumeChange_());
  51.     this.eventManager.listen(this.localization,
  52.         shaka.ui.Localization.LOCALE_UPDATED,
  53.         () => this.updateAriaLabel_());
  55.     this.eventManager.listen(this.localization,
  56.         shaka.ui.Localization.LOCALE_CHANGED,
  57.         () => this.updateAriaLabel_());
  59.     // Initialize volume display and label.
  60.     this.onPresentationVolumeChange_();
  61.     this.updateAriaLabel_();
  63.     if (this.ad) {
  64.       // There was already an ad.
  65.       this.onChange();
  66.     }
  67.   }
  69.   /**
  70.    * Update the video element's state to match the input element's state.
  71.    * Called by the base class when the input element changes.
  72.    *
  73.    * @override
  74.    */
  75.   onChange() {
  76.     if (this.ad) {
  77.       this.ad.setVolume(this.getValue());
  78.     } else {
  79.       this.video.volume = this.getValue();
  80.       if (this.video.volume == 0) {
  81.         this.video.muted = true;
  82.       } else {
  83.         this.video.muted = false;
  84.       }
  85.     }
  86.   }
  88.   /** @private */
  89.   onPresentationVolumeChange_() {
  90.     if (this.video.muted) {
  91.       this.setValue(0);
  92.     } else {
  93.       this.setValue(this.video.volume);
  94.     }
  96.     this.updateColors_();
  97.   }
  99.   /** @private */
  100.   onAdVolumeChange_() {
  101.     goog.asserts.assert(this.ad != null,
  102.         'This.ad should exist at this point!');
  104.     const volume = this.ad.getVolume();
  105.     this.setValue(volume);
  106.     this.updateColors_();
  107.   }
  109.   /** @private */
  110.   updateColors_() {
  111.     const colors = this.config_.volumeBarColors;
  112.     const gradient = ['to right'];
  113.     gradient.push(colors.level + (this.getValue() * 100) + '%');
  114.     gradient.push(colors.base + (this.getValue() * 100) + '%');
  115.     gradient.push(colors.base + '100%');
  117.     this.container.style.background =
  118.         'linear-gradient(' + gradient.join(',') + ')';
  119.   }
  121.   /** @private */
  122.   updateAriaLabel_() {
  123.     this.bar.ariaLabel = this.localization.resolve(shaka.ui.Locales.Ids.VOLUME);
  124.   }
  125. };
  127. /**
  128.  * @implements {shaka.extern.IUIElement.Factory}
  129.  * @final
  130.  */
  131. shaka.ui.VolumeBar.Factory = class {
  132.   /** @override */
  133.   create(rootElement, controls) {
  134.     return new shaka.ui.VolumeBar(rootElement, controls);
  135.   }
  136. };
  138. shaka.ui.Controls.registerElement('volume', new shaka.ui.VolumeBar.Factory());