@gcorevideo/player 2.22.17 → 2.22.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/assets/audio-selector/track-selector.ejs +3 -3
  2. package/assets/bottom-gear/bottomgear.ejs +3 -3
  3. package/assets/clappr-nerd-stats/clappr-nerd-stats.ejs +76 -78
  4. package/assets/clappr-nerd-stats/clappr-nerd-stats.scss +10 -7
  5. package/assets/dvr-controls/dvr_controls.scss +0 -12
  6. package/dist/core.js +5 -7
  7. package/dist/index.css +1245 -1251
  8. package/dist/index.js +425 -261
  9. package/dist/player.d.ts +121 -108
  10. package/dist/plugins/index.css +577 -583
  11. package/dist/plugins/index.js +355 -187
  12. package/docs/api/player.bitratetrackrecord.md +20 -0
  13. package/docs/api/player.clapprstats.exportmetrics.md +2 -2
  14. package/docs/api/player.clapprstats.md +0 -4
  15. package/docs/api/player.clapprstatschronograph.md +115 -0
  16. package/docs/api/player.clapprstatscounter.md +211 -0
  17. package/docs/api/player.clapprstatsevents.md +51 -0
  18. package/docs/api/player.clapprstatsmetrics.md +52 -0
  19. package/docs/api/player.clipspluginsettings.md +1 -1
  20. package/docs/api/player.md +57 -2
  21. package/docs/api/player.nerdstats.md +3 -3
  22. package/docs/api/player.playerconfig.md +1 -1
  23. package/docs/api/player.playerconfig.playbacktype.md +6 -1
  24. package/docs/api/player.timeupdate.md +6 -3
  25. package/lib/playback/dash-playback/DashPlayback.d.ts +0 -1
  26. package/lib/playback/dash-playback/DashPlayback.d.ts.map +1 -1
  27. package/lib/playback/dash-playback/DashPlayback.js +4 -5
  28. package/lib/playback/hls-playback/HlsPlayback.d.ts +1 -1
  29. package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
  30. package/lib/playback/hls-playback/HlsPlayback.js +0 -1
  31. package/lib/playback.types.d.ts +2 -3
  32. package/lib/playback.types.d.ts.map +1 -1
  33. package/lib/plugins/audio-selector/AudioSelector.d.ts +1 -1
  34. package/lib/plugins/audio-selector/AudioSelector.d.ts.map +1 -1
  35. package/lib/plugins/audio-selector/AudioSelector.js +15 -8
  36. package/lib/plugins/bottom-gear/BottomGear.d.ts +1 -1
  37. package/lib/plugins/bottom-gear/BottomGear.js +2 -2
  38. package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts +17 -14
  39. package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts.map +1 -1
  40. package/lib/plugins/clappr-nerd-stats/NerdStats.js +175 -124
  41. package/lib/plugins/clappr-nerd-stats/formatter.d.ts +5 -0
  42. package/lib/plugins/clappr-nerd-stats/formatter.d.ts.map +1 -1
  43. package/lib/plugins/clappr-nerd-stats/formatter.js +56 -24
  44. package/lib/plugins/clappr-nerd-stats/speedtest/index.d.ts +2 -2
  45. package/lib/plugins/clappr-nerd-stats/speedtest/index.d.ts.map +1 -1
  46. package/lib/plugins/clappr-nerd-stats/speedtest/types.d.ts +1 -1
  47. package/lib/plugins/clappr-nerd-stats/speedtest/types.d.ts.map +1 -1
  48. package/lib/plugins/clappr-nerd-stats/types.d.ts +3 -0
  49. package/lib/plugins/clappr-nerd-stats/types.d.ts.map +1 -1
  50. package/lib/plugins/clappr-nerd-stats/utils.d.ts +7 -0
  51. package/lib/plugins/clappr-nerd-stats/utils.d.ts.map +1 -0
  52. package/lib/plugins/clappr-nerd-stats/utils.js +67 -0
  53. package/lib/plugins/clappr-stats/ClapprStats.d.ts +5 -2
  54. package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
  55. package/lib/plugins/clappr-stats/ClapprStats.js +31 -33
  56. package/lib/plugins/clappr-stats/types.d.ts +21 -22
  57. package/lib/plugins/clappr-stats/types.d.ts.map +1 -1
  58. package/lib/plugins/clappr-stats/types.js +22 -22
  59. package/lib/plugins/clappr-stats/utils.d.ts +2 -2
  60. package/lib/plugins/clappr-stats/utils.d.ts.map +1 -1
  61. package/lib/plugins/clappr-stats/utils.js +0 -1
  62. package/lib/plugins/click-to-pause/ClickToPause.js +1 -1
  63. package/lib/plugins/clips/Clips.d.ts +1 -1
  64. package/lib/plugins/dvr-controls/DvrControls.d.ts +6 -2
  65. package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
  66. package/lib/plugins/dvr-controls/DvrControls.js +39 -27
  67. package/lib/plugins/media-control/MediaControl.d.ts +6 -2
  68. package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
  69. package/lib/plugins/media-control/MediaControl.js +20 -9
  70. package/lib/plugins/picture-in-picture/PictureInPicture.js +1 -1
  71. package/lib/plugins/seek-time/SeekTime.d.ts +1 -1
  72. package/lib/plugins/seek-time/SeekTime.d.ts.map +1 -1
  73. package/lib/plugins/seek-time/SeekTime.js +3 -4
  74. package/lib/plugins/subtitles/ClosedCaptions.js +1 -1
  75. package/lib/plugins/vast-ads/VastAds.js +1 -1
  76. package/lib/plugins/vast-ads/rollmanager.js +1 -1
  77. package/lib/testUtils.d.ts.map +1 -1
  78. package/lib/testUtils.js +7 -4
  79. package/lib/types.d.ts +1 -1
  80. package/package.json +3 -3
  81. package/src/playback/__tests__/HTML5Video.test.ts +2 -2
  82. package/src/playback/dash-playback/DashPlayback.ts +5 -7
  83. package/src/playback/hls-playback/HlsPlayback.ts +2 -4
  84. package/src/playback.types.ts +2 -3
  85. package/src/plugins/audio-selector/AudioSelector.ts +14 -7
  86. package/src/plugins/audio-selector/__tests__/AudioSelector.test.ts +8 -8
  87. package/src/plugins/audio-selector/__tests__/__snapshots__/AudioSelector.test.ts.snap +15 -15
  88. package/src/plugins/bottom-gear/BottomGear.ts +2 -2
  89. package/src/plugins/bottom-gear/__tests__/BottomGear.test.ts +8 -5
  90. package/src/plugins/bottom-gear/__tests__/__snapshots__/BottomGear.test.ts.snap +3 -3
  91. package/src/plugins/clappr-nerd-stats/NerdStats.ts +216 -143
  92. package/src/plugins/clappr-nerd-stats/formatter.ts +91 -47
  93. package/src/plugins/clappr-nerd-stats/speedtest/index.ts +2 -2
  94. package/src/plugins/clappr-nerd-stats/speedtest/types.ts +1 -1
  95. package/src/plugins/clappr-nerd-stats/types.ts +43 -3
  96. package/src/plugins/clappr-nerd-stats/utils.ts +75 -0
  97. package/src/plugins/clappr-stats/ClapprStats.ts +41 -40
  98. package/src/plugins/clappr-stats/__tests__/ClapprStats.test.ts +12 -12
  99. package/src/plugins/clappr-stats/types.ts +43 -44
  100. package/src/plugins/clappr-stats/utils.ts +4 -5
  101. package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
  102. package/src/plugins/clips/Clips.ts +1 -1
  103. package/src/plugins/clips/__tests__/Clips.test.ts +1 -1
  104. package/src/plugins/clips/__tests__/__snapshots__/Clips.test.ts.snap +1 -1
  105. package/src/plugins/dvr-controls/DvrControls.ts +51 -37
  106. package/src/plugins/dvr-controls/__tests__/DvrControls.test.ts +84 -26
  107. package/src/plugins/dvr-controls/__tests__/__snapshots__/DvrControls.test.ts.snap +0 -12
  108. package/src/plugins/media-control/MediaControl.ts +21 -9
  109. package/src/plugins/media-control/__tests__/MediaControl.test.ts +8 -5
  110. package/src/plugins/media-control/__tests__/__snapshots__/MediaControl.test.ts.snap +20 -20
  111. package/src/plugins/picture-in-picture/PictureInPicture.ts +1 -1
  112. package/src/plugins/seek-time/SeekTime.ts +4 -5
  113. package/src/plugins/subtitles/ClosedCaptions.ts +1 -1
  114. package/src/plugins/subtitles/__tests__/ClosedCaptions.test.ts +1 -1
  115. package/src/plugins/vast-ads/VastAds.ts +1 -1
  116. package/src/plugins/vast-ads/rollmanager.ts +1 -1
  117. package/src/testUtils.ts +11 -5
  118. package/src/types.ts +1 -1
  119. package/temp/player.api.json +630 -12
  120. package/tsconfig.tsbuildinfo +1 -1
@@ -1,6 +1,6 @@
1
1
  // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2
2
 
3
- exports[`MediaControl > putElement > audiotracks > should put the element in the right panel 1`] = `
3
+ exports[`MediaControl > mount > audiotracks > should put the element in the right panel 1`] = `
4
4
  "<div class="media-control-background" data-background=""></div>
5
5
 
6
6
  <div class="media-control-layer gcore-skin-bg-color" data-controls="">
@@ -26,9 +26,9 @@ exports[`MediaControl > putElement > audiotracks > should put the element in the
26
26
 
27
27
  <div class="bar-container" data-volume="">
28
28
  <div class="bar-background" data-volume="">
29
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
29
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
30
30
  </div>
31
- <div class="bar-scrubber" data-volume="" style="">
31
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
32
32
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
33
33
  </div>
34
34
  </div>
@@ -55,7 +55,7 @@ exports[`MediaControl > putElement > audiotracks > should put the element in the
55
55
  <style>:root {}</style>"
56
56
  `;
57
57
 
58
- exports[`MediaControl > putElement > cc > should put the element in the right panel 1`] = `
58
+ exports[`MediaControl > mount > cc > should put the element in the right panel 1`] = `
59
59
  "<div class="media-control-background" data-background=""></div>
60
60
 
61
61
  <div class="media-control-layer gcore-skin-bg-color" data-controls="">
@@ -81,9 +81,9 @@ exports[`MediaControl > putElement > cc > should put the element in the right pa
81
81
 
82
82
  <div class="bar-container" data-volume="">
83
83
  <div class="bar-background" data-volume="">
84
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
84
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
85
85
  </div>
86
- <div class="bar-scrubber" data-volume="" style="">
86
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
87
87
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
88
88
  </div>
89
89
  </div>
@@ -110,7 +110,7 @@ exports[`MediaControl > putElement > cc > should put the element in the right pa
110
110
  <style>:root {}</style>"
111
111
  `;
112
112
 
113
- exports[`MediaControl > putElement > gear > should put the element in the right panel 1`] = `
113
+ exports[`MediaControl > mount > gear > should put the element in the right panel 1`] = `
114
114
  "<div class="media-control-background" data-background=""></div>
115
115
 
116
116
  <div class="media-control-layer gcore-skin-bg-color" data-controls="">
@@ -136,9 +136,9 @@ exports[`MediaControl > putElement > gear > should put the element in the right
136
136
 
137
137
  <div class="bar-container" data-volume="">
138
138
  <div class="bar-background" data-volume="">
139
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
139
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
140
140
  </div>
141
- <div class="bar-scrubber" data-volume="" style="">
141
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
142
142
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
143
143
  </div>
144
144
  </div>
@@ -165,7 +165,7 @@ exports[`MediaControl > putElement > gear > should put the element in the right
165
165
  <style>:root {}</style>"
166
166
  `;
167
167
 
168
- exports[`MediaControl > putElement > pip > should put the element in the right panel 1`] = `
168
+ exports[`MediaControl > mount > pip > should put the element in the right panel 1`] = `
169
169
  "<div class="media-control-background" data-background=""></div>
170
170
 
171
171
  <div class="media-control-layer gcore-skin-bg-color" data-controls="">
@@ -191,9 +191,9 @@ exports[`MediaControl > putElement > pip > should put the element in the right p
191
191
 
192
192
  <div class="bar-container" data-volume="">
193
193
  <div class="bar-background" data-volume="">
194
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
194
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
195
195
  </div>
196
- <div class="bar-scrubber" data-volume="" style="">
196
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
197
197
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
198
198
  </div>
199
199
  </div>
@@ -248,9 +248,9 @@ exports[`MediaControl > rendering timing > once metadata is loaded > should wait
248
248
 
249
249
  <div class="bar-container" data-volume="">
250
250
  <div class="bar-background" data-volume="">
251
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
251
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
252
252
  </div>
253
- <div class="bar-scrubber" data-volume="" style="">
253
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
254
254
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
255
255
  </div>
256
256
  </div>
@@ -271,11 +271,11 @@ exports[`MediaControl > rendering timing > once metadata is loaded > should wait
271
271
  <div class="bar-container" data-seekbar="">
272
272
  <div class="bar-background" data-seekbar="">
273
273
  <div class="bar-fill-1" data-seekbar=""></div>
274
- <div class="bar-fill-2 gcore-skin-main-color" data-seekbar="" style=""></div>
274
+ <div class="bar-fill-2 gcore-skin-main-color" data-seekbar="" style="width: 0%;"></div>
275
275
  <div class="bar-hover" data-seekbar=""></div>
276
276
  </div>
277
277
  </div>
278
- <div class="bar-scrubber" data-seekbar="" style="">
278
+ <div class="bar-scrubber" data-seekbar="" style="left: 0%;">
279
279
  <div class="bar-scrubber-icon gcore-skin-main-color" data-seekbar=""></div>
280
280
  </div>
281
281
 
@@ -324,9 +324,9 @@ exports[`MediaControl > updateSettings > dvr > when disabled > should disable DV
324
324
 
325
325
  <div class="bar-container" data-volume="">
326
326
  <div class="bar-background" data-volume="">
327
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
327
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
328
328
  </div>
329
- <div class="bar-scrubber" data-volume="" style="">
329
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
330
330
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
331
331
  </div>
332
332
  </div>
@@ -385,9 +385,9 @@ exports[`MediaControl > updateSettings > dvr > when enabled > should enable DVR
385
385
 
386
386
  <div class="bar-container" data-volume="">
387
387
  <div class="bar-background" data-volume="">
388
- <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style=""></div>
388
+ <div class="bar-fill-1 gcore-skin-main-color" data-volume="" style="width: 100%;"></div>
389
389
  </div>
390
- <div class="bar-scrubber" data-volume="" style="">
390
+ <div class="bar-scrubber" data-volume="" style="left: 100%;">
391
391
  <div class="bar-scrubber-icon gcore-skin-main-color" data-volume=""></div>
392
392
  </div>
393
393
  </div>
@@ -97,7 +97,7 @@ export class PictureInPicture extends UICorePlugin {
97
97
 
98
98
  const mediaControl = this.core.getPlugin('media_control');
99
99
  if (mediaControl) {
100
- mediaControl.putElement('pip', this.$el);
100
+ mediaControl.mount('pip', this.$el);
101
101
  }
102
102
 
103
103
  return this;
@@ -3,7 +3,7 @@
3
3
  // license that can be found at https://github.com/clappr/clappr-plugins/blob/master/LICENSE
4
4
 
5
5
  import { Events, Playback, UICorePlugin, Utils, template } from '@clappr/core';
6
- import { TimeUpdate } from '../../playback.types.js';
6
+ import { TimePosition } from '../../playback.types.js';
7
7
 
8
8
  import { CLAPPR_VERSION } from '../../build.js';
9
9
 
@@ -79,7 +79,7 @@ export class SeekTime extends UICorePlugin {
79
79
  this.listenTo(this.mediaControl, Events.MEDIACONTROL_CONTAINERCHANGED, this.onContainerChanged);
80
80
  if (this.mediaControlContainer) {
81
81
  this.listenTo(this.mediaControlContainer, Events.CONTAINER_PLAYBACKDVRSTATECHANGED, this.update);
82
- this.listenTo(this.mediaControlContainer, Events.CONTAINER_TIMEUPDATE, this.updateDuration);
82
+ this.listenTo(this.mediaControlContainer, Events.CONTAINER_TIMEUPDATE, this.onTimeUpdate);
83
83
  }
84
84
  }
85
85
 
@@ -89,9 +89,8 @@ export class SeekTime extends UICorePlugin {
89
89
  this.bindEvents();
90
90
  }
91
91
 
92
- private updateDuration(timeProgress: TimeUpdate) {
93
- this.duration = timeProgress.total;
94
- // this.firstFragDateTime = timeProgress.firstFragDateTime;
92
+ private onTimeUpdate({ total }: TimePosition) {
93
+ this.duration = total;
95
94
  this.update();
96
95
  }
97
96
 
@@ -337,7 +337,7 @@ export class ClosedCaptions extends UICorePlugin {
337
337
  this.resizeFont()
338
338
 
339
339
  this.core.activeContainer.$el.append(this.$line)
340
- mediaControl.putElement('cc', this.$el)
340
+ mediaControl.mount('cc', this.$el)
341
341
 
342
342
  this.updateSelection()
343
343
 
@@ -53,7 +53,7 @@ describe('ClosedCaptions', () => {
53
53
  it('should render', () => {
54
54
  expect(cc.el.innerHTML).toMatchSnapshot()
55
55
  expect(cc.$el.find('[data-cc-button]').length).toEqual(1)
56
- expect(mediaControl.putElement).toHaveBeenCalledWith('cc', cc.$el)
56
+ expect(mediaControl.mount).toHaveBeenCalledWith('cc', cc.$el)
57
57
  })
58
58
  })
59
59
  })
@@ -627,7 +627,7 @@ export class VastAds extends UICorePlugin {
627
627
 
628
628
  // Attempt to get click-to-pause plugin. (May interfere with advert click handling)
629
629
  this._clickToPausePlugin = this._container?.getPlugin(
630
- 'click_to_pause_custom',
630
+ 'click_to_pause',
631
631
  )
632
632
 
633
633
  assert(this.playback, 'playback is not defined')
@@ -72,7 +72,7 @@ export default class RollManager extends Events {
72
72
  this._playback = this.core.activePlayback;
73
73
  this._contentElement = this._playback.el as HTMLMediaElement;
74
74
  this._posterPlugin = this._container.getPlugin('poster');
75
- this._clickToPausePlugin = this._container.getPlugin('click_to_pause_custom');
75
+ this._clickToPausePlugin = this._container.getPlugin('click_to_pause');
76
76
  this._adContainer = _adContainer;
77
77
  this._events = {};
78
78
  this._pr = Math.floor(Math.random() * 1000000);
package/src/testUtils.ts CHANGED
@@ -100,7 +100,7 @@ export function createMockCore(
100
100
  ...options,
101
101
  },
102
102
  configure: vi.fn(),
103
- getPlaybackType: vi.fn().mockReturnValue(Playback.LIVE),
103
+ getPlaybackType: vi.fn(),
104
104
  getPlugin: vi.fn(),
105
105
  load: vi.fn(),
106
106
  trigger: emitter.emit,
@@ -140,7 +140,7 @@ export function createMockPlayback(name = 'mock') {
140
140
  getDuration: vi.fn().mockImplementation(() => 100),
141
141
  enterPiP: vi.fn(),
142
142
  exitPiP: vi.fn(),
143
- getPlaybackType: vi.fn().mockImplementation(() => Playback.LIVE),
143
+ getPlaybackType: vi.fn(),
144
144
  getStartTimeOffset: vi.fn().mockImplementation(() => 0),
145
145
  getCurrentTime: vi.fn().mockImplementation(() => 0),
146
146
  isHighDefinitionInUse: vi.fn().mockImplementation(() => false),
@@ -157,7 +157,10 @@ export function createMockPlayback(name = 'mock') {
157
157
  })
158
158
  }
159
159
 
160
- export function createMockContainer(options: Record<string, unknown> = {}, playback: any = createMockPlayback()) {
160
+ export function createMockContainer(
161
+ options: Record<string, unknown> = {},
162
+ playback: any = createMockPlayback(),
163
+ ) {
161
164
  const el = playback.el
162
165
  const emitter = new Events()
163
166
  return Object.assign(emitter, {
@@ -167,7 +170,7 @@ export function createMockContainer(options: Record<string, unknown> = {}, playb
167
170
  $el: $(el),
168
171
  getDuration: vi.fn().mockReturnValue(0),
169
172
  getPlugin: vi.fn(),
170
- getPlaybackType: vi.fn().mockReturnValue(Playback.LIVE),
173
+ getPlaybackType: vi.fn(),
171
174
  isDvrInUse: vi.fn().mockReturnValue(false),
172
175
  isDvrEnabled: vi.fn().mockReturnValue(false),
173
176
  isPlaying: vi.fn().mockReturnValue(false),
@@ -202,7 +205,10 @@ export function createMockBottomGear(core: any) {
202
205
  if (existing.length) {
203
206
  return existing
204
207
  }
205
- return $('<li></li>').attr(`data-${name}`, '').append($el).appendTo(plugin.$el)
208
+ return $('<li></li>')
209
+ .attr(`data-${name}`, '')
210
+ .append($el)
211
+ .appendTo(plugin.$el)
206
212
  })
207
213
  plugin.refresh = vi.fn()
208
214
  return plugin
package/src/types.ts CHANGED
@@ -163,7 +163,7 @@ export interface PlayerConfig extends Record<string, unknown> {
163
163
 
164
164
  /**
165
165
  * Stream type.
166
- * @remark
166
+ * @remarks
167
167
  * Should only be set if known in advance, as it should not change once determined.
168
168
  * Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
169
169
  */