@gcorevideo/player 2.20.1 → 2.20.4

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 (289) hide show
  1. package/dist/core.js +30 -6
  2. package/dist/index.css +1572 -1572
  3. package/dist/index.js +343 -226
  4. package/dist/player.d.ts +280 -52
  5. package/dist/plugins/index.css +619 -619
  6. package/dist/plugins/index.js +1468 -1351
  7. package/docs/api/player.audioselector.md +1 -251
  8. package/docs/api/player.bigmutebutton.md +1 -156
  9. package/docs/api/player.clapprstats.exportmetrics.md +4 -0
  10. package/docs/api/player.clapprstats.md +7 -223
  11. package/docs/api/player.clapprstats.setupdatemetrics.md +2 -0
  12. package/docs/api/player.clicktopause.md +5 -113
  13. package/docs/api/player.clipsplugin.gettext.md +9 -0
  14. package/docs/api/player.clipsplugin.md +10 -94
  15. package/docs/api/player.clipspluginsettings.md +57 -0
  16. package/docs/api/player.clipspluginsettings.text.md +13 -0
  17. package/docs/api/player.contextmenu._constructor_.md +6 -3
  18. package/docs/api/player.contextmenu.md +13 -256
  19. package/docs/api/{player.audioselector.bindevents.md → player.contextmenupluginsettings.label.md} +3 -7
  20. package/docs/api/player.contextmenupluginsettings.md +98 -0
  21. package/docs/api/{player.audioselector.attributes.md → player.contextmenupluginsettings.preventshowcontextmenu.md} +3 -6
  22. package/docs/api/{player.audioselector.reload.md → player.contextmenupluginsettings.url.md} +3 -7
  23. package/docs/api/player.dvrcontrols.md +1 -1
  24. package/docs/api/player.errorscreen.md +0 -2
  25. package/docs/api/player.favicon._constructor_.md +3 -0
  26. package/docs/api/player.favicon.bindevents.md +3 -0
  27. package/docs/api/player.favicon.configure.md +3 -0
  28. package/docs/api/player.favicon.destroy.md +3 -0
  29. package/docs/api/player.favicon.disable.md +3 -0
  30. package/docs/api/player.favicon.md +18 -1
  31. package/docs/api/player.favicon.name.md +3 -0
  32. package/docs/api/player.favicon.supportedversion.md +3 -0
  33. package/docs/api/player.gearevents.md +4 -1
  34. package/docs/api/player.googleanalytics._constructor_.md +3 -0
  35. package/docs/api/player.googleanalytics.addeventlisteners.md +3 -0
  36. package/docs/api/player.googleanalytics.embedscript.md +3 -0
  37. package/docs/api/player.googleanalytics.md +42 -1
  38. package/docs/api/player.googleanalytics.name.md +3 -0
  39. package/docs/api/player.googleanalytics.onbufferfull.md +3 -0
  40. package/docs/api/player.googleanalytics.onbuffering.md +3 -0
  41. package/docs/api/player.googleanalytics.ondvr.md +3 -0
  42. package/docs/api/player.googleanalytics.onended.md +3 -0
  43. package/docs/api/player.googleanalytics.onerror.md +3 -0
  44. package/docs/api/player.googleanalytics.onfullscreen.md +3 -0
  45. package/docs/api/player.googleanalytics.onhd.md +3 -0
  46. package/docs/api/player.googleanalytics.onpause.md +3 -0
  47. package/docs/api/player.googleanalytics.onplay.md +3 -0
  48. package/docs/api/player.googleanalytics.onready.md +3 -0
  49. package/docs/api/player.googleanalytics.onseek.md +3 -0
  50. package/docs/api/player.googleanalytics.onstop.md +3 -0
  51. package/docs/api/player.googleanalytics.onvolumechanged.md +3 -0
  52. package/docs/api/player.googleanalytics.push.md +3 -0
  53. package/docs/api/player.googleanalytics.supportedversion.md +3 -0
  54. package/docs/api/player.initeventdata.event.md +3 -0
  55. package/docs/api/player.initeventdata.md +7 -0
  56. package/docs/api/player.logo._constructor_.md +3 -0
  57. package/docs/api/player.logo.attributes.md +3 -0
  58. package/docs/api/player.logo.bindevents.md +3 -0
  59. package/docs/api/player.logo.md +20 -1
  60. package/docs/api/player.logo.name.md +3 -0
  61. package/docs/api/player.logo.render.md +3 -0
  62. package/docs/api/player.logo.stoplistening.md +3 -0
  63. package/docs/api/player.logo.supportedversion.md +3 -0
  64. package/docs/api/player.logo.template.md +3 -0
  65. package/docs/api/player.md +73 -21
  66. package/docs/api/player.mediacontrolelement.md +1 -1
  67. package/docs/api/player.multicamera._constructor_.md +3 -0
  68. package/docs/api/player.multicamera.activebyid.md +3 -0
  69. package/docs/api/player.multicamera.attributes.md +3 -0
  70. package/docs/api/player.multicamera.bindevents.md +3 -0
  71. package/docs/api/player.multicamera.events.md +3 -0
  72. package/docs/api/player.multicamera.getcameraslist.md +3 -0
  73. package/docs/api/player.multicamera.getcurrentcamera.md +3 -0
  74. package/docs/api/player.multicamera.md +30 -1
  75. package/docs/api/player.multicamera.name.md +3 -0
  76. package/docs/api/player.multicamera.render.md +3 -0
  77. package/docs/api/player.multicamera.supportedversion.md +3 -0
  78. package/docs/api/player.multicamera.template.md +3 -0
  79. package/docs/api/player.multicamera.unbindevents.md +3 -0
  80. package/docs/api/player.multicamera.version.md +3 -0
  81. package/docs/api/player.seektime.attributes.md +3 -0
  82. package/docs/api/player.seektime.bindevents.md +3 -0
  83. package/docs/api/player.seektime.durationshown.md +3 -0
  84. package/docs/api/player.seektime.getseektime.md +3 -0
  85. package/docs/api/player.seektime.islivestreamwithdvr.md +3 -0
  86. package/docs/api/player.seektime.md +31 -0
  87. package/docs/api/player.seektime.mediacontrol.md +3 -0
  88. package/docs/api/player.seektime.mediacontrolcontainer.md +3 -0
  89. package/docs/api/player.seektime.name.md +3 -0
  90. package/docs/api/player.seektime.render.md +3 -0
  91. package/docs/api/player.seektime.shouldbevisible.md +3 -0
  92. package/docs/api/player.seektime.supportedversion.md +3 -0
  93. package/docs/api/player.seektime.template.md +3 -0
  94. package/docs/api/player.seektime.update.md +3 -0
  95. package/docs/api/player.share.md +2 -0
  96. package/docs/api/player.skiptime.md +2 -0
  97. package/docs/api/player.stalleventdata.count.md +3 -0
  98. package/docs/api/player.stalleventdata.event.md +3 -0
  99. package/docs/api/player.stalleventdata.md +8 -3
  100. package/docs/api/player.stalleventdata.time.md +3 -0
  101. package/docs/api/player.stalleventdata.total_ms.md +3 -0
  102. package/docs/api/player.starteventdata.event.md +3 -0
  103. package/docs/api/player.starteventdata.md +7 -0
  104. package/docs/api/player.telemetryevent.md +11 -0
  105. package/docs/api/player.telemetryeventdata.md +3 -0
  106. package/docs/api/player.telemetrypluginsettings.md +4 -1
  107. package/docs/api/player.telemetrypluginsettings.send.md +3 -0
  108. package/docs/api/player.telemetryrecord.md +3 -0
  109. package/docs/api/player.thumbnails.md +21 -139
  110. package/docs/api/player.thumbnailspluginsettings.md +23 -0
  111. package/docs/api/player.volumefade.md +1 -0
  112. package/docs/api/player.volumefadeevents.md +7 -0
  113. package/docs/api/player.watcheventdata.event.md +3 -0
  114. package/docs/api/player.watcheventdata.md +7 -0
  115. package/docs/api/player.zeptoresult.md +1 -0
  116. package/lib/Player.d.ts +5 -3
  117. package/lib/Player.d.ts.map +1 -1
  118. package/lib/Player.js +30 -6
  119. package/lib/index.plugins.d.ts +0 -1
  120. package/lib/index.plugins.d.ts.map +1 -1
  121. package/lib/index.plugins.js +0 -1
  122. package/lib/internal.types.d.ts +7 -7
  123. package/lib/internal.types.d.ts.map +1 -1
  124. package/lib/plugins/audio-selector/AudioSelector.d.ts +28 -6
  125. package/lib/plugins/audio-selector/AudioSelector.d.ts.map +1 -1
  126. package/lib/plugins/audio-selector/AudioSelector.js +52 -22
  127. package/lib/plugins/big-mute-button/BigMuteButton.d.ts +18 -2
  128. package/lib/plugins/big-mute-button/BigMuteButton.d.ts.map +1 -1
  129. package/lib/plugins/big-mute-button/BigMuteButton.js +21 -16
  130. package/lib/plugins/bottom-gear/BottomGear.d.ts +1 -0
  131. package/lib/plugins/bottom-gear/BottomGear.d.ts.map +1 -1
  132. package/lib/plugins/bottom-gear/BottomGear.js +1 -0
  133. package/lib/plugins/clappr-stats/ClapprStats.d.ts +31 -8
  134. package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
  135. package/lib/plugins/clappr-stats/ClapprStats.js +24 -0
  136. package/lib/plugins/clappr-stats/types.d.ts +12 -0
  137. package/lib/plugins/clappr-stats/types.d.ts.map +1 -1
  138. package/lib/plugins/clappr-stats/types.js +3 -0
  139. package/lib/plugins/click-to-pause/ClickToPause.d.ts +13 -1
  140. package/lib/plugins/click-to-pause/ClickToPause.d.ts.map +1 -1
  141. package/lib/plugins/click-to-pause/ClickToPause.js +14 -4
  142. package/lib/plugins/clips/Clips.d.ts +34 -2
  143. package/lib/plugins/clips/Clips.d.ts.map +1 -1
  144. package/lib/plugins/clips/Clips.js +51 -22
  145. package/lib/plugins/context-menu/ContextMenu.d.ts +44 -13
  146. package/lib/plugins/context-menu/ContextMenu.d.ts.map +1 -1
  147. package/lib/plugins/context-menu/ContextMenu.js +48 -36
  148. package/lib/plugins/dvr-controls/DvrControls.d.ts +1 -3
  149. package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
  150. package/lib/plugins/dvr-controls/DvrControls.js +11 -28
  151. package/lib/plugins/error-screen/ErrorScreen.d.ts +0 -1
  152. package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
  153. package/lib/plugins/error-screen/ErrorScreen.js +0 -1
  154. package/lib/plugins/favicon/Favicon.d.ts +4 -0
  155. package/lib/plugins/favicon/Favicon.d.ts.map +1 -1
  156. package/lib/plugins/favicon/Favicon.js +4 -0
  157. package/lib/plugins/google-analytics/GoogleAnalytics.d.ts +4 -0
  158. package/lib/plugins/google-analytics/GoogleAnalytics.d.ts.map +1 -1
  159. package/lib/plugins/google-analytics/GoogleAnalytics.js +5 -1
  160. package/lib/plugins/index.d.ts +0 -1
  161. package/lib/plugins/index.d.ts.map +1 -1
  162. package/lib/plugins/index.js +0 -1
  163. package/lib/plugins/logo/Logo.d.ts +4 -0
  164. package/lib/plugins/logo/Logo.d.ts.map +1 -1
  165. package/lib/plugins/logo/Logo.js +4 -0
  166. package/lib/plugins/media-control/MediaControl.d.ts +1 -1
  167. package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
  168. package/lib/plugins/media-control/MediaControl.js +3 -1
  169. package/lib/plugins/multi-camera/MultiCamera.d.ts +4 -0
  170. package/lib/plugins/multi-camera/MultiCamera.d.ts.map +1 -1
  171. package/lib/plugins/multi-camera/MultiCamera.js +6 -2
  172. package/lib/plugins/seek-time/SeekTime.d.ts +4 -0
  173. package/lib/plugins/seek-time/SeekTime.d.ts.map +1 -1
  174. package/lib/plugins/seek-time/SeekTime.js +6 -2
  175. package/lib/plugins/share/Share.d.ts +3 -0
  176. package/lib/plugins/share/Share.d.ts.map +1 -1
  177. package/lib/plugins/share/Share.js +4 -1
  178. package/lib/plugins/skip-time/SkipTime.d.ts +3 -0
  179. package/lib/plugins/skip-time/SkipTime.d.ts.map +1 -1
  180. package/lib/plugins/skip-time/SkipTime.js +3 -0
  181. package/lib/plugins/telemetry/Telemetry.d.ts +18 -0
  182. package/lib/plugins/telemetry/Telemetry.d.ts.map +1 -1
  183. package/lib/plugins/telemetry/Telemetry.js +1 -0
  184. package/lib/plugins/thumbnails/Thumbnails.d.ts +48 -3
  185. package/lib/plugins/thumbnails/Thumbnails.d.ts.map +1 -1
  186. package/lib/plugins/thumbnails/Thumbnails.js +52 -18
  187. package/lib/plugins/volume-fade/VolumeFade.d.ts +5 -0
  188. package/lib/plugins/volume-fade/VolumeFade.d.ts.map +1 -1
  189. package/lib/plugins/volume-fade/VolumeFade.js +5 -0
  190. package/lib/types.d.ts +9 -1
  191. package/lib/types.d.ts.map +1 -1
  192. package/lib/utils/types.d.ts +1 -0
  193. package/lib/utils/types.d.ts.map +1 -1
  194. package/package.json +1 -1
  195. package/release_notes +297 -0
  196. package/src/Player.ts +101 -46
  197. package/src/__tests__/Player.test.ts +23 -1
  198. package/src/index.plugins.ts +0 -1
  199. package/src/internal.types.ts +86 -79
  200. package/src/plugins/audio-selector/AudioSelector.ts +227 -154
  201. package/src/plugins/big-mute-button/BigMuteButton.ts +100 -79
  202. package/src/plugins/bottom-gear/BottomGear.ts +1 -0
  203. package/src/plugins/clappr-stats/ClapprStats.ts +32 -8
  204. package/src/plugins/clappr-stats/types.ts +13 -0
  205. package/src/plugins/click-to-pause/ClickToPause.ts +47 -36
  206. package/src/plugins/clips/Clips.ts +127 -71
  207. package/src/plugins/context-menu/ContextMenu.ts +109 -76
  208. package/src/plugins/dvr-controls/DvrControls.ts +11 -30
  209. package/src/plugins/error-screen/ErrorScreen.ts +0 -1
  210. package/src/plugins/favicon/Favicon.ts +4 -0
  211. package/src/plugins/google-analytics/GoogleAnalytics.ts +5 -1
  212. package/src/plugins/index.ts +0 -1
  213. package/src/plugins/logo/Logo.ts +4 -0
  214. package/src/plugins/media-control/MediaControl.ts +4 -1
  215. package/src/plugins/multi-camera/MultiCamera.ts +6 -2
  216. package/src/plugins/seek-time/SeekTime.ts +6 -2
  217. package/src/plugins/share/Share.ts +4 -1
  218. package/src/plugins/skip-time/SkipTime.ts +3 -0
  219. package/src/plugins/telemetry/Telemetry.ts +18 -0
  220. package/src/plugins/thumbnails/Thumbnails.ts +268 -194
  221. package/src/plugins/volume-fade/VolumeFade.ts +5 -0
  222. package/src/types.ts +11 -1
  223. package/src/utils/types.ts +1 -0
  224. package/temp/player.api.json +627 -2468
  225. package/tsconfig.tsbuildinfo +1 -1
  226. package/docs/api/player.audioselector.events.md +0 -17
  227. package/docs/api/player.audioselector.hideselecttrackmenu.md +0 -18
  228. package/docs/api/player.audioselector.name.md +0 -14
  229. package/docs/api/player.audioselector.onshowlevelselectmenu.md +0 -18
  230. package/docs/api/player.audioselector.render.md +0 -18
  231. package/docs/api/player.audioselector.supportedversion.md +0 -16
  232. package/docs/api/player.audioselector.template.md +0 -14
  233. package/docs/api/player.audioselector.togglecontextmenu.md +0 -18
  234. package/docs/api/player.audioselector.unbindevents.md +0 -18
  235. package/docs/api/player.audioselector.version.md +0 -14
  236. package/docs/api/player.bigmutebutton.bindevents.md +0 -18
  237. package/docs/api/player.bigmutebutton.events.md +0 -17
  238. package/docs/api/player.bigmutebutton.name.md +0 -14
  239. package/docs/api/player.bigmutebutton.render.md +0 -18
  240. package/docs/api/player.bigmutebutton.supportedversion.md +0 -16
  241. package/docs/api/player.bigmutebutton.template.md +0 -14
  242. package/docs/api/player.clapprstats._buildreport.md +0 -18
  243. package/docs/api/player.clapprstats._defaultreport.md +0 -52
  244. package/docs/api/player.clapprstats._playbackname.md +0 -14
  245. package/docs/api/player.clapprstats._playbacktype.md +0 -14
  246. package/docs/api/player.clapprstats.bindevents.md +0 -18
  247. package/docs/api/player.clapprstats.destroy.md +0 -18
  248. package/docs/api/player.clapprstats.name.md +0 -14
  249. package/docs/api/player.clapprstats.onfirstplaying.md +0 -18
  250. package/docs/api/player.clapprstats.playafterpause.md +0 -18
  251. package/docs/api/player.clapprstats.starttimers.md +0 -18
  252. package/docs/api/player.clapprstats.stopreporting.md +0 -18
  253. package/docs/api/player.clapprstats.supportedversion.md +0 -16
  254. package/docs/api/player.clicktopause.bindevents.md +0 -15
  255. package/docs/api/player.clicktopause.config.md +0 -11
  256. package/docs/api/player.clicktopause.name.md +0 -11
  257. package/docs/api/player.clicktopause.supportedversion.md +0 -13
  258. package/docs/api/player.clipsplugin.attributes.md +0 -13
  259. package/docs/api/player.clipsplugin.bindevents.md +0 -15
  260. package/docs/api/player.clipsplugin.makesvg.md +0 -49
  261. package/docs/api/player.clipsplugin.name.md +0 -11
  262. package/docs/api/player.clipsplugin.unbindevents.md +0 -15
  263. package/docs/api/player.contextmenu.attributes.md +0 -13
  264. package/docs/api/player.contextmenu.bindevents.md +0 -15
  265. package/docs/api/player.contextmenu.destroy.md +0 -15
  266. package/docs/api/player.contextmenu.events.md +0 -13
  267. package/docs/api/player.contextmenu.exposeversion.md +0 -14
  268. package/docs/api/player.contextmenu.label.md +0 -11
  269. package/docs/api/player.contextmenu.mediacontrol.md +0 -11
  270. package/docs/api/player.contextmenu.name.md +0 -11
  271. package/docs/api/player.contextmenu.render.md +0 -15
  272. package/docs/api/player.contextmenu.supportedversion.md +0 -13
  273. package/docs/api/player.contextmenu.template.md +0 -11
  274. package/docs/api/player.contextmenu.url.md +0 -11
  275. package/docs/api/player.disablecontrols.bindevents.md +0 -15
  276. package/docs/api/player.disablecontrols.container.md +0 -11
  277. package/docs/api/player.disablecontrols.md +0 -138
  278. package/docs/api/player.disablecontrols.name.md +0 -11
  279. package/docs/api/player.disablecontrols.supportedversion.md +0 -13
  280. package/docs/api/player.disablecontrols.unbindevents.md +0 -15
  281. package/docs/api/player.thumbnails.attributes.md +0 -13
  282. package/docs/api/player.thumbnails.bindevents.md +0 -15
  283. package/docs/api/player.thumbnails.name.md +0 -11
  284. package/docs/api/player.thumbnails.settext.md +0 -49
  285. package/docs/api/player.thumbnails.supportedversion.md +0 -13
  286. package/docs/api/player.thumbnails.template.md +0 -11
  287. package/src/plugins/disable-controls/DisableControls.ts +0 -81
  288. package/src/plugins/ga-events/GaEvents.js +0 -395
  289. package/src/plugins/ga-events/ga-tracking.js +0 -46
@@ -7,6 +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
+ Adds an audio track selector to the media control UI.
10
11
 
11
12
  **Signature:**
12
13
 
@@ -15,159 +16,6 @@ export declare class AudioSelector extends UICorePlugin
15
16
  ```
16
17
  **Extends:** UICorePlugin
17
18
 
18
- ## Properties
19
-
20
- <table><thead><tr><th>
21
-
22
- Property
23
-
24
-
25
- </th><th>
26
-
27
- Modifiers
28
-
29
-
30
- </th><th>
31
-
32
- Type
33
-
34
-
35
- </th><th>
36
-
37
- Description
38
-
39
-
40
- </th></tr></thead>
41
- <tbody><tr><td>
42
-
43
- [attributes](./player.audioselector.attributes.md)
44
-
45
-
46
- </td><td>
47
-
48
- `readonly`
49
-
50
-
51
- </td><td>
52
-
53
- { class: string; 'data-track-selector': string; }
54
-
55
-
56
- </td><td>
57
-
58
- **_(BETA)_**
59
-
60
-
61
- </td></tr>
62
- <tr><td>
63
-
64
- [events](./player.audioselector.events.md)
65
-
66
-
67
- </td><td>
68
-
69
- `readonly`
70
-
71
-
72
- </td><td>
73
-
74
- { 'click \[data-track-selector-select\]': string; 'click \[data-track-selector-button\]': string; }
75
-
76
-
77
- </td><td>
78
-
79
- **_(BETA)_**
80
-
81
-
82
- </td></tr>
83
- <tr><td>
84
-
85
- [name](./player.audioselector.name.md)
86
-
87
-
88
- </td><td>
89
-
90
- `readonly`
91
-
92
-
93
- </td><td>
94
-
95
- string
96
-
97
-
98
- </td><td>
99
-
100
- **_(BETA)_**
101
-
102
-
103
- </td></tr>
104
- <tr><td>
105
-
106
- [supportedVersion](./player.audioselector.supportedversion.md)
107
-
108
-
109
- </td><td>
110
-
111
- `readonly`
112
-
113
-
114
- </td><td>
115
-
116
- { min: string; }
117
-
118
-
119
- </td><td>
120
-
121
- **_(BETA)_**
122
-
123
-
124
- </td></tr>
125
- <tr><td>
126
-
127
- [template](./player.audioselector.template.md)
128
-
129
-
130
- </td><td>
131
-
132
- `readonly`
133
-
134
-
135
- </td><td>
136
-
137
- any
138
-
139
-
140
- </td><td>
141
-
142
- **_(BETA)_**
143
-
144
-
145
- </td></tr>
146
- <tr><td>
147
-
148
- [version](./player.audioselector.version.md)
149
-
150
-
151
- </td><td>
152
-
153
- `static`
154
-
155
- `readonly`
156
-
157
-
158
- </td><td>
159
-
160
- string
161
-
162
-
163
- </td><td>
164
-
165
- **_(BETA)_**
166
-
167
-
168
- </td></tr>
169
- </tbody></table>
170
-
171
19
  ## Methods
172
20
 
173
21
  <table><thead><tr><th>
@@ -188,34 +36,6 @@ Description
188
36
  </th></tr></thead>
189
37
  <tbody><tr><td>
190
38
 
191
- [bindEvents()](./player.audioselector.bindevents.md)
192
-
193
-
194
- </td><td>
195
-
196
-
197
- </td><td>
198
-
199
- **_(BETA)_**
200
-
201
-
202
- </td></tr>
203
- <tr><td>
204
-
205
- [hideSelectTrackMenu()](./player.audioselector.hideselecttrackmenu.md)
206
-
207
-
208
- </td><td>
209
-
210
-
211
- </td><td>
212
-
213
- **_(BETA)_**
214
-
215
-
216
- </td></tr>
217
- <tr><td>
218
-
219
39
  [highlightCurrentTrack()](./player.audioselector.highlightcurrenttrack.md)
220
40
 
221
41
 
@@ -227,48 +47,6 @@ Description
227
47
  **_(BETA)_**
228
48
 
229
49
 
230
- </td></tr>
231
- <tr><td>
232
-
233
- [onShowLevelSelectMenu()](./player.audioselector.onshowlevelselectmenu.md)
234
-
235
-
236
- </td><td>
237
-
238
-
239
- </td><td>
240
-
241
- **_(BETA)_**
242
-
243
-
244
- </td></tr>
245
- <tr><td>
246
-
247
- [reload()](./player.audioselector.reload.md)
248
-
249
-
250
- </td><td>
251
-
252
-
253
- </td><td>
254
-
255
- **_(BETA)_**
256
-
257
-
258
- </td></tr>
259
- <tr><td>
260
-
261
- [render()](./player.audioselector.render.md)
262
-
263
-
264
- </td><td>
265
-
266
-
267
- </td><td>
268
-
269
- **_(BETA)_**
270
-
271
-
272
50
  </td></tr>
273
51
  <tr><td>
274
52
 
@@ -283,34 +61,6 @@ Description
283
61
  **_(BETA)_**
284
62
 
285
63
 
286
- </td></tr>
287
- <tr><td>
288
-
289
- [toggleContextMenu()](./player.audioselector.togglecontextmenu.md)
290
-
291
-
292
- </td><td>
293
-
294
-
295
- </td><td>
296
-
297
- **_(BETA)_**
298
-
299
-
300
- </td></tr>
301
- <tr><td>
302
-
303
- [unBindEvents()](./player.audioselector.unbindevents.md)
304
-
305
-
306
- </td><td>
307
-
308
-
309
- </td><td>
310
-
311
- **_(BETA)_**
312
-
313
-
314
64
  </td></tr>
315
65
  <tr><td>
316
66
 
@@ -7,6 +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
+ Displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.
10
11
 
11
12
  **Signature:**
12
13
 
@@ -15,159 +16,3 @@ export declare class BigMuteButton extends UICorePlugin
15
16
  ```
16
17
  **Extends:** UICorePlugin
17
18
 
18
- ## Properties
19
-
20
- <table><thead><tr><th>
21
-
22
- Property
23
-
24
-
25
- </th><th>
26
-
27
- Modifiers
28
-
29
-
30
- </th><th>
31
-
32
- Type
33
-
34
-
35
- </th><th>
36
-
37
- Description
38
-
39
-
40
- </th></tr></thead>
41
- <tbody><tr><td>
42
-
43
- [events](./player.bigmutebutton.events.md)
44
-
45
-
46
- </td><td>
47
-
48
- `readonly`
49
-
50
-
51
- </td><td>
52
-
53
- { 'click .big-mute-icon': string; 'click .big-mute-icon-wrapper': string; }
54
-
55
-
56
- </td><td>
57
-
58
- **_(BETA)_**
59
-
60
-
61
- </td></tr>
62
- <tr><td>
63
-
64
- [name](./player.bigmutebutton.name.md)
65
-
66
-
67
- </td><td>
68
-
69
- `readonly`
70
-
71
-
72
- </td><td>
73
-
74
- string
75
-
76
-
77
- </td><td>
78
-
79
- **_(BETA)_**
80
-
81
-
82
- </td></tr>
83
- <tr><td>
84
-
85
- [supportedVersion](./player.bigmutebutton.supportedversion.md)
86
-
87
-
88
- </td><td>
89
-
90
- `readonly`
91
-
92
-
93
- </td><td>
94
-
95
- { min: string; }
96
-
97
-
98
- </td><td>
99
-
100
- **_(BETA)_**
101
-
102
-
103
- </td></tr>
104
- <tr><td>
105
-
106
- [template](./player.bigmutebutton.template.md)
107
-
108
-
109
- </td><td>
110
-
111
- `readonly`
112
-
113
-
114
- </td><td>
115
-
116
- any
117
-
118
-
119
- </td><td>
120
-
121
- **_(BETA)_**
122
-
123
-
124
- </td></tr>
125
- </tbody></table>
126
-
127
- ## Methods
128
-
129
- <table><thead><tr><th>
130
-
131
- Method
132
-
133
-
134
- </th><th>
135
-
136
- Modifiers
137
-
138
-
139
- </th><th>
140
-
141
- Description
142
-
143
-
144
- </th></tr></thead>
145
- <tbody><tr><td>
146
-
147
- [bindEvents()](./player.bigmutebutton.bindevents.md)
148
-
149
-
150
- </td><td>
151
-
152
-
153
- </td><td>
154
-
155
- **_(BETA)_**
156
-
157
-
158
- </td></tr>
159
- <tr><td>
160
-
161
- [render()](./player.bigmutebutton.render.md)
162
-
163
-
164
- </td><td>
165
-
166
-
167
- </td><td>
168
-
169
- **_(BETA)_**
170
-
171
-
172
- </td></tr>
173
- </tbody></table>
@@ -7,6 +7,8 @@
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
+ Returns the collected metrics.
11
+
10
12
  **Signature:**
11
13
 
12
14
  ```typescript
@@ -16,3 +18,5 @@ exportMetrics(): Metrics;
16
18
 
17
19
  Metrics
18
20
 
21
+ The collected metrics
22
+
@@ -7,6 +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
+ Collects useful statistics about playback performance.
10
11
 
11
12
  **Signature:**
12
13
 
@@ -15,6 +16,10 @@ export declare class ClapprStats extends ContainerPlugin
15
16
  ```
16
17
  **Extends:** ContainerPlugin
17
18
 
19
+ ## Remarks
20
+
21
+ This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.
22
+
18
23
  ## Constructors
19
24
 
20
25
  <table><thead><tr><th>
@@ -46,115 +51,6 @@ Description
46
51
  **_(BETA)_** Constructs a new instance of the `ClapprStats` class
47
52
 
48
53
 
49
- </td></tr>
50
- </tbody></table>
51
-
52
- ## Properties
53
-
54
- <table><thead><tr><th>
55
-
56
- Property
57
-
58
-
59
- </th><th>
60
-
61
- Modifiers
62
-
63
-
64
- </th><th>
65
-
66
- Type
67
-
68
-
69
- </th><th>
70
-
71
- Description
72
-
73
-
74
- </th></tr></thead>
75
- <tbody><tr><td>
76
-
77
- [\_playbackName](./player.clapprstats._playbackname.md)
78
-
79
-
80
- </td><td>
81
-
82
- `readonly`
83
-
84
-
85
- </td><td>
86
-
87
- string
88
-
89
-
90
- </td><td>
91
-
92
- **_(BETA)_**
93
-
94
-
95
- </td></tr>
96
- <tr><td>
97
-
98
- [\_playbackType](./player.clapprstats._playbacktype.md)
99
-
100
-
101
- </td><td>
102
-
103
- `readonly`
104
-
105
-
106
- </td><td>
107
-
108
- any
109
-
110
-
111
- </td><td>
112
-
113
- **_(BETA)_**
114
-
115
-
116
- </td></tr>
117
- <tr><td>
118
-
119
- [name](./player.clapprstats.name.md)
120
-
121
-
122
- </td><td>
123
-
124
- `readonly`
125
-
126
-
127
- </td><td>
128
-
129
- string
130
-
131
-
132
- </td><td>
133
-
134
- **_(BETA)_**
135
-
136
-
137
- </td></tr>
138
- <tr><td>
139
-
140
- [supportedVersion](./player.clapprstats.supportedversion.md)
141
-
142
-
143
- </td><td>
144
-
145
- `readonly`
146
-
147
-
148
- </td><td>
149
-
150
- { min: string; }
151
-
152
-
153
- </td><td>
154
-
155
- **_(BETA)_**
156
-
157
-
158
54
  </td></tr>
159
55
  </tbody></table>
160
56
 
@@ -178,62 +74,6 @@ Description
178
74
  </th></tr></thead>
179
75
  <tbody><tr><td>
180
76
 
181
- [\_buildReport()](./player.clapprstats._buildreport.md)
182
-
183
-
184
- </td><td>
185
-
186
-
187
- </td><td>
188
-
189
- **_(BETA)_**
190
-
191
-
192
- </td></tr>
193
- <tr><td>
194
-
195
- [\_defaultReport(metrics)](./player.clapprstats._defaultreport.md)
196
-
197
-
198
- </td><td>
199
-
200
-
201
- </td><td>
202
-
203
- **_(BETA)_**
204
-
205
-
206
- </td></tr>
207
- <tr><td>
208
-
209
- [bindEvents()](./player.clapprstats.bindevents.md)
210
-
211
-
212
- </td><td>
213
-
214
-
215
- </td><td>
216
-
217
- **_(BETA)_**
218
-
219
-
220
- </td></tr>
221
- <tr><td>
222
-
223
- [destroy()](./player.clapprstats.destroy.md)
224
-
225
-
226
- </td><td>
227
-
228
-
229
- </td><td>
230
-
231
- **_(BETA)_**
232
-
233
-
234
- </td></tr>
235
- <tr><td>
236
-
237
77
  [exportMetrics()](./player.clapprstats.exportmetrics.md)
238
78
 
239
79
 
@@ -242,7 +82,7 @@ Description
242
82
 
243
83
  </td><td>
244
84
 
245
- **_(BETA)_**
85
+ **_(BETA)_** Returns the collected metrics.
246
86
 
247
87
 
248
88
  </td></tr>
@@ -259,34 +99,6 @@ Description
259
99
  **_(BETA)_**
260
100
 
261
101
 
262
- </td></tr>
263
- <tr><td>
264
-
265
- [onFirstPlaying()](./player.clapprstats.onfirstplaying.md)
266
-
267
-
268
- </td><td>
269
-
270
-
271
- </td><td>
272
-
273
- **_(BETA)_**
274
-
275
-
276
- </td></tr>
277
- <tr><td>
278
-
279
- [playAfterPause()](./player.clapprstats.playafterpause.md)
280
-
281
-
282
- </td><td>
283
-
284
-
285
- </td><td>
286
-
287
- **_(BETA)_**
288
-
289
-
290
102
  </td></tr>
291
103
  <tr><td>
292
104
 
@@ -298,35 +110,7 @@ Description
298
110
 
299
111
  </td><td>
300
112
 
301
- **_(BETA)_**
302
-
303
-
304
- </td></tr>
305
- <tr><td>
306
-
307
- [startTimers()](./player.clapprstats.starttimers.md)
308
-
309
-
310
- </td><td>
311
-
312
-
313
- </td><td>
314
-
315
- **_(BETA)_**
316
-
317
-
318
- </td></tr>
319
- <tr><td>
320
-
321
- [stopReporting()](./player.clapprstats.stopreporting.md)
322
-
323
-
324
- </td><td>
325
-
326
-
327
- </td><td>
328
-
329
- **_(BETA)_**
113
+ **_(BETA)_** Registers a callback to receive the metrics.
330
114
 
331
115
 
332
116
  </td></tr>