@gcorevideo/player 2.20.8 → 2.20.11

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 (329) hide show
  1. package/assets/dvr-controls/dvr_controls.scss +0 -2
  2. package/dist/core.js +22 -17
  3. package/dist/index.css +1343 -1346
  4. package/dist/index.js +119 -109
  5. package/dist/player.d.ts +238 -179
  6. package/dist/plugins/index.css +461 -464
  7. package/dist/plugins/index.js +97 -93
  8. package/docs/api/player.audioselector.md +1 -1
  9. package/docs/api/player.bigmutebutton.md +1 -1
  10. package/docs/api/player.bottomgear.md +15 -1
  11. package/docs/api/player.bottomgear.refresh.md +20 -0
  12. package/docs/api/player.clapprnerdstats.md +1 -1
  13. package/docs/api/player.clapprstats.exportmetrics.md +1 -1
  14. package/docs/api/player.clapprstats.md +1 -15
  15. package/docs/api/player.clapprstats.setupdatemetrics.md +2 -0
  16. package/docs/api/player.clicktopause.md +1 -1
  17. package/docs/api/player.clipsplugin.md +1 -1
  18. package/docs/api/player.clipspluginsettings.md +5 -2
  19. package/docs/api/player.clipspluginsettings.text.md +3 -0
  20. package/docs/api/player.containerpluginconstructor.md +17 -0
  21. package/docs/api/player.containersize.md +0 -3
  22. package/docs/api/player.contextmenu.md +1 -1
  23. package/docs/api/player.corepluginconstructor.md +17 -0
  24. package/docs/api/player.dashsettings.md +0 -3
  25. package/docs/api/player.dvrcontrols.md +2 -35
  26. package/docs/api/player.errorlevel.md +0 -3
  27. package/docs/api/player.errorscreen.md +1 -220
  28. package/docs/api/{player.errorscreen.render.md → player.errorscreenpluginsettings.md} +7 -7
  29. package/docs/api/player.favicon.md +1 -1
  30. package/docs/api/player.googleanalytics.md +1 -1
  31. package/docs/api/player.langtag.md +0 -3
  32. package/docs/api/player.levelselector.md +3 -9
  33. package/docs/api/{player.errorscreen.bindevents.md → player.levelselectorpluginsettings.labels.md} +11 -5
  34. package/docs/api/player.levelselectorpluginsettings.md +79 -0
  35. package/docs/api/{player.errorscreen.unbindevents.md → player.levelselectorpluginsettings.restrictresolution.md} +5 -7
  36. package/docs/api/player.logo.md +1 -1
  37. package/docs/api/player.md +131 -65
  38. package/docs/api/{player.errorscreen.container.md → player.mediacontrol.currentseekpos.md} +3 -3
  39. package/docs/api/player.mediacontrol.disable.md +1 -1
  40. package/docs/api/player.mediacontrol.md +24 -3
  41. package/docs/api/{player.gearevents.md → player.mediacontrolevents.md} +4 -4
  42. package/docs/api/player.multicamera.md +1 -29
  43. package/docs/api/player.pictureinpicture.md +1 -1
  44. package/docs/api/player.playbackerror.code.md +0 -3
  45. package/docs/api/player.playbackerror.description.md +0 -3
  46. package/docs/api/player.playbackerror.level.md +0 -3
  47. package/docs/api/player.playbackerror.md +25 -9
  48. package/docs/api/player.playbackerror.message.md +0 -3
  49. package/docs/api/player.playbackerror.origin.md +0 -3
  50. package/docs/api/player.playbackerror.scope.md +0 -3
  51. package/docs/api/player.playbackerror.ui.md +17 -0
  52. package/docs/api/player.playbackerrorcode.md +6 -9
  53. package/docs/api/player.playbackmodule.md +0 -3
  54. package/docs/api/{player.dvrcontrols._constructor_.md → player.playbackrate._constructor_.md} +3 -3
  55. package/docs/api/player.playbackrate.md +35 -2
  56. package/docs/api/player.playbacktype.md +1 -4
  57. package/docs/api/player.player._constructor_.md +0 -3
  58. package/docs/api/player.player.attachto.md +0 -3
  59. package/docs/api/player.player.configure.md +0 -3
  60. package/docs/api/player.player.destroy.md +0 -3
  61. package/docs/api/player.player.getcurrenttime.md +0 -3
  62. package/docs/api/player.player.getduration.md +0 -3
  63. package/docs/api/player.player.getvolume.md +0 -3
  64. package/docs/api/player.player.isdvrenabled.md +0 -3
  65. package/docs/api/player.player.isdvrinuse.md +0 -3
  66. package/docs/api/player.player.ismuted.md +0 -3
  67. package/docs/api/player.player.isplaying.md +0 -3
  68. package/docs/api/player.player.md +25 -28
  69. package/docs/api/player.player.mute.md +0 -3
  70. package/docs/api/player.player.off.md +0 -3
  71. package/docs/api/player.player.on.md +0 -3
  72. package/docs/api/player.player.pause.md +0 -3
  73. package/docs/api/player.player.play.md +0 -3
  74. package/docs/api/player.player.registerplugin.md +2 -5
  75. package/docs/api/player.player.resize.md +0 -3
  76. package/docs/api/player.player.seek.md +0 -3
  77. package/docs/api/player.player.setvolume.md +0 -3
  78. package/docs/api/player.player.stop.md +0 -3
  79. package/docs/api/player.player.unmute.md +0 -3
  80. package/docs/api/player.player.unregisterplugin.md +14 -7
  81. package/docs/api/player.playercomponenttype.md +0 -3
  82. package/docs/api/player.playerconfig.autoplay.md +0 -3
  83. package/docs/api/player.playerconfig.dash.md +0 -3
  84. package/docs/api/player.playerconfig.debug.md +0 -3
  85. package/docs/api/player.playerconfig.language.md +0 -3
  86. package/docs/api/player.playerconfig.loop.md +0 -3
  87. package/docs/api/player.playerconfig.md +10 -13
  88. package/docs/api/player.playerconfig.mute.md +0 -3
  89. package/docs/api/player.playerconfig.playbacktype.md +0 -3
  90. package/docs/api/player.playerconfig.prioritytransport.md +0 -3
  91. package/docs/api/player.playerconfig.sources.md +0 -3
  92. package/docs/api/player.playerconfig.strings.md +0 -3
  93. package/docs/api/player.playerdebugsettings.md +0 -3
  94. package/docs/api/player.playerdebugtag.md +0 -3
  95. package/docs/api/player.playerevent.md +11 -14
  96. package/docs/api/player.playereventhandler.md +0 -3
  97. package/docs/api/player.playereventparams.md +0 -3
  98. package/docs/api/player.playermediasource.md +0 -3
  99. package/docs/api/player.playermediasourcedesc.md +2 -5
  100. package/docs/api/player.playermediasourcedesc.mimetype.md +0 -3
  101. package/docs/api/player.playermediasourcedesc.source.md +0 -3
  102. package/docs/api/player.playerplugin.md +0 -4
  103. package/docs/api/player.playerpluginconstructor.md +14 -0
  104. package/docs/api/player.poster.md +1 -1
  105. package/docs/api/player.qualitylevel.bitrate.md +0 -3
  106. package/docs/api/player.qualitylevel.height.md +0 -3
  107. package/docs/api/player.qualitylevel.level.md +0 -3
  108. package/docs/api/player.qualitylevel.md +4 -7
  109. package/docs/api/player.qualitylevel.width.md +0 -3
  110. package/docs/api/player.seektime.md +1 -1
  111. package/docs/api/player.share.attributes.md +3 -0
  112. package/docs/api/player.share.bindevents.md +3 -0
  113. package/docs/api/player.share.canshowshare.md +3 -0
  114. package/docs/api/player.share.events.md +3 -0
  115. package/docs/api/player.share.hideshare.md +3 -0
  116. package/docs/api/player.share.initializeicons.md +3 -0
  117. package/docs/api/player.share.md +40 -1
  118. package/docs/api/player.share.name.md +3 -0
  119. package/docs/api/player.share.onshareembedclick.md +3 -0
  120. package/docs/api/player.share.onsharefb.md +3 -0
  121. package/docs/api/player.share.onsharehide.md +3 -0
  122. package/docs/api/player.share.onsharelinkclick.md +3 -0
  123. package/docs/api/player.share.onshareshow.md +3 -0
  124. package/docs/api/player.share.onsharetw.md +3 -0
  125. package/docs/api/player.share.render.md +3 -0
  126. package/docs/api/player.share.showshare.md +3 -0
  127. package/docs/api/player.share.supportedversion.md +3 -0
  128. package/docs/api/player.share.template.md +3 -0
  129. package/docs/api/player.share.unbindevents.md +3 -0
  130. package/docs/api/player.skiptime.attributes.md +3 -0
  131. package/docs/api/player.skiptime.bindevents.md +3 -0
  132. package/docs/api/player.skiptime.container.md +3 -0
  133. package/docs/api/player.skiptime.events.md +3 -0
  134. package/docs/api/player.skiptime.handlerewindclicks.md +3 -0
  135. package/docs/api/player.skiptime.md +30 -1
  136. package/docs/api/player.skiptime.name.md +3 -0
  137. package/docs/api/player.skiptime.render.md +3 -0
  138. package/docs/api/player.skiptime.setback.md +3 -0
  139. package/docs/api/player.skiptime.setforward.md +3 -0
  140. package/docs/api/player.skiptime.setmidclick.md +3 -0
  141. package/docs/api/player.skiptime.supportedversion.md +3 -0
  142. package/docs/api/player.skiptime.template.md +3 -0
  143. package/docs/api/player.skiptime.togglefullscreen.md +3 -0
  144. package/docs/api/player.sourcecontroller.md +1 -1
  145. package/docs/api/player.spinnerevents.md +4 -1
  146. package/docs/api/player.spinnerthreebounce.hide.md +1 -1
  147. package/docs/api/player.spinnerthreebounce.md +7 -5
  148. package/docs/api/player.spinnerthreebounce.show.md +40 -2
  149. package/docs/api/player.subtitles.md +1 -1
  150. package/docs/api/player.telemetry.md +1 -1
  151. package/docs/api/player.telemetrypluginsettings.md +1 -1
  152. package/docs/api/{player.errorscreen.hide.md → player.telemetrysendfn.md} +6 -6
  153. package/docs/api/player.thumbnails.md +1 -1
  154. package/docs/api/player.timeposition.current.md +0 -3
  155. package/docs/api/player.timeposition.md +2 -5
  156. package/docs/api/player.timeposition.total.md +0 -3
  157. package/docs/api/player.timevalue.md +0 -3
  158. package/docs/api/player.translationkey.md +0 -3
  159. package/docs/api/player.translationsettings.md +0 -3
  160. package/docs/api/player.transportpreference.md +2 -7
  161. package/docs/api/player.volumefade.md +1 -1
  162. package/lib/Player.d.ts +18 -9
  163. package/lib/Player.d.ts.map +1 -1
  164. package/lib/Player.js +19 -14
  165. package/lib/index.core.d.ts +0 -1
  166. package/lib/index.core.d.ts.map +1 -1
  167. package/lib/index.core.js +0 -1
  168. package/lib/index.d.ts +18 -1
  169. package/lib/index.d.ts.map +1 -1
  170. package/lib/index.js +18 -1
  171. package/lib/index.plugins.d.ts +0 -1
  172. package/lib/index.plugins.d.ts.map +1 -1
  173. package/lib/index.plugins.js +0 -1
  174. package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
  175. package/lib/playback/hls-playback/HlsPlayback.js +1 -1
  176. package/lib/playback.types.d.ts +8 -7
  177. package/lib/playback.types.d.ts.map +1 -1
  178. package/lib/playback.types.js +1 -1
  179. package/lib/plugins/audio-selector/AudioSelector.d.ts +1 -1
  180. package/lib/plugins/audio-selector/AudioSelector.js +1 -1
  181. package/lib/plugins/big-mute-button/BigMuteButton.d.ts +1 -1
  182. package/lib/plugins/big-mute-button/BigMuteButton.d.ts.map +1 -1
  183. package/lib/plugins/big-mute-button/BigMuteButton.js +1 -2
  184. package/lib/plugins/bottom-gear/BottomGear.d.ts +2 -2
  185. package/lib/plugins/bottom-gear/BottomGear.d.ts.map +1 -1
  186. package/lib/plugins/bottom-gear/BottomGear.js +1 -1
  187. package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts +1 -1
  188. package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js +1 -1
  189. package/lib/plugins/clappr-nerd-stats/speedtest/Speedtest.d.ts.map +1 -1
  190. package/lib/plugins/clappr-nerd-stats/speedtest/Speedtest.js +8 -8
  191. package/lib/plugins/clappr-stats/ClapprStats.d.ts +4 -5
  192. package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
  193. package/lib/plugins/clappr-stats/ClapprStats.js +4 -3
  194. package/lib/plugins/click-to-pause/ClickToPause.d.ts +1 -1
  195. package/lib/plugins/click-to-pause/ClickToPause.js +1 -1
  196. package/lib/plugins/clips/Clips.d.ts +3 -2
  197. package/lib/plugins/clips/Clips.d.ts.map +1 -1
  198. package/lib/plugins/clips/Clips.js +1 -1
  199. package/lib/plugins/context-menu/ContextMenu.d.ts +1 -1
  200. package/lib/plugins/context-menu/ContextMenu.d.ts.map +1 -1
  201. package/lib/plugins/context-menu/ContextMenu.js +1 -1
  202. package/lib/plugins/dvr-controls/DvrControls.d.ts +7 -4
  203. package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
  204. package/lib/plugins/dvr-controls/DvrControls.js +29 -36
  205. package/lib/plugins/error-screen/ErrorScreen.d.ts +8 -14
  206. package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
  207. package/lib/plugins/error-screen/ErrorScreen.js +1 -1
  208. package/lib/plugins/favicon/Favicon.d.ts +1 -1
  209. package/lib/plugins/favicon/Favicon.js +1 -1
  210. package/lib/plugins/google-analytics/GoogleAnalytics.d.ts +1 -1
  211. package/lib/plugins/google-analytics/GoogleAnalytics.js +1 -1
  212. package/lib/plugins/index.d.ts +0 -1
  213. package/lib/plugins/index.d.ts.map +1 -1
  214. package/lib/plugins/index.js +0 -1
  215. package/lib/plugins/kibo/index.d.ts +0 -3
  216. package/lib/plugins/kibo/index.d.ts.map +1 -1
  217. package/lib/plugins/kibo/index.js +0 -3
  218. package/lib/plugins/level-selector/LevelSelector.d.ts +6 -4
  219. package/lib/plugins/level-selector/LevelSelector.d.ts.map +1 -1
  220. package/lib/plugins/level-selector/LevelSelector.js +2 -4
  221. package/lib/plugins/logo/Logo.d.ts +1 -1
  222. package/lib/plugins/logo/Logo.js +1 -1
  223. package/lib/plugins/media-control/MediaControl.d.ts +11 -5
  224. package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
  225. package/lib/plugins/media-control/MediaControl.js +17 -5
  226. package/lib/plugins/multi-camera/MultiCamera.d.ts +3 -11
  227. package/lib/plugins/multi-camera/MultiCamera.d.ts.map +1 -1
  228. package/lib/plugins/multi-camera/MultiCamera.js +1 -1
  229. package/lib/plugins/picture-in-picture/PictureInPicture.d.ts +1 -1
  230. package/lib/plugins/picture-in-picture/PictureInPicture.js +1 -1
  231. package/lib/plugins/playback-rate/PlaybackRate.d.ts +1 -1
  232. package/lib/plugins/playback-rate/PlaybackRate.js +1 -1
  233. package/lib/plugins/poster/Poster.d.ts +1 -1
  234. package/lib/plugins/poster/Poster.js +3 -3
  235. package/lib/plugins/seek-time/SeekTime.d.ts +1 -1
  236. package/lib/plugins/seek-time/SeekTime.js +1 -1
  237. package/lib/plugins/share/Share.d.ts +2 -1
  238. package/lib/plugins/share/Share.d.ts.map +1 -1
  239. package/lib/plugins/share/Share.js +2 -1
  240. package/lib/plugins/skip-time/SkipTime.d.ts +2 -1
  241. package/lib/plugins/skip-time/SkipTime.d.ts.map +1 -1
  242. package/lib/plugins/skip-time/SkipTime.js +2 -1
  243. package/lib/plugins/source-controller/SourceController.d.ts +1 -1
  244. package/lib/plugins/source-controller/SourceController.js +4 -4
  245. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts +6 -3
  246. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map +1 -1
  247. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +6 -3
  248. package/lib/plugins/subtitles/Subtitles.d.ts +1 -1
  249. package/lib/plugins/subtitles/Subtitles.js +1 -1
  250. package/lib/plugins/telemetry/Telemetry.d.ts +2 -3
  251. package/lib/plugins/telemetry/Telemetry.d.ts.map +1 -1
  252. package/lib/plugins/telemetry/Telemetry.js +1 -1
  253. package/lib/plugins/thumbnails/Thumbnails.d.ts +1 -1
  254. package/lib/plugins/thumbnails/Thumbnails.js +1 -1
  255. package/lib/plugins/vast-ads/VastAds.d.ts.map +1 -1
  256. package/lib/plugins/vast-ads/VastAds.js +3 -3
  257. package/lib/plugins/vast-ads/roll.d.ts +1 -1
  258. package/lib/plugins/vast-ads/roll.d.ts.map +1 -1
  259. package/lib/plugins/vast-ads/rollmanager.d.ts +1 -1
  260. package/lib/plugins/vast-ads/rollmanager.d.ts.map +1 -1
  261. package/lib/plugins/vast-ads/rollmanager.js +2 -2
  262. package/lib/plugins/volume-fade/VolumeFade.d.ts +1 -1
  263. package/lib/plugins/volume-fade/VolumeFade.js +1 -1
  264. package/lib/testUtils.d.ts +11 -2
  265. package/lib/testUtils.d.ts.map +1 -1
  266. package/lib/testUtils.js +22 -3
  267. package/lib/types.d.ts +38 -27
  268. package/lib/types.d.ts.map +1 -1
  269. package/lib/types.js +1 -1
  270. package/lib/utils/types.d.ts +0 -6
  271. package/lib/utils/types.d.ts.map +1 -1
  272. package/package.json +1 -1
  273. package/src/Player.ts +23 -21
  274. package/src/index.core.ts +0 -1
  275. package/src/index.plugins.ts +0 -1
  276. package/src/index.ts +18 -1
  277. package/src/playback/hls-playback/HlsPlayback.ts +7 -11
  278. package/src/playback.types.ts +8 -7
  279. package/src/plugins/audio-selector/AudioSelector.ts +2 -2
  280. package/src/plugins/big-mute-button/BigMuteButton.ts +2 -3
  281. package/src/plugins/bottom-gear/BottomGear.ts +2 -2
  282. package/src/plugins/clappr-nerd-stats/ClapprNerdStats.ts +2 -2
  283. package/src/plugins/clappr-nerd-stats/speedtest/Speedtest.ts +184 -187
  284. package/src/plugins/clappr-stats/ClapprStats.ts +5 -4
  285. package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
  286. package/src/plugins/clips/Clips.ts +4 -3
  287. package/src/plugins/context-menu/ContextMenu.ts +1 -3
  288. package/src/plugins/dvr-controls/DvrControls.ts +34 -45
  289. package/src/plugins/dvr-controls/__tests__/DvrControls.test.ts +91 -0
  290. package/src/plugins/dvr-controls/__tests__/__snapshots__/DvrControls.test.ts.snap +43 -0
  291. package/src/plugins/error-screen/ErrorScreen.ts +10 -17
  292. package/src/plugins/favicon/Favicon.ts +2 -2
  293. package/src/plugins/google-analytics/GoogleAnalytics.ts +1 -1
  294. package/src/plugins/index.ts +0 -1
  295. package/src/plugins/kibo/index.ts +0 -3
  296. package/src/plugins/level-selector/LevelSelector.ts +7 -5
  297. package/src/plugins/logo/Logo.ts +2 -2
  298. package/src/plugins/media-control/MediaControl.ts +20 -6
  299. package/src/plugins/multi-camera/MultiCamera.ts +4 -4
  300. package/src/plugins/picture-in-picture/PictureInPicture.ts +1 -1
  301. package/src/plugins/playback-rate/PlaybackRate.ts +2 -2
  302. package/src/plugins/poster/Poster.ts +4 -4
  303. package/src/plugins/seek-time/SeekTime.ts +2 -2
  304. package/src/plugins/share/Share.ts +2 -1
  305. package/src/plugins/skip-time/SkipTime.ts +2 -1
  306. package/src/plugins/source-controller/SourceController.ts +4 -4
  307. package/src/plugins/source-controller/__tests__/SourceController.test.ts +2 -2
  308. package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +6 -3
  309. package/src/plugins/subtitles/Subtitles.ts +2 -2
  310. package/src/plugins/telemetry/Telemetry.ts +2 -2
  311. package/src/plugins/thumbnails/Thumbnails.ts +2 -2
  312. package/src/plugins/vast-ads/VastAds.ts +5 -4
  313. package/src/plugins/vast-ads/roll.ts +2 -1
  314. package/src/plugins/vast-ads/rollmanager.ts +3 -3
  315. package/src/plugins/volume-fade/VolumeFade.ts +1 -1
  316. package/src/testUtils.ts +28 -4
  317. package/src/types.ts +41 -28
  318. package/src/utils/types.ts +0 -8
  319. package/temp/player.api.json +680 -786
  320. package/tsconfig.tsbuildinfo +1 -1
  321. package/docs/api/player.clapprstats.onbitrate.md +0 -52
  322. package/docs/api/player.errorscreen.attributes.md +0 -17
  323. package/docs/api/player.errorscreen.name.md +0 -14
  324. package/docs/api/player.errorscreen.show.md +0 -54
  325. package/docs/api/player.errorscreen.supportedversion.md +0 -16
  326. package/docs/api/player.errorscreen.template.md +0 -14
  327. package/docs/api/player.mediatransport.md +0 -16
  328. package/docs/api/player.multicamera.getcameraslist.md +0 -18
  329. package/docs/api/player.multicamera.getcurrentcamera.md +0 -18
package/lib/types.d.ts CHANGED
@@ -1,10 +1,11 @@
1
+ import { $, Container, Core } from "@clappr/core";
1
2
  /**
2
3
  * Describes a media source with its MIME type and URL.
3
4
  *
4
5
  * @remarks
5
6
  * When the MIME type is provided, it helps the player determine the appropriate playback engine.
6
7
  * If omitted, the player will attempt to detect the type from the source URL extension.
7
- * @beta
8
+ * @public
8
9
  */
9
10
  export interface PlayerMediaSourceDesc {
10
11
  /**
@@ -19,49 +20,54 @@ export interface PlayerMediaSourceDesc {
19
20
  }
20
21
  /**
21
22
  * A media source to fetch the media data from
22
- * @beta
23
+ * @public
23
24
  */
24
25
  export type PlayerMediaSource = string | PlayerMediaSourceDesc;
25
26
  /**
26
27
  * Debug output category selector
27
- * @beta
28
+ * @public
28
29
  */
29
30
  export type PlayerDebugTag = 'all' | 'clappr' | 'dash' | 'hls' | 'none';
30
31
  /**
31
32
  * @remarks `true` is equivalent to `'all'`, `false` is equivalent to `'none'`
32
- * @beta
33
+ * @public
33
34
  */
34
35
  export type PlayerDebugSettings = PlayerDebugTag | boolean;
35
36
  /**
36
- * Type of a stream playback
37
- * @beta
37
+ * Type of a stream
38
+ * @public
38
39
  */
39
40
  export type PlaybackType = 'live' | 'vod';
40
41
  /**
41
- * Media delivery protocol
42
- * @beta
42
+ * Preferred streaming media delivery protocol
43
+ * @public
43
44
  */
44
- export type MediaTransport = 'dash' | 'hls';
45
+ export type TransportPreference = 'dash' | 'hls';
45
46
  /**
46
- * Preferred media delivery protocol
47
- * @beta
48
- */
49
- export type TransportPreference = MediaTransport;
50
- /**
51
- * @beta
47
+ * @public
52
48
  * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html},
53
49
  * {@link https://clappr.github.io/classes/ContainerPlugin.html}
54
50
  */
55
51
  export type PlayerPlugin = {
56
- new (...args: any[]): unknown;
57
52
  name: string;
58
53
  };
54
+ /**
55
+ * @public
56
+ */
59
57
  export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor;
60
- export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
61
- type: 'core';
58
+ /**
59
+ * @public
60
+ */
61
+ export type CorePluginConstructor = {
62
+ new (core: Core): PlayerPlugin;
63
+ type: string;
62
64
  };
63
- export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
64
- type: 'container';
65
+ /**
66
+ * @public
67
+ */
68
+ export type ContainerPluginConstructor = {
69
+ new (container: Container): PlayerPlugin;
70
+ type: string;
65
71
  };
66
72
  /**
67
73
  * Configuration options for the player
@@ -102,7 +108,7 @@ export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin)
102
108
  * },
103
109
  * }
104
110
  * ```
105
- * @beta
111
+ * @public
106
112
  */
107
113
  export interface PlayerConfig extends Record<string, unknown> {
108
114
  /**
@@ -160,16 +166,16 @@ export interface PlayerConfig extends Record<string, unknown> {
160
166
  /**
161
167
  * An ISO 639-1 language code.
162
168
  * @example `pt`
163
- * @beta
169
+ * @public
164
170
  */
165
171
  export type LangTag = string;
166
172
  /**
167
- * @beta
173
+ * @public
168
174
  */
169
175
  export type TranslationKey = string;
170
176
  /**
171
177
  * A plain JS object that must conform to the DASH.js settings schema.
172
- * @beta
178
+ * @public
173
179
  * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}
174
180
  */
175
181
  export type DashSettings = Record<string, unknown>;
@@ -195,12 +201,12 @@ export type DashSettings = Record<string, unknown>;
195
201
  * }
196
202
  * ```
197
203
  *
198
- * @beta
204
+ * @public
199
205
  */
200
206
  export type TranslationSettings = Partial<Record<LangTag, Record<TranslationKey, string>>>;
201
207
  /**
202
208
  * Dimensions of the player container DOM element.
203
- * @beta
209
+ * @public
204
210
  */
205
211
  export type ContainerSize = {
206
212
  width: number;
@@ -208,7 +214,7 @@ export type ContainerSize = {
208
214
  };
209
215
  /**
210
216
  * A top-level event on the player object
211
- * @beta
217
+ * @public
212
218
  */
213
219
  export declare enum PlayerEvent {
214
220
  /**
@@ -261,4 +267,9 @@ export declare enum PlayerEvent {
261
267
  */
262
268
  VolumeUpdate = "volumeupdate"
263
269
  }
270
+ /**
271
+ * {@link https://zeptojs.com/#$() | Zepto query result}
272
+ * @beta
273
+ */
274
+ export type ZeptoResult = ReturnType<typeof $>;
264
275
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,qBAAqB,CAAA;AAE9D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,OAAO,CAAA;AAE1D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAA;AAEzC;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,CAAA;AAE3C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,CAAA;AAEhD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,qBAAqB,GAAG,0BAA0B,CAAA;AACxF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,IAAI,EAAE,OAAO,KAAK,YAAY,CAAC,GAAG;IACtE,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,SAAS,EAAE,OAAO,KAAK,YAAY,CAAC,GAAG;IAChF,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,YAAY,CAAA;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAA;IAEvC;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAA;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAE5B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAA;AAEnC;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAChD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,IAAI,SAAS;IACb;;;OAGG;IACH,UAAU,eAAe;IACzB;;;OAGG;IACH,YAAY,iBAAiB;CAC9B"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAElD;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,qBAAqB,CAAA;AAE9D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,cAAc,GAAG,OAAO,CAAA;AAE1D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,KAAK,CAAA;AAEzC;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,KAAK,CAAA;AAEhD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,qBAAqB,GAAG,0BAA0B,CAAA;AAExF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,IAAI,EAAE,IAAI,GAAG,YAAY,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,SAAS,EAAE,SAAS,GAAG,YAAY,CAAA;IACxC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3D;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,YAAY,CAAA;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAA;IAE3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAA;IAEvC;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAA;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAE5B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAA;AAEnC;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAChD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,KAAK,UAAU;IACf;;;OAGG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,IAAI,SAAS;IACb;;;OAGG;IACH,UAAU,eAAe;IACzB;;;OAGG;IACH,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC"}
package/lib/types.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * A top-level event on the player object
3
- * @beta
3
+ * @public
4
4
  */
5
5
  export var PlayerEvent;
6
6
  (function (PlayerEvent) {
@@ -1,9 +1,3 @@
1
- import { $ } from "@clappr/core";
2
- /**
3
- * {@link https://zeptojs.com/#$() | Zepto query result}
4
- * @beta
5
- */
6
- export type ZeptoResult = ReturnType<typeof $>;
7
1
  /**
8
2
  * @internal
9
3
  */
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,cAAc,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gcorevideo/player",
3
- "version": "2.20.8",
3
+ "version": "2.20.11",
4
4
  "description": "Gcore JavaScript video player",
5
5
  "main": "dist/index.js",
6
6
  "type": "module",
package/src/Player.ts CHANGED
@@ -26,7 +26,7 @@ import { registerPlaybacks } from './playback/index.js'
26
26
  import { PlaybackError, TimePosition } from './playback.types.js'
27
27
 
28
28
  /**
29
- * @beta
29
+ * @public
30
30
  */
31
31
  export type PlayerEventParams<E extends PlayerEvent> =
32
32
  E extends PlayerEvent.Seek
@@ -46,7 +46,7 @@ export type PlayerEventParams<E extends PlayerEvent> =
46
46
  /**
47
47
  * Type of a listener callback function for a player event.
48
48
  * See the description of the event parameters in {@link PlayerEvent}.
49
- * @beta
49
+ * @public
50
50
  */
51
51
  export type PlayerEventHandler<E extends PlayerEvent> = (
52
52
  ...args: PlayerEventParams<E>
@@ -67,15 +67,15 @@ const DEFAULT_OPTIONS: PlayerConfig = {
67
67
 
68
68
  /**
69
69
  * Module to perform the playback.
70
- * @beta
70
+ * @public
71
71
  */
72
72
  export type PlaybackModule = 'dash' | 'hls' | 'html5_video'
73
73
 
74
74
  type PluginOptions = Record<string, unknown>
75
75
 
76
76
  /**
77
- * The main component to use in the application code.
78
- * @beta
77
+ * `MAIN` component to use in the application code.
78
+ * @public
79
79
  * @remarks
80
80
  * The Player object provides very basic API to control playback.
81
81
  * To build a sophisticated UI, use the plugins framework to tap into the Clappr core.
@@ -360,6 +360,24 @@ export class Player {
360
360
  Loader.registerPlugin(plugin)
361
361
  }
362
362
 
363
+ /**
364
+ * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
365
+ * @remarks
366
+ * It can be also used to unregister a built-in default plugin.
367
+ *
368
+ * Currently, the plugins that are always registered are:
369
+ *
370
+ * - {@link https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/strings/strings.js | 'strings'}, which supports internationalization of the player UI
371
+ *
372
+ * - {@link https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/sources/sources.js | 'sources'}, which lets to specify multiple media sources and selects the first suitable playback module
373
+ *
374
+ * @param name - name of the plugin
375
+ */
376
+ static unregisterPlugin(name: string) {
377
+ Player.corePlugins = Player.corePlugins.filter((p) => p.prototype.name !== name)
378
+ Loader.unregisterPlugin(name)
379
+ }
380
+
363
381
  private static getRegisteredPlugins(): {
364
382
  core: Record<string, PlayerPluginConstructor>
365
383
  container: Record<string, PlayerPluginConstructor>
@@ -372,22 +390,6 @@ export class Player {
372
390
 
373
391
  private static corePlugins: PlayerPluginConstructor[] = []
374
392
 
375
- /**
376
- * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
377
- * @param plugin - a plugin class
378
- */
379
- static unregisterPlugin(plugin: PlayerPluginConstructor) {
380
- assert.ok(
381
- plugin.type === 'core' || plugin.type === 'container',
382
- 'Invalid plugin type',
383
- )
384
- if (plugin.type === 'core') {
385
- Player.corePlugins = Player.corePlugins.filter((p) => p !== plugin)
386
- return
387
- }
388
- Loader.unregisterPlugin(plugin)
389
- }
390
-
391
393
  private setConfig(config: Partial<PlayerConfig>) {
392
394
  this.config = $.extend(true, this.config, config)
393
395
  }
package/src/index.core.ts CHANGED
@@ -2,5 +2,4 @@ export { LogTracer, Logger, SentryTracer, reportError, setTracer, trace } from '
2
2
  export * from './Player.js'
3
3
  export * from './playback.types.js'
4
4
  export * from './types.js'
5
- export * from './utils/types.js'
6
5
  export * from './version.js'
@@ -13,7 +13,6 @@ export * from "./plugins/error-screen/ErrorScreen.js";
13
13
  export * from "./plugins/favicon/Favicon.js";
14
14
  // _ ga-events
15
15
  export * from "./plugins/google-analytics/GoogleAnalytics.js";
16
- export * from "./plugins/kibo/index.js";
17
16
  export * from "./plugins/level-selector/LevelSelector.js";
18
17
  export * from "./plugins/logo/Logo.js";
19
18
  export * from "./plugins/media-control/MediaControl.js";
package/src/index.ts CHANGED
@@ -3,9 +3,26 @@
3
3
  *
4
4
  * @remarks
5
5
  * This package provides a video player for the Gcore streaming platform.
6
- * It is built on top of the Clappr library and provides a framework for building custom integrations.
6
+ * It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations.
7
7
  * Start with {@link Player} for more information.
8
8
  *
9
+ * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
10
+ * @example
11
+ * ```ts
12
+ * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'
13
+ *
14
+ * Player.registerPlugin(MediaControl)
15
+ * Player.registerPlugin(ErrorScreen)
16
+ *
17
+ * const player = new Player({
18
+ * autoPlay: true,
19
+ * mute: true,
20
+ * sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
21
+ * })
22
+ *
23
+ * player.attachTo(document.getElementById('container'))
24
+ * ```
25
+ *
9
26
  * @packageDocumentation
10
27
  */
11
28
  export * from './index.core.js'
@@ -2,14 +2,7 @@
2
2
  // Use of this source code is governed by a BSD-style
3
3
  // license that can be found on https://github.com/clappr/hlsjs-playback/blob/main/LICENSE
4
4
 
5
- import {
6
- Events,
7
- Log,
8
- Playback,
9
- PlayerError,
10
- Utils,
11
- $,
12
- } from '@clappr/core'
5
+ import { Events, Log, Playback, PlayerError, Utils, $ } from '@clappr/core'
13
6
  import { trace } from '@gcorevideo/utils'
14
7
  import assert from 'assert'
15
8
  import HLSJS, {
@@ -1104,9 +1097,12 @@ export default class HlsPlayback extends BasePlayback {
1104
1097
  }
1105
1098
 
1106
1099
  private triggerError(error: PlaybackError) {
1107
- this.trigger(Events.PLAYBACK_ERROR, this.createError(error, {
1108
- useCodePrefix: false,
1109
- }))
1100
+ this.trigger(
1101
+ Events.PLAYBACK_ERROR,
1102
+ this.createError(error, {
1103
+ useCodePrefix: false,
1104
+ }),
1105
+ )
1110
1106
  this.stop()
1111
1107
  }
1112
1108
  }
@@ -1,12 +1,12 @@
1
1
  /**
2
2
  * Playback time in seconds since the beginning of the stream (or a segment for the live streams)
3
- * @beta
3
+ * @public
4
4
  */
5
5
  export type TimeValue = number
6
6
 
7
7
  /**
8
8
  * Current playback time and total duration of the media.
9
- * @beta
9
+ * @public
10
10
  */
11
11
  export interface TimePosition {
12
12
  /**
@@ -35,7 +35,7 @@ export type TimeUpdate = TimePosition & {
35
35
 
36
36
  /**
37
37
  * A level of quality within a media source.
38
- * @beta
38
+ * @public
39
39
  */
40
40
  export interface QualityLevel {
41
41
  /**
@@ -58,7 +58,7 @@ export interface QualityLevel {
58
58
 
59
59
  /**
60
60
  * Codes of errors occurring within the playback component.
61
- * @beta
61
+ * @public
62
62
  */
63
63
  export enum PlaybackErrorCode {
64
64
  /**
@@ -77,19 +77,19 @@ export enum PlaybackErrorCode {
77
77
 
78
78
  /**
79
79
  * Levels of severity of errors. Non-fatal errors usually can be ignored.
80
- * @beta
80
+ * @public
81
81
  */
82
82
  export type ErrorLevel = 'FATAL' | 'WARN' | 'INFO'
83
83
 
84
84
  /**
85
85
  * Subsystems of a player component.
86
- * @beta
86
+ * @public
87
87
  */
88
88
  export type PlayerComponentType = 'container' | 'core' | 'playback'
89
89
 
90
90
  /**
91
91
  * An error occurred during the playback.
92
- * @beta
92
+ * @public
93
93
  */
94
94
  export interface PlaybackError {
95
95
  /**
@@ -127,5 +127,6 @@ export interface PlaybackError {
127
127
  UI?: {
128
128
  title: string
129
129
  message: string
130
+ icon?: string
130
131
  }
131
132
  }
@@ -11,7 +11,7 @@ import { CLAPPR_VERSION } from '../../build.js'
11
11
  import pluginHtml from '../../../assets/audio-selector/track-selector.ejs'
12
12
  import '../../../assets/audio-selector/style.scss'
13
13
  import audioArrow from '../../../assets/icons/old/quality-arrow.svg'
14
- import { ZeptoResult } from '../../utils/types.js'
14
+ import { ZeptoResult } from '../../types.js'
15
15
  import assert from 'assert'
16
16
 
17
17
  const VERSION: string = '0.0.1'
@@ -43,7 +43,7 @@ type AudioTrackList = {
43
43
  }
44
44
 
45
45
  /**
46
- * Adds an audio track selector to the media control UI.
46
+ * `PLUGIN` that adds an audio track selector to the media control UI.
47
47
  * @beta
48
48
  */
49
49
  export class AudioSelector extends UICorePlugin {
@@ -2,7 +2,7 @@ import { Events, template, UICorePlugin, Utils } from '@clappr/core'
2
2
  import { trace } from '@gcorevideo/utils'
3
3
 
4
4
  import { CLAPPR_VERSION } from '../../build.js'
5
- import { ZeptoResult } from '../../utils/types.js'
5
+ import { ZeptoResult } from '../../types.js'
6
6
 
7
7
  import volumeMuteIcon from '../../../assets/icons/new/volume-off.svg'
8
8
  import pluginHtml from '../../../assets/big-mute-button/big-mute-button.ejs'
@@ -13,7 +13,7 @@ const T = 'plugins.big_mute_button'
13
13
  // TODO rewrite as a container plugin
14
14
 
15
15
  /**
16
- * Displays a big mute button over the video when it's muted.
16
+ * `PLUGIN` that displays a big mute button over the video when it's muted.
17
17
  * Once pressed, it unmutes the video.
18
18
  * @beta
19
19
  */
@@ -56,7 +56,6 @@ export class BigMuteButton extends UICorePlugin {
56
56
  * @internal
57
57
  */
58
58
  override bindEvents() {
59
- super.bindEvents()
60
59
  this.listenTo(this.core, Events.CORE_READY, this.onCoreReady)
61
60
  this.listenTo(this.core, 'core:advertisement:start', this.onStartAd)
62
61
  this.listenTo(this.core, 'core:advertisement:finish', this.onFinishAd)
@@ -9,7 +9,7 @@ import '../../../assets/bottom-gear/gear.scss';
9
9
  import '../../../assets/bottom-gear/gear-sub-menu.scss';
10
10
  import gearIcon from '../../../assets/icons/new/gear.svg';
11
11
  import gearHdIcon from '../../../assets/icons/new/gear-hd.svg';
12
- import { ZeptoResult } from '../../utils/types.js';
12
+ import { ZeptoResult } from '../../types.js';
13
13
  import { MediaControlEvents } from '../media-control/MediaControl';
14
14
 
15
15
  const VERSION = '2.19.12';
@@ -23,7 +23,7 @@ const T = 'plugins.bottom_gear';
23
23
  export type GearItemElement = 'quality' | 'rate' | 'nerd';
24
24
 
25
25
  /**
26
- * Adds the gear button that triggers extra options menu on the right side of the {@link MediaControl | media control} UI
26
+ * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI
27
27
  * @beta
28
28
  * @remarks
29
29
  * The plugins provides a base for attaching custom settings UI in the gear menu
@@ -18,7 +18,7 @@ import {
18
18
  stopSpeedtest,
19
19
  } from './speedtest/index.js'
20
20
  import { CustomMetrics } from './speedtest/types.js'
21
- import { ZeptoResult } from '../../utils/types.js'
21
+ import { ZeptoResult } from '../../types.js'
22
22
 
23
23
  import '../../../assets/clappr-nerd-stats/clappr-nerd-stats.scss'
24
24
  import pluginHtml from '../../../assets/clappr-nerd-stats/clappr-nerd-stats.ejs'
@@ -117,7 +117,7 @@ type Metrics = BaseMetrics & {
117
117
  // const T = 'plugins.clappr_nerd_stats';
118
118
 
119
119
  /**
120
- * Displays useful network-related statistics.
120
+ * `PLUGIN` that displays useful network-related statistics.
121
121
  * @beta
122
122
  *
123
123
  * @remarks