@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
@@ -0,0 +1,20 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [BitrateTrackRecord](./player.bitratetrackrecord.md)
4
+
5
+ ## BitrateTrackRecord type
6
+
7
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export type BitrateTrackRecord = {
15
+ start: number;
16
+ end?: number;
17
+ time?: number;
18
+ bitrate: number;
19
+ };
20
+ ```
@@ -12,11 +12,11 @@ Returns the collected metrics.
12
12
  **Signature:**
13
13
 
14
14
  ```typescript
15
- exportMetrics(): Metrics;
15
+ exportMetrics(): ClapprStatsMetrics;
16
16
  ```
17
17
  **Returns:**
18
18
 
19
- Metrics
19
+ [ClapprStatsMetrics](./player.clapprstatsmetrics.md)
20
20
 
21
21
  Measurements collected so far
22
22
 
@@ -20,10 +20,6 @@ export declare class ClapprStats extends ContainerPlugin
20
20
 
21
21
  This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
22
22
 
23
- Configuration options - [ClapprStatsSettings](./player.clapprstatssettings.md)
24
-
25
- Events -
26
-
27
23
  ## Constructors
28
24
 
29
25
  <table><thead><tr><th>
@@ -0,0 +1,115 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsChronograph](./player.clapprstatschronograph.md)
4
+
5
+ ## ClapprStatsChronograph enum
6
+
7
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export declare enum ClapprStatsChronograph
15
+ ```
16
+
17
+ ## Enumeration Members
18
+
19
+ <table><thead><tr><th>
20
+
21
+ Member
22
+
23
+
24
+ </th><th>
25
+
26
+ Value
27
+
28
+
29
+ </th><th>
30
+
31
+ Description
32
+
33
+
34
+ </th></tr></thead>
35
+ <tbody><tr><td>
36
+
37
+ Buffering
38
+
39
+
40
+ </td><td>
41
+
42
+ `"buffering"`
43
+
44
+
45
+ </td><td>
46
+
47
+ **_(BETA)_**
48
+
49
+
50
+ </td></tr>
51
+ <tr><td>
52
+
53
+ Pause
54
+
55
+
56
+ </td><td>
57
+
58
+ `"pause"`
59
+
60
+
61
+ </td><td>
62
+
63
+ **_(BETA)_**
64
+
65
+
66
+ </td></tr>
67
+ <tr><td>
68
+
69
+ Session
70
+
71
+
72
+ </td><td>
73
+
74
+ `"session"`
75
+
76
+
77
+ </td><td>
78
+
79
+ **_(BETA)_**
80
+
81
+
82
+ </td></tr>
83
+ <tr><td>
84
+
85
+ Startup
86
+
87
+
88
+ </td><td>
89
+
90
+ `"startup"`
91
+
92
+
93
+ </td><td>
94
+
95
+ **_(BETA)_**
96
+
97
+
98
+ </td></tr>
99
+ <tr><td>
100
+
101
+ Watch
102
+
103
+
104
+ </td><td>
105
+
106
+ `"watch"`
107
+
108
+
109
+ </td><td>
110
+
111
+ **_(BETA)_**
112
+
113
+
114
+ </td></tr>
115
+ </tbody></table>
@@ -0,0 +1,211 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsCounter](./player.clapprstatscounter.md)
4
+
5
+ ## ClapprStatsCounter enum
6
+
7
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export declare enum ClapprStatsCounter
15
+ ```
16
+
17
+ ## Enumeration Members
18
+
19
+ <table><thead><tr><th>
20
+
21
+ Member
22
+
23
+
24
+ </th><th>
25
+
26
+ Value
27
+
28
+
29
+ </th><th>
30
+
31
+ Description
32
+
33
+
34
+ </th></tr></thead>
35
+ <tbody><tr><td>
36
+
37
+ Buffering
38
+
39
+
40
+ </td><td>
41
+
42
+ `"buffering"`
43
+
44
+
45
+ </td><td>
46
+
47
+ **_(BETA)_**
48
+
49
+
50
+ </td></tr>
51
+ <tr><td>
52
+
53
+ ChangeLevel
54
+
55
+
56
+ </td><td>
57
+
58
+ `"changeLevel"`
59
+
60
+
61
+ </td><td>
62
+
63
+ **_(BETA)_**
64
+
65
+
66
+ </td></tr>
67
+ <tr><td>
68
+
69
+ DecodedFrames
70
+
71
+
72
+ </td><td>
73
+
74
+ `"decodedFrames"`
75
+
76
+
77
+ </td><td>
78
+
79
+ **_(BETA)_**
80
+
81
+
82
+ </td></tr>
83
+ <tr><td>
84
+
85
+ DroppedFrames
86
+
87
+
88
+ </td><td>
89
+
90
+ `"droppedFrames"`
91
+
92
+
93
+ </td><td>
94
+
95
+ **_(BETA)_**
96
+
97
+
98
+ </td></tr>
99
+ <tr><td>
100
+
101
+ DvrUsage
102
+
103
+
104
+ </td><td>
105
+
106
+ `"dvrUsage"`
107
+
108
+
109
+ </td><td>
110
+
111
+ **_(BETA)_**
112
+
113
+
114
+ </td></tr>
115
+ <tr><td>
116
+
117
+ Error
118
+
119
+
120
+ </td><td>
121
+
122
+ `"error"`
123
+
124
+
125
+ </td><td>
126
+
127
+ **_(BETA)_**
128
+
129
+
130
+ </td></tr>
131
+ <tr><td>
132
+
133
+ Fps
134
+
135
+
136
+ </td><td>
137
+
138
+ `"fps"`
139
+
140
+
141
+ </td><td>
142
+
143
+ **_(BETA)_**
144
+
145
+
146
+ </td></tr>
147
+ <tr><td>
148
+
149
+ Fullscreen
150
+
151
+
152
+ </td><td>
153
+
154
+ `"fullscreen"`
155
+
156
+
157
+ </td><td>
158
+
159
+ **_(BETA)_**
160
+
161
+
162
+ </td></tr>
163
+ <tr><td>
164
+
165
+ Pause
166
+
167
+
168
+ </td><td>
169
+
170
+ `"pause"`
171
+
172
+
173
+ </td><td>
174
+
175
+ **_(BETA)_**
176
+
177
+
178
+ </td></tr>
179
+ <tr><td>
180
+
181
+ Play
182
+
183
+
184
+ </td><td>
185
+
186
+ `"play"`
187
+
188
+
189
+ </td><td>
190
+
191
+ **_(BETA)_**
192
+
193
+
194
+ </td></tr>
195
+ <tr><td>
196
+
197
+ Seek
198
+
199
+
200
+ </td><td>
201
+
202
+ `"seek"`
203
+
204
+
205
+ </td><td>
206
+
207
+ **_(BETA)_**
208
+
209
+
210
+ </td></tr>
211
+ </tbody></table>
@@ -0,0 +1,51 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsEvents](./player.clapprstatsevents.md)
4
+
5
+ ## ClapprStatsEvents enum
6
+
7
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export declare enum ClapprStatsEvents
15
+ ```
16
+
17
+ ## Enumeration Members
18
+
19
+ <table><thead><tr><th>
20
+
21
+ Member
22
+
23
+
24
+ </th><th>
25
+
26
+ Value
27
+
28
+
29
+ </th><th>
30
+
31
+ Description
32
+
33
+
34
+ </th></tr></thead>
35
+ <tbody><tr><td>
36
+
37
+ REPORT
38
+
39
+
40
+ </td><td>
41
+
42
+ `"clappr:stats:report"`
43
+
44
+
45
+ </td><td>
46
+
47
+ **_(BETA)_** Emitted periodically with current measurements.
48
+
49
+
50
+ </td></tr>
51
+ </tbody></table>
@@ -0,0 +1,52 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsMetrics](./player.clapprstatsmetrics.md)
4
+
5
+ ## ClapprStatsMetrics type
6
+
7
+ > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
+ >
9
+
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export type ClapprStatsMetrics = {
15
+ counters: {
16
+ [ClapprStatsCounter.Play]: number;
17
+ [ClapprStatsCounter.Pause]: number;
18
+ [ClapprStatsCounter.Error]: number;
19
+ [ClapprStatsCounter.Buffering]: number;
20
+ [ClapprStatsCounter.DecodedFrames]: number;
21
+ [ClapprStatsCounter.DroppedFrames]: number;
22
+ [ClapprStatsCounter.Fps]: number;
23
+ [ClapprStatsCounter.ChangeLevel]: number;
24
+ [ClapprStatsCounter.Seek]: number;
25
+ [ClapprStatsCounter.Fullscreen]: number;
26
+ [ClapprStatsCounter.DvrUsage]: number;
27
+ };
28
+ chrono: {
29
+ [ClapprStatsChronograph.Startup]: number;
30
+ [ClapprStatsChronograph.Watch]: number;
31
+ [ClapprStatsChronograph.Pause]: number;
32
+ [ClapprStatsChronograph.Buffering]: number;
33
+ [ClapprStatsChronograph.Session]: number;
34
+ };
35
+ extra: {
36
+ playbackName: string;
37
+ playbackType: string;
38
+ bitratesHistory: BitrateTrackRecord[];
39
+ bitrateWeightedMean: number;
40
+ bitrateMostUsed: number;
41
+ buffersize: number;
42
+ watchHistory: Array<[number, number]>;
43
+ watchedPercentage: number;
44
+ bufferingPercentage: number;
45
+ bandwidth: number;
46
+ duration: number;
47
+ currentTime: number;
48
+ };
49
+ };
50
+ ```
51
+ **References:** [ClapprStatsCounter.Play](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Pause](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Error](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Buffering](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DecodedFrames](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DroppedFrames](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Fps](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.ChangeLevel](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Seek](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Fullscreen](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DvrUsage](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsChronograph.Startup](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Watch](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Pause](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Buffering](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Session](./player.clapprstatschronograph.md)<!-- -->, [BitrateTrackRecord](./player.bitratetrackrecord.md)
52
+
@@ -7,7 +7,7 @@
7
7
  > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
8
  >
9
9
 
10
- Configuration options for the plugin.
10
+ Configuration options for the [Clips](./player.clips.md) plugin.
11
11
 
12
12
  **Signature:**
13
13
 
@@ -215,7 +215,7 @@ Description
215
215
 
216
216
  </td><td>
217
217
 
218
- **_(BETA)_** `PLUGIN` that displays useful network-related statistics.
218
+ **_(BETA)_** `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.
219
219
 
220
220
 
221
221
  </td></tr>
@@ -379,6 +379,39 @@ Description
379
379
  </th></tr></thead>
380
380
  <tbody><tr><td>
381
381
 
382
+ [ClapprStatsChronograph](./player.clapprstatschronograph.md)
383
+
384
+
385
+ </td><td>
386
+
387
+ **_(BETA)_**
388
+
389
+
390
+ </td></tr>
391
+ <tr><td>
392
+
393
+ [ClapprStatsCounter](./player.clapprstatscounter.md)
394
+
395
+
396
+ </td><td>
397
+
398
+ **_(BETA)_**
399
+
400
+
401
+ </td></tr>
402
+ <tr><td>
403
+
404
+ [ClapprStatsEvents](./player.clapprstatsevents.md)
405
+
406
+
407
+ </td><td>
408
+
409
+ **_(BETA)_**
410
+
411
+
412
+ </td></tr>
413
+ <tr><td>
414
+
382
415
  [GearEvents](./player.gearevents.md)
383
416
 
384
417
 
@@ -491,7 +524,7 @@ Description
491
524
 
492
525
  </td><td>
493
526
 
494
- **_(BETA)_** Configuration options for the plugin.
527
+ **_(BETA)_** Configuration options for the [Clips](./player.clips.md) plugin.
495
528
 
496
529
 
497
530
  </td></tr>
@@ -655,6 +688,28 @@ Description
655
688
  </th></tr></thead>
656
689
  <tbody><tr><td>
657
690
 
691
+ [BitrateTrackRecord](./player.bitratetrackrecord.md)
692
+
693
+
694
+ </td><td>
695
+
696
+ **_(BETA)_**
697
+
698
+
699
+ </td></tr>
700
+ <tr><td>
701
+
702
+ [ClapprStatsMetrics](./player.clapprstatsmetrics.md)
703
+
704
+
705
+ </td><td>
706
+
707
+ **_(BETA)_**
708
+
709
+
710
+ </td></tr>
711
+ <tr><td>
712
+
658
713
  [ClapprStatsSettings](./player.clapprstatssettings.md)
659
714
 
660
715
 
@@ -7,7 +7,7 @@
7
7
  > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
8
  >
9
9
 
10
- `PLUGIN` that displays useful network-related statistics.
10
+ `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.
11
11
 
12
12
  **Signature:**
13
13
 
@@ -20,9 +20,9 @@ export declare class NerdStats extends UICorePlugin
20
20
 
21
21
  Depends on:
22
22
 
23
- - [BottomGear](./player.bottomgear.md)
23
+ - [BottomGear](./player.bottomgear.md) - where the button is attached
24
24
 
25
- - [ClapprStats](./player.clapprstats.md)
25
+ - [ClapprStats](./player.clapprstats.md) - to get the metrics from
26
26
 
27
27
  The plugin is rendered as an item in the gear menu.
28
28
 
@@ -199,7 +199,7 @@ _(Optional)_ Mute the audio output in order to comply with browsers' autoplay po
199
199
 
200
200
  </td><td>
201
201
 
202
- _(Optional)_ Stream type. Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
202
+ _(Optional)_ Stream type.
203
203
 
204
204
 
205
205
  </td></tr>
@@ -4,10 +4,15 @@
4
4
 
5
5
  ## PlayerConfig.playbackType property
6
6
 
7
- Stream type. Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
7
+ Stream type.
8
8
 
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
12
  playbackType?: PlaybackType;
13
13
  ```
14
+
15
+ ## Remarks
16
+
17
+ Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
18
+
@@ -7,14 +7,17 @@
7
7
  > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8
8
  >
9
9
 
10
+ > Warning: This API is now obsolete.
11
+ >
12
+ > Use TimePosition instead
13
+ >
14
+
10
15
  For the plugin development
11
16
 
12
17
  **Signature:**
13
18
 
14
19
  ```typescript
15
- export type TimeUpdate = TimePosition & {
16
- firstFragDateTime: number;
17
- };
20
+ export type TimeUpdate = TimePosition;
18
21
  ```
19
22
  **References:** [TimePosition](./player.timeposition.md)
20
23
 
@@ -45,7 +45,6 @@ export default class DashPlayback extends BasePlayback {
45
45
  private _setupSrc;
46
46
  _startTimeUpdateTimer(): void;
47
47
  _stopTimeUpdateTimer(): void;
48
- getProgramDateTime(): number;
49
48
  getDuration(): TimeValue;
50
49
  getCurrentTime(): TimeValue;
51
50
  getStartTimeOffset(): TimeValue;
@@ -1 +1 @@
1
- {"version":3,"file":"DashPlayback.d.ts","sourceRoot":"","sources":["../../../src/playback/dash-playback/DashPlayback.ts"],"names":[],"mappings":"AAKA,OAAO,EAAe,QAAQ,EAAyB,MAAM,cAAc,CAAA;AAG3E,OAAO,MAAM,EAAE,EAIb,KAAK,WAAW,IAAI,eAAe,EAEnC,aAAa,EACd,MAAM,QAAQ,CAAA;AAEf,OAAO,EAGL,YAAY,EACZ,YAAY,EAEZ,SAAS,EACV,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAA;AAMzE,KAAK,YAAY,GACb,OAAO,QAAQ,CAAC,GAAG,GACnB,OAAO,QAAQ,CAAC,IAAI,GACpB,OAAO,QAAQ,CAAC,GAAG,GACnB,OAAO,QAAQ,CAAC,KAAK,CAAA;AAEzB,KAAK,YAAY,GAAG,MAAM,CAAA;AAE1B,KAAK,oBAAoB,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAID,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IACpD,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAO;IAErC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAO;IAKnC,mCAAmC,EAAE,OAAO,CAAQ;IAEpD,aAAa,EAAE,OAAO,CAAQ;IAI9B,uBAAuB,EAAE,MAAM,CAAI;IASnC,wBAAwB,EAAE,MAAM,CAAI;IAEpC,aAAa,EAAE,YAAY,CAAe;IAG1C,aAAa,EAAE,YAAY,GAAG,IAAI,CAAO;IAGzC,gBAAgB,EAAE,SAAS,CAAI;IAE/B,KAAK,EAAE,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAO;IAE5C,2BAA2B,EAAE,MAAM,CAAI;IAEvC,aAAa,EAAE,SAAS,GAAG,IAAI,CAAO;IAEtC,eAAe,EAAE,YAAY,CAA2B;IAIxD,0BAA0B,EAAE,oBAAoB,GAAG,IAAI,CAAO;IAI9D,wBAAwB,EAAE,oBAAoB,GAAG,IAAI,CAAO;IAE5D,kBAAkB,UAAQ;IAE1B,YAAY,EAAE,aAAa,GAAG,IAAI,CAAO;IAEzC,gBAAgB,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAO;IAE9D,IAAI,IAAI,WAEP;IAED,IAAI,MAAM,IAAI,YAAY,EAAE,CAE3B;IAED,IAAI,YAAY,IAAI,MAAM,CAMzB;IAED,IAAI,OAAO,YAEV;IAED,IAAI,YAAY,CAAC,EAAE,EAAE,MAAM,EAoC1B;IAED,IAAI,UAAU,WASb;IAED,IAAI,IAAI,WAEP;IAID,IAAI,sBAAsB,WAczB;IAID,IAAI,oBAAoB,WAgBvB;IAED,IAAI,SAAS,WAKZ;gBAEW,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,GAAG;IAOzD,MAAM;IA6FN,MAAM;IAMN,MAAM;YAMW,SAAS;IAI1B,qBAAqB;IAQrB,oBAAoB;IAMpB,kBAAkB;IAOlB,WAAW,IAAI,SAAS;IAQxB,cAAc,IAAI,SAAS;IAO3B,kBAAkB,IAAI,SAAS;IAItB,cAAc,CAAC,UAAU,EAAE,MAAM;IAejC,IAAI,CAAC,IAAI,EAAE,SAAS;IAgB7B,eAAe;IAIf,UAAU,CAAC,MAAM,EAAE,OAAO;IAMjB,eAAe;IAgBxB,OAAO,CAAC,gBAAgB,CAGvB;IAED,OAAO,CAAC,eAAe,CAmCtB;IAED,OAAO,CAAC,YAAY;IAmBX,aAAa;IAqBb,iBAAiB;IAW1B,IAAI,UAAU,YAcb;IAEQ,WAAW;IAgBX,IAAI;IAUJ,KAAK;IAUL,IAAI;IASJ,OAAO;IAkBhB,mBAAmB;IASnB,WAAW,CAAC,MAAM,EAAE,eAAe,EAAE;IAarC,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,gBAAgB;IAQxB,eAAe;IAIf,aAAa;IAIb,OAAO,CAAC,QAAQ;IAMhB,eAAe,CAAC,IAAI,EAAE,MAAM;IAI5B,IAAI,WAAW,IAAI,UAAU,EAAE,CAI9B;IAGD,IAAI,iBAAiB,IAAI,UAAU,GAAG,IAAI,CAQzC;IAED,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAQlC,OAAO,CAAC,gBAAgB;CAOzB"}
1
+ {"version":3,"file":"DashPlayback.d.ts","sourceRoot":"","sources":["../../../src/playback/dash-playback/DashPlayback.ts"],"names":[],"mappings":"AAKA,OAAO,EAAe,QAAQ,EAAyB,MAAM,cAAc,CAAA;AAG3E,OAAO,MAAM,EAAE,EAIb,KAAK,WAAW,IAAI,eAAe,EAEnC,aAAa,EACd,MAAM,QAAQ,CAAA;AAEf,OAAO,EAGL,YAAY,EACZ,YAAY,EACZ,SAAS,EACV,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,8CAA8C,CAAA;AAMzE,KAAK,YAAY,GACb,OAAO,QAAQ,CAAC,GAAG,GACnB,OAAO,QAAQ,CAAC,IAAI,GACpB,OAAO,QAAQ,CAAC,GAAG,GACnB,OAAO,QAAQ,CAAC,KAAK,CAAA;AAEzB,KAAK,YAAY,GAAG,MAAM,CAAA;AAE1B,KAAK,oBAAoB,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAID,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,YAAY;IACpD,OAAO,EAAE,YAAY,EAAE,GAAG,IAAI,CAAO;IAErC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAO;IAKnC,mCAAmC,EAAE,OAAO,CAAQ;IAEpD,aAAa,EAAE,OAAO,CAAQ;IAI9B,uBAAuB,EAAE,MAAM,CAAI;IASnC,wBAAwB,EAAE,MAAM,CAAI;IAEpC,aAAa,EAAE,YAAY,CAAe;IAG1C,aAAa,EAAE,YAAY,GAAG,IAAI,CAAO;IAEzC,gBAAgB,EAAE,SAAS,CAAI;IAE/B,KAAK,EAAE,MAAM,CAAC,gBAAgB,GAAG,IAAI,CAAO;IAE5C,2BAA2B,EAAE,MAAM,CAAI;IAEvC,aAAa,EAAE,SAAS,GAAG,IAAI,CAAO;IAEtC,eAAe,EAAE,YAAY,CAA2B;IAIxD,0BAA0B,EAAE,oBAAoB,GAAG,IAAI,CAAO;IAI9D,wBAAwB,EAAE,oBAAoB,GAAG,IAAI,CAAO;IAE5D,kBAAkB,UAAQ;IAE1B,YAAY,EAAE,aAAa,GAAG,IAAI,CAAO;IAEzC,gBAAgB,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,IAAI,CAAO;IAE9D,IAAI,IAAI,WAEP;IAED,IAAI,MAAM,IAAI,YAAY,EAAE,CAE3B;IAED,IAAI,YAAY,IAAI,MAAM,CAMzB;IAED,IAAI,OAAO,YAEV;IAED,IAAI,YAAY,CAAC,EAAE,EAAE,MAAM,EAoC1B;IAED,IAAI,UAAU,WASb;IAED,IAAI,IAAI,WAEP;IAID,IAAI,sBAAsB,WAczB;IAID,IAAI,oBAAoB,WAgBvB;IAED,IAAI,SAAS,WAKZ;gBAEW,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,GAAG;IAOzD,MAAM;IA6FN,MAAM;IAMN,MAAM;YAMW,SAAS;IAI1B,qBAAqB;IAQrB,oBAAoB;IAapB,WAAW,IAAI,SAAS;IAQxB,cAAc,IAAI,SAAS;IAO3B,kBAAkB,IAAI,SAAS;IAItB,cAAc,CAAC,UAAU,EAAE,MAAM;IAejC,IAAI,CAAC,IAAI,EAAE,SAAS;IAgB7B,eAAe;IAIf,UAAU,CAAC,MAAM,EAAE,OAAO;IAMjB,eAAe;IAgBxB,OAAO,CAAC,gBAAgB,CAGvB;IAED,OAAO,CAAC,eAAe,CAmCtB;IAED,OAAO,CAAC,YAAY;IAmBX,aAAa;IAqBb,iBAAiB;IAW1B,IAAI,UAAU,YAcb;IAEQ,WAAW;IAgBX,IAAI;IAUJ,KAAK;IAUL,IAAI;IASJ,OAAO;IAkBhB,mBAAmB;IASnB,WAAW,CAAC,MAAM,EAAE,eAAe,EAAE;IAarC,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,gBAAgB;IAQxB,eAAe;IAIf,aAAa;IAIb,OAAO,CAAC,QAAQ;IAMhB,eAAe,CAAC,IAAI,EAAE,MAAM;IAI5B,IAAI,WAAW,IAAI,UAAU,EAAE,CAI9B;IAGD,IAAI,iBAAiB,IAAI,UAAU,GAAG,IAAI,CAQzC;IAED,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAQlC,OAAO,CAAC,gBAAgB;CAOzB"}
@@ -35,7 +35,6 @@ export default class DashPlayback extends BasePlayback {
35
35
  _playbackType = Playback.VOD;
36
36
  // #EXT-X-PLAYLIST-TYPE
37
37
  _playlistType = null;
38
- // #EXT-X-PROGRAM-DATE-TIME
39
38
  _programDateTime = 0;
40
39
  _dash = null;
41
40
  _extrapolatedWindowDuration = 0;
@@ -223,9 +222,9 @@ export default class DashPlayback extends BasePlayback {
223
222
  clearInterval(this._timeUpdateTimer);
224
223
  }
225
224
  }
226
- getProgramDateTime() {
227
- return this._programDateTime;
228
- }
225
+ // getProgramDateTime() {
226
+ // return this._programDateTime
227
+ // }
229
228
  // the duration on the video element itself should not be used
230
229
  // as this does not necesarily represent the duration of the stream
231
230
  // https://github.com/clappr/clappr/issues/668#issuecomment-157036678
@@ -344,7 +343,7 @@ export default class DashPlayback extends BasePlayback {
344
343
  const update = {
345
344
  current: this.getCurrentTime(),
346
345
  total: this.getDuration(),
347
- firstFragDateTime: this.getProgramDateTime(),
346
+ // firstFragDateTime: this.getProgramDateTime(), // TODO figure out if needed
348
347
  };
349
348
  const isSame = this._lastTimeUpdate &&
350
349
  update.current === this._lastTimeUpdate.current &&