@gcorevideo/player 2.20.7 → 2.20.8

package/src/plugins/dvr-controls/DvrControls.ts

@@ -1,10 +1,13 @@
-import { Core, Events, Playback, UICorePlugin, template } from '@clappr/core';
-import assert from 'assert';
+import { Core, Events, Playback, UICorePlugin, template } from '@clappr/core'
+import assert from 'assert'
 
-import { CLAPPR_VERSION } from '../../build.js';
+import { CLAPPR_VERSION } from '../../build.js'
 
-import dvrHTML from '../../../assets/dvr-controls/index.ejs';
-import '../../../assets/dvr-controls/dvr_controls.scss';
+import dvrHTML from '../../../assets/dvr-controls/index.ejs'
+import '../../../assets/dvr-controls/dvr_controls.scss'
+import { trace } from '@gcorevideo/utils'
+
+const T = 'plugins.dvr_controls'
 
 /**
  * Adds the DVR controls to the media control UI
@@ -18,20 +21,20 @@ import '../../../assets/dvr-controls/dvr_controls.scss';
  * The plugin renders the live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
  */
 export class DvrControls extends UICorePlugin {
-  private static readonly template = template(dvrHTML);
+  private static readonly template = template(dvrHTML)
 
   /**
    * @internal
    */
   get name() {
-    return 'dvr_controls';
+    return 'dvr_controls'
   }
 
   /**
    * @internal
    */
   get supportedVersion() {
-    return { min: CLAPPR_VERSION };
+    return { min: CLAPPR_VERSION }
   }
 
   /**
@@ -39,8 +42,8 @@ export class DvrControls extends UICorePlugin {
    */
   override get events() {
     return {
-      'click .live-button': 'click'
-    };
+      'click .live-button': 'click',
+    }
   }
 
   /**
@@ -48,96 +51,126 @@ export class DvrControls extends UICorePlugin {
    */
   override get attributes() {
     return {
-      'class': 'dvr-controls',
-      'data-dvr-controls': ''
-    };
+      class: 'dvr-controls',
+      'data-dvr-controls': '',
+    }
   }
 
   constructor(core: Core) {
-    super(core);
-    this.settingsUpdate();
+    super(core)
+    this.settingsUpdate()
   }
 
   /**
    * @internal
    */
   override bindEvents() {
-    const mediaControl = this.core.getPlugin('media_control');
-    assert(mediaControl, 'media_control plugin is required');
-    this.listenTo(mediaControl, Events.MEDIACONTROL_RENDERED, this.settingsUpdate);
-    this.listenTo(this.core, Events.CORE_OPTIONS_CHANGE, this.render);
-    this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.bindContainerEvents);
+    const mediaControl = this.core.getPlugin('media_control')
+    assert(mediaControl, 'media_control plugin is required')
+    this.listenTo(
+      mediaControl,
+      Events.MEDIACONTROL_RENDERED,
+      this.settingsUpdate,
+    )
+    this.listenTo(this.core, Events.CORE_OPTIONS_CHANGE, this.render)
+    this.listenTo(
+      this.core,
+      Events.CORE_ACTIVE_CONTAINER_CHANGED,
+      this.bindContainerEvents,
+    )
   }
 
   private bindContainerEvents() {
-    this.listenToOnce(this.core.activeContainer, Events.CONTAINER_TIMEUPDATE, this.render);
-    this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.dvrChanged);
+    this.listenToOnce(
+      this.core.activeContainer,
+      Events.CONTAINER_TIMEUPDATE,
+      this.render,
+    )
+    this.listenTo(
+      this.core.activeContainer,
+      Events.CONTAINER_PLAYBACKDVRSTATECHANGED,
+      this.onDvrChanged,
+    )
   }
 
-  private dvrChanged(dvrEnabled: boolean) {
+  private onDvrChanged(dvrEnabled: boolean) {
+    trace(`${T} onDvrChanged`, {
+      dvrEnabled,
+    })
     if (this.core.getPlaybackType() !== Playback.LIVE) {
-      return;
+      return
     }
-    this.settingsUpdate();
-    this.core.mediaControl.$el.addClass('live');
+    this.settingsUpdate()
+    this.core.mediaControl.$el.addClass('live')
     if (dvrEnabled) {
-      this.core.mediaControl.$playbackRate.removeClass('playbackrate-enable');
+      // TODO
       this.core.mediaControl.$el
         .addClass('dvr')
-        .find('.media-control-indicator[data-position], .media-control-indicator[data-duration]')
-        .hide();
+        .find(
+          '.media-control-indicator[data-position], .media-control-indicator[data-duration]',
+        )
+        .hide()
     } else {
-      this.core.mediaControl.$playbackRate.addClass('playbackrate-enable');
-      this.core.mediaControl.$el.removeClass('dvr');
+      this.core.mediaControl.$el.removeClass('dvr')
     }
   }
 
   private click() {
-    const mediaControl = this.core.getPlugin('media_control');
-    const container = this.core.activeContainer;
+    const mediaControl = this.core.getPlugin('media_control')
+    const container = this.core.activeContainer
 
     if (!container.isPlaying()) {
-      container.play();
+      container.play()
     }
 
     if (mediaControl.$el.hasClass('dvr')) {
-      container.seek(container.getDuration());
+      container.seek(container.getDuration())
     }
   }
 
   private settingsUpdate() {
     // @ts-ignore
-    this.stopListening(); // TODO sort out
-    this.core.getPlugin('media_control').$el.removeClass('live'); // TODO don't access directly
+    this.stopListening() // TODO sort out
+    this.core.getPlugin('media_control').$el.removeClass('live') // TODO don't access directly
     if (this.shouldRender()) {
-      this.render();
-      this.$el.click(() => this.click());
+      this.render()
+      this.$el.click(() => this.click())
     }
-    this.bindEvents();
+    this.bindEvents()
   }
 
   private shouldRender() {
-    const useDvrControls = this.core.options.useDvrControls === undefined || !!this.core.options.useDvrControls;
+    const useDvrControls =
+      this.core.options.useDvrControls === undefined ||
+      !!this.core.options.useDvrControls
 
-    return useDvrControls && this.core.getPlaybackType() === Playback.LIVE;
+    return useDvrControls && this.core.getPlaybackType() === Playback.LIVE
   }
 
   /**
    * @internal
    */
   override render() {
-    this.$el.html(DvrControls.template({
-      live: this.core.i18n.t('live'),
-      backToLive: this.core.i18n.t('back_to_live')
-    }));
-    if (this.shouldRender()) {
-      const mediaControl = this.core.getPlugin('media_control');
-      assert(mediaControl, 'media_control plugin is required');
-      // TODO don't tap into the $el directly
-      mediaControl.$el.addClass('live');
-      mediaControl.$('.media-control-left-panel[data-media-control]').append(this.$el);
+    trace(`${T} render`, {
+      dvrEnabled: this.core.activePlayback?.dvrEnabled,
+    })
+    if (!this.shouldRender()) {
+      return this
     }
-
-    return this;
+    this.$el.html(
+      DvrControls.template({
+        live: this.core.i18n.t('live'),
+        backToLive: this.core.i18n.t('back_to_live'),
+      }),
+    )
+    const mediaControl = this.core.getPlugin('media_control')
+    assert(mediaControl, 'media_control plugin is required')
+    // TODO don't tap into the $el directly
+    mediaControl.$el.addClass('live')
+    mediaControl
+      .$('.media-control-left-panel[data-media-control]')
+      .append(this.$el)
+
+    return this
   }
 }

package/src/plugins/level-selector/LevelSelector.ts

@@ -15,7 +15,7 @@ import arrowRightIcon from '../../../assets/icons/new/arrow-right.svg'
 import arrowLeftIcon from '../../../assets/icons/new/arrow-left.svg'
 import checkIcon from '../../../assets/icons/new/check.svg'
 import '../../../assets/level-selector/style.scss'
-import { MediaControl } from '../media-control/MediaControl.js'
+import { MediaControl, MediaControlEvents } from '../media-control/MediaControl.js'
 
 const T = 'plugins.level_selector'
 const VERSION = '2.19.4'
@@ -125,8 +125,7 @@ export class LevelSelector extends UICorePlugin {
    * @internal
    */
   override bindEvents() {
-    const mediaControl = this.core.getPlugin('media_control') as MediaControl
-    assert(mediaControl, 'media_control plugin is required')
+    this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
     this.listenTo(
       this.core,
       Events.CORE_ACTIVE_CONTAINER_CHANGED,
@@ -134,6 +133,18 @@ export class LevelSelector extends UICorePlugin {
     )
   }
 
+  private onCoreReady() {
+    trace(`${T} onCoreReady`);
+    const mediaControl = this.core.getPlugin('media_control') as MediaControl
+    assert(mediaControl, 'media_control plugin is required')
+    this.listenTo(mediaControl, MediaControlEvents.MEDIACONTROL_GEAR_RENDERED, this.onGearRendered);
+  }
+
+  private onGearRendered() {
+    trace(`${T} onGearRendered`);
+    this.deferRender();
+  }
+
   private bindPlaybackEvents() {
     this.removeAuto = false
     this.isHd = false
@@ -301,8 +312,9 @@ export class LevelSelector extends UICorePlugin {
   private goBack() {
     trace(`${T} goBack`)
     this.isOpen = false
-    this.core.trigger('gear:refresh')
-    this.deferRender()
+    setTimeout(() => {
+      this.core.getPlugin('bottom_gear').refresh()
+    }, 0);
   }
 
   private setLevel(index: number) {

package/src/plugins/media-control/MediaControl.ts

@@ -107,7 +107,7 @@ export class MediaControl extends UICorePlugin {
 
   private currentDurationValue: number = 0
   private currentPositionValue: number = 0
-  private currentSeekBarPercentage: number | null = null
+  private currentSeekBarPercentage = 0
 
   private disabledClickableList: DisabledClickable[] = []
   private displayedDuration: string | null = null
@@ -275,6 +275,10 @@ export class MediaControl extends UICorePlugin {
     }
   }
 
+  get currentSeekPos() {
+    return this.currentSeekBarPercentage
+  }
+
   /**
    * Current volume [0..100]
    */
@@ -746,11 +750,10 @@ export class MediaControl extends UICorePlugin {
     this.changeTogglePlay()
     this.bindContainerEvents()
     this.settingsUpdate()
-    this.core.activeContainer &&
-      this.core.activeContainer.trigger(
-        Events.CONTAINER_PLAYBACKDVRSTATECHANGED,
-        this.core.activeContainer.isDvrInUse(),
-      )
+    this.core.activeContainer.trigger(
+      Events.CONTAINER_PLAYBACKDVRSTATECHANGED,
+      this.core.activeContainer.isDvrInUse(),
+    )
     // TODO test
     if (this.core.activeContainer.mediaControlDisabled) {
       this.disable()

package/src/plugins/playback-rate/PlaybackRate.ts

@@ -1,15 +1,19 @@
-import { Events, UICorePlugin, Playback, template } from '@clappr/core';
+import { Events, UICorePlugin, Playback, template, Core } from '@clappr/core';
+import { trace } from '@gcorevideo/utils';
+import assert from 'assert';
 
 import { CLAPPR_VERSION } from '../../build.js';
 import type { ZeptoResult } from '../../utils/types.js';
 
-import pluginHtml from '../../../assets/playback-rate/playback-rate-selector.ejs';
 import buttonHtml from '../../../assets/playback-rate/button.ejs';
 import listHtml from '../../../assets/playback-rate/list.ejs';
 import speedIcon from '../../../assets/icons/new/speed.svg';
 import arrowRightIcon from '../../../assets/icons/new/arrow-right.svg';
 import arrowLeftIcon from '../../../assets/icons/new/arrow-left.svg';
 import checkIcon from '../../../assets/icons/new/check.svg';
+import { BottomGear } from '../bottom-gear/BottomGear.js';
+import { PlaybackEvents } from '../../playback/types.js';
+import { MediaControl, MediaControlEvents } from '../media-control/MediaControl.js';
 
 type PlaybackRateOption = {
   value: string;
@@ -28,11 +32,10 @@ const DEFAULT_PLAYBACK_RATES = [
 
 const DEFAULT_PLAYBACK_RATE = '1.0';
 
-// TODO
-const MEDIACONTROL_PLAYBACKRATE = 'playbackRate';
+const T = 'plugins.playback_rate';
 
 /**
- * Allows changing the playback speed of the video.
+ * PLUGIN that allows changing the playback speed of the video.
  * @beta
  *
  * @remarks
@@ -42,15 +45,16 @@ const MEDIACONTROL_PLAYBACKRATE = 'playbackRate';
  *
  * - {@link BottomGear | bottom_gear}
  *
- * It renders a button in the gear menu, which opens a dropdown with the available playback rates.
+ * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.
  */
 export class PlaybackRate extends UICorePlugin {
-  private currentPlayback: Playback | null = null;
-
   private playbackRates: PlaybackRateOption[] = DEFAULT_PLAYBACK_RATES;
 
+  // Saved when an ad starts to restore after it finishes
   private prevSelectedRate: string | undefined;
 
+  private rendered = false;
+
   private selectedRate: string = DEFAULT_PLAYBACK_RATE;
 
   /**
@@ -67,12 +71,16 @@ export class PlaybackRate extends UICorePlugin {
     return { min: CLAPPR_VERSION };
   }
 
-  private static readonly template = template(pluginHtml);
-
   private static readonly buttonTemplate = template(buttonHtml);
 
   private static readonly listTemplate = template(listHtml);
 
+  constructor(core: Core) {
+    super(core);
+    this.playbackRates = core.options.playbackRate?.options || DEFAULT_PLAYBACK_RATES;
+    this.selectedRate = core.options.playbackRate?.defaultValue || DEFAULT_PLAYBACK_RATE;
+  }
+
   /**
    * @internal
    */
@@ -98,31 +106,40 @@ export class PlaybackRate extends UICorePlugin {
    * @internal
    */
   override bindEvents() {
-    this.listenTo(this.core, 'gear:rendered', this.render);
-    // TODO this.core.getPlugin('media_control'), bottom_gear
-    this.listenTo(this.core.mediaControl, Events.MEDIACONTROL_CONTAINERCHANGED, this.reload);
-    this.listenTo(this.core.mediaControl, MEDIACONTROL_PLAYBACKRATE, this.updatePlaybackRate);
-
-    this.listenTo(this.core, 'core:advertisement:start', this.onStartAd);
-    this.listenTo(this.core, 'core:advertisement:finish', this.onFinishAd);
-    if (this.core.activeContainer) {
-      this.listenTo(this.core.activePlayback, Events.PLAYBACK_BUFFERFULL, this.updateLiveStatus);
-    }
+    this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
+    this.listenTo(this.core, Events.CORE_ACTIVE_CONTAINER_CHANGED, this.onActiveContainerChange);
+  }
 
-    if (this.currentPlayback) {
-      this.listenTo(this.currentPlayback, Events.PLAYBACK_STOP, this.onStop);
-      this.listenTo(this.currentPlayback, Events.PLAYBACK_PLAY, this.onPlay);
+  private onCoreReady() {
+    const mediaControl = this.core.getPlugin('media_control');
+    assert(mediaControl, 'media_control plugin is required');
+    const gear = this.core.getPlugin('bottom_gear') as BottomGear;
+    assert(gear, 'bottom_gear plugin is required');
+    this.listenTo(mediaControl, MediaControlEvents.MEDIACONTROL_GEAR_RENDERED, this.onGearRendered);
+  }
 
-      // TODO import dash playback events
-      this.listenTo(this.currentPlayback, 'dash:playback-rate-changed', this.onDashRateChange);
-    }
+  private onActiveContainerChange() {
+    this.listenTo(this.core.activePlayback, Events.PLAYBACK_STOP, this.onStop);
+    this.listenTo(this.core.activePlayback, Events.PLAYBACK_PLAY, this.onPlay);
+    this.listenTo(this.core.activePlayback, PlaybackEvents.PLAYBACK_RATE_CHANGED, this.onPlaybackRateChange);
+    this.listenTo(this.core.activeContainer, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.onDvrStateChanged);
   }
 
-  private unBindEvents() {
-    this.stopListening(this.core, 'gear:rendered', this.render);
-    this.stopListening(this.core.mediaControl, Events.MEDIACONTROL_CONTAINERCHANGED, this.reload);
-    this.stopListening(this.core, 'core:advertisement:start', this.onStartAd);
-    this.stopListening(this.core, 'core:advertisement:finish', this.onFinishAd);
+  private onGearRendered() {
+    trace(`${T} onGearRendered`, {
+      rendered: this.rendered,
+    });
+    this.rendered = false;
+    this.render();
+  }
+
+  private onDvrStateChanged(dvrEnabled: boolean) {
+    trace(`${T} onDvrStateChanged`, {
+      dvrEnabled,
+    })
+    if (dvrEnabled) {
+      this.render();
+    }
   }
 
   private allRateElements(): ZeptoResult {
@@ -133,86 +150,65 @@ export class PlaybackRate extends UICorePlugin {
     return (this.$(`ul.gear-sub-menu a[data-rate="${rate}"]`) as ZeptoResult).parent();
   }
 
-  private onDashRateChange() {
-    // TODO consider removing
-    ((this.currentPlayback as any)._dash as any)?.setPlaybackRate(this.selectedRate);
-  }
-
-  private updateLiveStatus() {
-    if (this.core.getPlaybackType() === Playback.LIVE) {
-      if (this.core.mediaControl.currentSeekBarPercentage <= 98.9) {
-        this.core.mediaControl.$playbackRate.removeClass('playbackrate-enable');
-        this.core.mediaControl.$el.addClass('dvr');
-
-        return;
-      }
-      this.updatePlaybackRate(DEFAULT_PLAYBACK_RATE);
-      this.core.mediaControl.$playbackRate.addClass('playbackrate-enable');
-      this.core.mediaControl.$el.removeClass('dvr');
+  private onPlaybackRateChange(playbackRate: number) {
+    const selectedRate = parseInt(this.selectedRate, 10);
+    if (playbackRate !== selectedRate) {
+      trace(`${T} onPlaybackRateChange setting target rate`, {
+        playbackRate,
+        selectedRate,
+      })
+      this.core.activePlayback?.setPlaybackRate(selectedRate);
     }
   }
 
-  private reload() {
-    this.unBindEvents();
-    this.bindEvents();
-  }
-
   private shouldRender() {
     if (!this.core.activeContainer) {
       return false;
     }
 
-    this.currentPlayback = this.core.activePlayback;
+    if (this.core.getPlaybackType() === Playback.LIVE && !this.core.activePlayback.dvrEnabled) {
+      return false;
+    }
 
-    return !(this.currentPlayback?.tagName !== 'video' && this.currentPlayback?.tagName !== 'audio');
+    return 'setPlaybackRate' in this.core.activePlayback;
   }
 
   /**
    * @internal
    */
   override render() {
-    const container = this.core.activeContainer;
+    trace(`${T} render`, {
+      rendered: this.rendered,
+      shouldRender: this.shouldRender(),
+    })
 
-    if (this.core.getPlaybackType() === Playback.LIVE && !container.isDvrEnabled()) {
+    if (!this.shouldRender()) {
       return this;
     }
-    const cfg = this.core.options.playbackRateConfig || {};
 
-    if (!this.playbackRates) {
-      this.playbackRates = cfg.options || DEFAULT_PLAYBACK_RATES;
-    }
-
-    if (!this.selectedRate) {
-      this.selectedRate = cfg.defaultValue || DEFAULT_PLAYBACK_RATE;
+    if (this.rendered) {
+      return this;
     }
 
-    if (this.shouldRender()) {
-      const button = PlaybackRate.buttonTemplate({
-        title: this.getTitle(),
-        speedIcon,
-        arrowRightIcon,
-      });
-
-      this.$el.html(button);
-
-      // if (this.core.getPlaybackType() === Playback.LIVE) {
-      //   this.core.mediaControl.$playbackRate.addClass('playbackrate-enable');
-      // }
+    const button = PlaybackRate.buttonTemplate({
+      title: this.getTitle(),
+      speedIcon,
+      arrowRightIcon,
+    });
 
-      // this.core.mediaControl.$playbackRate.append(this.el);
+    this.$el.html(button);
 
-      this.core.mediaControl.$el?.find('.gear-options-list [data-rate]').html(this.el);
+    (this.core.getPlugin('bottom_gear') as BottomGear)?.getElement('rate')?.html(this.el);
 
-      // this.updateText();
-    }
+    this.rendered = true;
 
     return this;
   }
 
   private onStartAd() {
     this.prevSelectedRate = this.selectedRate;
-    this.setSelectedRate('1.0');
-    this.listenToOnce(this.currentPlayback, Events.PLAYBACK_PLAY, this.onFinishAd);
+    this.resetPlaybackRate();
+    this.listenToOnce(this.core.activePlayback, Events.PLAYBACK_PLAY, this.onFinishAd);
   }
 
   private onFinishAd() {
@@ -222,16 +218,17 @@ export class PlaybackRate extends UICorePlugin {
   }
 
   private onPlay() {
-    if (!this.core.mediaControl.$el.hasClass('dvr')) {
-      if (this.core.getPlaybackType() === Playback.LIVE) {
-        this.updatePlaybackRate(DEFAULT_PLAYBACK_RATE);
-        this.core.mediaControl.$playbackRate.addClass('playbackrate-enable');
-      }
+    if (this.core.getPlaybackType() === Playback.LIVE && !this.core.activePlayback.dvrEnabled) {
+      this.resetPlaybackRate();
     } else {
       this.setSelectedRate(this.selectedRate);
     }
   }
 
+  private resetPlaybackRate() {
+    this.setSelectedRate(DEFAULT_PLAYBACK_RATE);
+  }
+
   private onStop() {
   }
 
@@ -252,37 +249,24 @@ export class PlaybackRate extends UICorePlugin {
       arrowLeftIcon,
       checkIcon,
     }));
-
-    this.core.mediaControl.$el?.find('.gear-wrapper').html(this.el);
+    (this.core.getPlugin('bottom_gear') as BottomGear)?.setContent(this.el);
     this.highlightCurrentRate();
   }
 
   private goBack() {
-    this.core.trigger('gear:refresh');
-  }
-
-  private updatePlaybackRate(rate: string) {
-    this.setSelectedRate(rate);
+    setTimeout(() => {
+      this.core.getPlugin('bottom_gear').refresh()
+    }, 0);
   }
 
   private setSelectedRate(rate: string) {
     // Set <video playbackRate="..."
-    this.core.$el.find('video,audio').get(0).playbackRate = rate;
+    this.core.activePlayback?.setPlaybackRate(rate);
     this.selectedRate = rate;
-    // TODO
-    // Player.player.trigger('playbackRateChanged', rate);
   }
 
   private getTitle() {
-    let title = this.selectedRate;
-
-    this.playbackRates.forEach((r) => {
-      if (r.value === this.selectedRate) {
-        title = r.label;
-      }
-    });
-
-    return title;
+    return this.playbackRates.find((r) => r.value === this.selectedRate)?.label || this.selectedRate;
   }
 
   private highlightCurrentRate() {