shaka-player/ui/play_button.js

/*! @license
 * Shaka Player
 * Copyright 2016 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */


goog.provide('shaka.ui.PlayButton');

goog.require('shaka.ads.Utils');
goog.require('shaka.ui.Controls');
goog.require('shaka.ui.Element');
goog.require('shaka.ui.Enums');
goog.require('shaka.ui.Icon');
goog.require('shaka.ui.Locales');
goog.require('shaka.util.Dom');
goog.require('shaka.util.MediaElementEvent');


/**
 * @extends {shaka.ui.Element}
 * @final
 * @export
 */
shaka.ui.PlayButton = class extends shaka.ui.Element {
  /**
   * @param {!HTMLElement} parent
   * @param {!shaka.ui.Controls} controls
   * @param {boolean=} showBuffering
   */
  constructor(parent, controls, showBuffering = false) {
    super(parent, controls);

    /** @private {boolean} */
    this.showBuffering_ = showBuffering;

    /** @protected {!HTMLButtonElement} */
    this.button_ = shaka.util.Dom.createButton();
    this.button_.classList.add('shaka-play-button');
    this.button_.classList.add('shaka-tooltip');
    this.button_.classList.add('shaka-no-propagation');
    this.parent.appendChild(this.button_);

    /** @private {!shaka.ui.Icon} */
    this.icon_ = new shaka.ui.Icon(this.button_);

    this.eventManager.listenMulti(
        this.video,
        [
          shaka.util.MediaElementEvent.PLAY,
          shaka.util.MediaElementEvent.PAUSE,
          shaka.util.MediaElementEvent.SEEKING,
        ], () => {
          this.updateLocalizedStrings();
          this.updateIcon_();
        });

    this.eventManager.listenMulti(
        this.player,
        [
          'loading',
          'loaded',
          'unloading',
          'buffering',
        ], () => {
          this.updateLocalizedStrings();
          this.updateIcon_();
        });

    this.eventManager.listenMulti(
        this.adManager,
        [
          shaka.ads.Utils.AD_PAUSED,
          shaka.ads.Utils.AD_RESUMED,
          shaka.ads.Utils.AD_PLAYING,
          shaka.ads.Utils.AD_STARTED,
          shaka.ads.Utils.AD_STOPPED,
        ], () => {
          this.updateLocalizedStrings();
          this.updateIcon_();
        });

    this.eventManager.listen(this.button_, 'click', () => {
      if (!this.controls.isOpaque()) {
        return;
      }
      this.controls.playPausePresentation();
    });

    this.updateLocalizedStrings();
    this.updateIcon_();
  }

  /**
   * @return {boolean}
   * @private
   */
  isPaused_() {
    if (this.ad && this.ad.isLinear()) {
      return this.ad.isPaused();
    }

    return this.controls.presentationIsPaused();
  }

  /**
   * @return {boolean}
   * @private
   */
  isEnded_() {
    if (this.ad && this.ad.isLinear()) {
      return false;
    }

    return this.player ? this.player.isEnded() : true;
  }

  /**
   * @return {boolean}
   * @private
   */
  isBuffering_() {
    if (this.ad && this.ad.isLinear()) {
      return false;
    }

    return this.player ? this.player.isBuffering() : false;
  }

  /** @override */
  updateLocalizedStrings() {
    const LocIds = shaka.ui.Locales.Ids;
    if (this.isEnded_() && this.video.duration) {
      this.button_.ariaLabel = this.localization.resolve(LocIds.REPLAY);
    } else if (this.showBuffering_ && this.isBuffering_()) {
      this.button_.ariaLabel = this.localization.resolve(LocIds.BUFFERING);
    } else {
      const label = this.isPaused_() ? LocIds.PLAY : LocIds.PAUSE;
      this.button_.ariaLabel = this.localization.resolve(label);
    }
  }

  /**
   * @private
   */
  updateIcon_() {
    const Icons = shaka.ui.Enums.MaterialDesignSVGIcons;
    const svg = this.icon_.getSvgElement();
    shaka.util.Dom.removeAllChildren(svg);

    if (this.isEnded_() && this.video.duration) {
      this.icon_.use(Icons['REPLAY']);
    } else if (this.showBuffering_ && this.isBuffering_()) {
      svg.setAttribute('viewBox', '0 0 38 38');
      svg.style.setProperty('background-color', 'transparent');
      svg.style.setProperty('mask-image', '');
      svg.insertAdjacentHTML('beforeend',
          `<g transform="translate(1 1)" stroke="currentColor"
               stroke-width="6" fill="none" fill-rule="evenodd">
             <circle stroke-opacity=".5" cx="18" cy="18" r="16"></circle>
             <path d="M34 18c0-9.94-8.06-16-16-16">
               <animateTransform attributeName="transform" type="rotate"
                 from="0 18 18" to="360 18 18" dur="1s"
                 repeatCount="indefinite"></animateTransform>
             </path>
           </g>`);
    } else {
      this.icon_.use(this.isPaused_() ? Icons['PLAY'] : Icons['PAUSE']);
    }
  }
};


/**
 * @implements {shaka.extern.IUIElement.Factory}
 * @final
 */
shaka.ui.PlayButton.Factory = class {
  /** @override */
  create(rootElement, controls) {
    return new shaka.ui.PlayButton(rootElement, controls);
  }
};

shaka.ui.Controls.registerElement(
    'play_pause', new shaka.ui.PlayButton.Factory());

shaka.ui.Controls.registerBigElement(
    'play_pause', new shaka.ui.PlayButton.Factory());


/**
 * @implements {shaka.extern.IUIElement.Factory}
 * @final
 */
shaka.ui.PlayButton.BufferingFactory = class {
  /** @override */
  create(rootElement, controls) {
    return new shaka.ui.PlayButton(
        rootElement, controls, /* showBuffering= */ true);
  }
};

shaka.ui.Controls.registerElement(
    'play_pause_buffering', new shaka.ui.PlayButton.BufferingFactory());

shaka.ui.Controls.registerBigElement(
    'play_pause_buffering', new shaka.ui.PlayButton.BufferingFactory());