@gcorevideo/player 2.20.7 → 2.20.9

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 (218) hide show
  1. package/dist/core.js +54 -25
  2. package/dist/index.css +1184 -1184
  3. package/dist/index.js +298 -267
  4. package/dist/player.d.ts +178 -126
  5. package/dist/plugins/index.css +841 -841
  6. package/dist/plugins/index.js +192 -192
  7. package/docs/api/player.bottomgear.md +14 -0
  8. package/docs/api/player.bottomgear.refresh.md +20 -0
  9. package/docs/api/player.clapprnerdstats.md +1 -1
  10. package/docs/api/player.clapprstats.exportmetrics.md +1 -1
  11. package/docs/api/player.clapprstats.md +1 -15
  12. package/docs/api/player.clapprstats.setupdatemetrics.md +2 -0
  13. package/docs/api/player.clipsplugin.md +1 -1
  14. package/docs/api/player.clipspluginsettings.md +5 -2
  15. package/docs/api/player.clipspluginsettings.text.md +3 -0
  16. package/docs/api/{player.errorscreen.bindevents.md → player.containerpluginconstructor.md} +7 -6
  17. package/docs/api/{player.errorscreen.render.md → player.corepluginconstructor.md} +7 -6
  18. package/docs/api/player.errordesc.md +28 -0
  19. package/docs/api/player.errorscreen.md +1 -220
  20. package/docs/api/{player.errorscreen.hide.md → player.errorscreenpluginsettings.md} +7 -7
  21. package/docs/api/player.levelselector.md +3 -9
  22. package/docs/api/player.levelselectorpluginsettings.labels.md +24 -0
  23. package/docs/api/player.levelselectorpluginsettings.md +79 -0
  24. package/docs/api/player.levelselectorpluginsettings.restrictresolution.md +16 -0
  25. package/docs/api/player.md +93 -16
  26. package/docs/api/{player.errorscreen.container.md → player.mediacontrol.currentseekpos.md} +3 -3
  27. package/docs/api/player.mediacontrol.disable.md +1 -1
  28. package/docs/api/player.mediacontrol.md +23 -2
  29. package/docs/api/{player.gearevents.md → player.mediacontrolevents.md} +4 -4
  30. package/docs/api/player.multicamera.md +1 -29
  31. package/docs/api/player.playbackerror.md +19 -0
  32. package/docs/api/{player.errorscreen.supportedversion.md → player.playbackerror.ui.md} +7 -4
  33. package/docs/api/player.playbackerrorcode.md +3 -3
  34. package/docs/api/{player.errorscreen.show.md → player.playbackrate._constructor_.md} +7 -11
  35. package/docs/api/player.playbackrate.md +35 -2
  36. package/docs/api/player.player.registerplugin.md +2 -2
  37. package/docs/api/player.player.unregisterplugin.md +2 -2
  38. package/docs/api/player.playerpluginconstructor.md +17 -0
  39. package/docs/api/player.share.attributes.md +3 -0
  40. package/docs/api/player.share.bindevents.md +3 -0
  41. package/docs/api/player.share.canshowshare.md +3 -0
  42. package/docs/api/player.share.events.md +3 -0
  43. package/docs/api/player.share.hideshare.md +3 -0
  44. package/docs/api/player.share.initializeicons.md +3 -0
  45. package/docs/api/player.share.md +40 -1
  46. package/docs/api/player.share.name.md +3 -0
  47. package/docs/api/player.share.onshareembedclick.md +3 -0
  48. package/docs/api/player.share.onsharefb.md +3 -0
  49. package/docs/api/player.share.onsharehide.md +3 -0
  50. package/docs/api/player.share.onsharelinkclick.md +3 -0
  51. package/docs/api/player.share.onshareshow.md +3 -0
  52. package/docs/api/player.share.onsharetw.md +3 -0
  53. package/docs/api/player.share.render.md +3 -0
  54. package/docs/api/player.share.showshare.md +3 -0
  55. package/docs/api/player.share.supportedversion.md +3 -0
  56. package/docs/api/player.share.template.md +3 -0
  57. package/docs/api/player.share.unbindevents.md +3 -0
  58. package/docs/api/player.skiptime.attributes.md +3 -0
  59. package/docs/api/player.skiptime.bindevents.md +3 -0
  60. package/docs/api/player.skiptime.container.md +3 -0
  61. package/docs/api/player.skiptime.events.md +3 -0
  62. package/docs/api/player.skiptime.handlerewindclicks.md +3 -0
  63. package/docs/api/player.skiptime.md +30 -1
  64. package/docs/api/player.skiptime.name.md +3 -0
  65. package/docs/api/player.skiptime.render.md +3 -0
  66. package/docs/api/player.skiptime.setback.md +3 -0
  67. package/docs/api/player.skiptime.setforward.md +3 -0
  68. package/docs/api/player.skiptime.setmidclick.md +3 -0
  69. package/docs/api/player.skiptime.supportedversion.md +3 -0
  70. package/docs/api/player.skiptime.template.md +3 -0
  71. package/docs/api/player.skiptime.togglefullscreen.md +3 -0
  72. package/docs/api/player.spinnerevents.md +4 -1
  73. package/docs/api/player.spinnerthreebounce.hide.md +1 -1
  74. package/docs/api/player.spinnerthreebounce.md +7 -5
  75. package/docs/api/player.spinnerthreebounce.show.md +40 -2
  76. package/docs/api/player.telemetry.md +1 -1
  77. package/docs/api/player.telemetrypluginsettings.md +1 -1
  78. package/docs/api/{player.errorscreen.unbindevents.md → player.telemetrysendfn.md} +6 -6
  79. package/lib/Player.d.ts +13 -4
  80. package/lib/Player.d.ts.map +1 -1
  81. package/lib/Player.js +17 -12
  82. package/lib/index.core.d.ts +0 -1
  83. package/lib/index.core.d.ts.map +1 -1
  84. package/lib/index.core.js +0 -1
  85. package/lib/index.plugins.d.ts +0 -1
  86. package/lib/index.plugins.d.ts.map +1 -1
  87. package/lib/index.plugins.js +0 -1
  88. package/lib/playback/BasePlayback.d.ts +5 -0
  89. package/lib/playback/BasePlayback.d.ts.map +1 -1
  90. package/lib/playback/BasePlayback.js +8 -0
  91. package/lib/playback/HTML5Video.d.ts +4 -0
  92. package/lib/playback/HTML5Video.d.ts.map +1 -0
  93. package/lib/playback/HTML5Video.js +3 -0
  94. package/lib/playback/dash-playback/DashPlayback.d.ts +1 -0
  95. package/lib/playback/dash-playback/DashPlayback.d.ts.map +1 -1
  96. package/lib/playback/dash-playback/DashPlayback.js +6 -2
  97. package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
  98. package/lib/playback/hls-playback/HlsPlayback.js +1 -1
  99. package/lib/playback/index.d.ts.map +1 -1
  100. package/lib/playback/index.js +2 -0
  101. package/lib/playback/types.d.ts +9 -0
  102. package/lib/playback/types.d.ts.map +1 -0
  103. package/lib/playback/types.js +9 -0
  104. package/lib/plugins/bottom-gear/BottomGear.d.ts +7 -12
  105. package/lib/plugins/bottom-gear/BottomGear.d.ts.map +1 -1
  106. package/lib/plugins/bottom-gear/BottomGear.js +5 -14
  107. package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts +1 -1
  108. package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js +3 -3
  109. package/lib/plugins/clappr-nerd-stats/speedtest/Speedtest.d.ts.map +1 -1
  110. package/lib/plugins/clappr-nerd-stats/speedtest/Speedtest.js +8 -8
  111. package/lib/plugins/clappr-stats/ClapprStats.d.ts +4 -5
  112. package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
  113. package/lib/plugins/clappr-stats/ClapprStats.js +4 -3
  114. package/lib/plugins/clips/Clips.d.ts +3 -2
  115. package/lib/plugins/clips/Clips.d.ts.map +1 -1
  116. package/lib/plugins/clips/Clips.js +1 -1
  117. package/lib/plugins/context-menu/ContextMenu.d.ts.map +1 -1
  118. package/lib/plugins/dvr-controls/DvrControls.d.ts +4 -3
  119. package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
  120. package/lib/plugins/dvr-controls/DvrControls.js +30 -18
  121. package/lib/plugins/error-screen/ErrorScreen.d.ts +12 -1
  122. package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
  123. package/lib/plugins/error-screen/ErrorScreen.js +1 -1
  124. package/lib/plugins/index.d.ts +0 -1
  125. package/lib/plugins/index.d.ts.map +1 -1
  126. package/lib/plugins/index.js +0 -1
  127. package/lib/plugins/kibo/index.d.ts +0 -3
  128. package/lib/plugins/kibo/index.d.ts.map +1 -1
  129. package/lib/plugins/kibo/index.js +0 -3
  130. package/lib/plugins/level-selector/LevelSelector.d.ts +8 -4
  131. package/lib/plugins/level-selector/LevelSelector.d.ts.map +1 -1
  132. package/lib/plugins/level-selector/LevelSelector.js +16 -7
  133. package/lib/plugins/media-control/MediaControl.d.ts +5 -4
  134. package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
  135. package/lib/plugins/media-control/MediaControl.js +8 -6
  136. package/lib/plugins/multi-camera/MultiCamera.d.ts +3 -11
  137. package/lib/plugins/multi-camera/MultiCamera.d.ts.map +1 -1
  138. package/lib/plugins/multi-camera/MultiCamera.js +1 -1
  139. package/lib/plugins/playback-rate/PlaybackRate.d.ts +11 -10
  140. package/lib/plugins/playback-rate/PlaybackRate.d.ts.map +1 -1
  141. package/lib/plugins/playback-rate/PlaybackRate.js +83 -91
  142. package/lib/plugins/poster/Poster.js +2 -2
  143. package/lib/plugins/share/Share.d.ts +2 -1
  144. package/lib/plugins/share/Share.d.ts.map +1 -1
  145. package/lib/plugins/share/Share.js +2 -1
  146. package/lib/plugins/skip-time/SkipTime.d.ts +2 -1
  147. package/lib/plugins/skip-time/SkipTime.d.ts.map +1 -1
  148. package/lib/plugins/skip-time/SkipTime.js +2 -1
  149. package/lib/plugins/source-controller/SourceController.js +3 -3
  150. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts +6 -3
  151. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map +1 -1
  152. package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +6 -3
  153. package/lib/plugins/telemetry/Telemetry.d.ts +2 -3
  154. package/lib/plugins/telemetry/Telemetry.d.ts.map +1 -1
  155. package/lib/plugins/telemetry/Telemetry.js +1 -1
  156. package/lib/plugins/vast-ads/VastAds.d.ts.map +1 -1
  157. package/lib/plugins/vast-ads/VastAds.js +3 -3
  158. package/lib/plugins/vast-ads/roll.d.ts +1 -1
  159. package/lib/plugins/vast-ads/roll.d.ts.map +1 -1
  160. package/lib/plugins/vast-ads/rollmanager.d.ts +1 -1
  161. package/lib/plugins/vast-ads/rollmanager.d.ts.map +1 -1
  162. package/lib/plugins/vast-ads/rollmanager.js +2 -2
  163. package/lib/types.d.ts +21 -5
  164. package/lib/types.d.ts.map +1 -1
  165. package/lib/utils/types.d.ts +0 -6
  166. package/lib/utils/types.d.ts.map +1 -1
  167. package/package.json +1 -1
  168. package/src/Player.ts +18 -16
  169. package/src/index.core.ts +0 -1
  170. package/src/index.plugins.ts +0 -1
  171. package/src/playback/BasePlayback.ts +12 -4
  172. package/src/playback/HTML5Video.ts +3 -0
  173. package/src/playback/dash-playback/DashPlayback.ts +15 -11
  174. package/src/playback/hls-playback/HlsPlayback.ts +7 -11
  175. package/src/playback/index.ts +2 -1
  176. package/src/playback/types.ts +9 -0
  177. package/src/plugins/audio-selector/AudioSelector.ts +1 -1
  178. package/src/plugins/big-mute-button/BigMuteButton.ts +1 -1
  179. package/src/plugins/bottom-gear/BottomGear.ts +7 -16
  180. package/src/plugins/clappr-nerd-stats/ClapprNerdStats.ts +5 -5
  181. package/src/plugins/clappr-nerd-stats/speedtest/Speedtest.ts +184 -187
  182. package/src/plugins/clappr-stats/ClapprStats.ts +5 -4
  183. package/src/plugins/clips/Clips.ts +4 -3
  184. package/src/plugins/context-menu/ContextMenu.ts +0 -2
  185. package/src/plugins/dvr-controls/DvrControls.ts +90 -56
  186. package/src/plugins/error-screen/ErrorScreen.ts +12 -1
  187. package/src/plugins/favicon/Favicon.ts +1 -1
  188. package/src/plugins/index.ts +0 -1
  189. package/src/plugins/kibo/index.ts +0 -3
  190. package/src/plugins/level-selector/LevelSelector.ts +24 -10
  191. package/src/plugins/logo/Logo.ts +1 -1
  192. package/src/plugins/media-control/MediaControl.ts +13 -10
  193. package/src/plugins/multi-camera/MultiCamera.ts +4 -4
  194. package/src/plugins/playback-rate/PlaybackRate.ts +90 -106
  195. package/src/plugins/poster/Poster.ts +3 -3
  196. package/src/plugins/seek-time/SeekTime.ts +1 -1
  197. package/src/plugins/share/Share.ts +2 -1
  198. package/src/plugins/skip-time/SkipTime.ts +2 -1
  199. package/src/plugins/source-controller/SourceController.ts +3 -3
  200. package/src/plugins/source-controller/__tests__/SourceController.test.ts +2 -2
  201. package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +6 -3
  202. package/src/plugins/subtitles/Subtitles.ts +1 -1
  203. package/src/plugins/telemetry/Telemetry.ts +2 -2
  204. package/src/plugins/thumbnails/Thumbnails.ts +1 -1
  205. package/src/plugins/vast-ads/VastAds.ts +5 -4
  206. package/src/plugins/vast-ads/roll.ts +2 -1
  207. package/src/plugins/vast-ads/rollmanager.ts +3 -3
  208. package/src/types.ts +24 -5
  209. package/src/utils/types.ts +0 -8
  210. package/temp/player.api.json +540 -576
  211. package/tsconfig.tsbuildinfo +1 -1
  212. package/assets/playback-rate/playback-rate-selector.ejs +0 -9
  213. package/docs/api/player.clapprstats.onbitrate.md +0 -52
  214. package/docs/api/player.errorscreen.attributes.md +0 -17
  215. package/docs/api/player.errorscreen.name.md +0 -14
  216. package/docs/api/player.errorscreen.template.md +0 -14
  217. package/docs/api/player.multicamera.getcameraslist.md +0 -18
  218. package/docs/api/player.multicamera.getcurrentcamera.md +0 -18
@@ -451,6 +451,37 @@
451
451
  "isAbstract": false,
452
452
  "name": "getElement"
453
453
  },
454
+ {
455
+ "kind": "Method",
456
+ "canonicalReference": "@gcorevideo/player!BottomGear#refresh:member(1)",
457
+ "docComment": "/**\n * Re-renders the gear menu. It fires the {@link MediaControlEvents.MEDIACONTROL_GEAR_RENDERED | MEDIACONTROL_GEAR_RENDERED} event, which the plugins that attach to the gear menu can listen to to re-render themselves.\n */\n",
458
+ "excerptTokens": [
459
+ {
460
+ "kind": "Content",
461
+ "text": "refresh(): "
462
+ },
463
+ {
464
+ "kind": "Content",
465
+ "text": "void"
466
+ },
467
+ {
468
+ "kind": "Content",
469
+ "text": ";"
470
+ }
471
+ ],
472
+ "isStatic": false,
473
+ "returnTypeTokenRange": {
474
+ "startIndex": 1,
475
+ "endIndex": 2
476
+ },
477
+ "releaseTag": "Beta",
478
+ "isProtected": false,
479
+ "overloadIndex": 1,
480
+ "parameters": [],
481
+ "isOptional": false,
482
+ "isAbstract": false,
483
+ "name": "refresh"
484
+ },
454
485
  {
455
486
  "kind": "Method",
456
487
  "canonicalReference": "@gcorevideo/player!BottomGear#setContent:member(1)",
@@ -510,7 +541,7 @@
510
541
  {
511
542
  "kind": "Class",
512
543
  "canonicalReference": "@gcorevideo/player!ClapprNerdStats:class",
513
- "docComment": "/**\n * Displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
544
+ "docComment": "/**\n * PLUGIN that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
514
545
  "excerptTokens": [
515
546
  {
516
547
  "kind": "Content",
@@ -575,7 +606,7 @@
575
606
  {
576
607
  "kind": "Class",
577
608
  "canonicalReference": "@gcorevideo/player!ClapprStats:class",
578
- "docComment": "/**\n * Collects useful statistics about playback performance.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * @beta\n */\n",
609
+ "docComment": "/**\n * PLIGIN that collects useful statistics about playback performance.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * @beta\n */\n",
579
610
  "excerptTokens": [
580
611
  {
581
612
  "kind": "Content",
@@ -633,7 +664,7 @@
633
664
  {
634
665
  "kind": "Method",
635
666
  "canonicalReference": "@gcorevideo/player!ClapprStats#exportMetrics:member(1)",
636
- "docComment": "/**\n * Returns the collected metrics.\n *\n * @returns The collected metrics\n */\n",
667
+ "docComment": "/**\n * Returns the collected metrics.\n *\n * @returns Currently collected metrics\n */\n",
637
668
  "excerptTokens": [
638
669
  {
639
670
  "kind": "Content",
@@ -662,59 +693,10 @@
662
693
  "isAbstract": false,
663
694
  "name": "exportMetrics"
664
695
  },
665
- {
666
- "kind": "Method",
667
- "canonicalReference": "@gcorevideo/player!ClapprStats#onBitrate:member(1)",
668
- "docComment": "",
669
- "excerptTokens": [
670
- {
671
- "kind": "Content",
672
- "text": "onBitrate(newBitrate: "
673
- },
674
- {
675
- "kind": "Reference",
676
- "text": "QualityLevel",
677
- "canonicalReference": "@gcorevideo/player!QualityLevel:interface"
678
- },
679
- {
680
- "kind": "Content",
681
- "text": "): "
682
- },
683
- {
684
- "kind": "Content",
685
- "text": "void"
686
- },
687
- {
688
- "kind": "Content",
689
- "text": ";"
690
- }
691
- ],
692
- "isStatic": false,
693
- "returnTypeTokenRange": {
694
- "startIndex": 3,
695
- "endIndex": 4
696
- },
697
- "releaseTag": "Beta",
698
- "isProtected": false,
699
- "overloadIndex": 1,
700
- "parameters": [
701
- {
702
- "parameterName": "newBitrate",
703
- "parameterTypeTokenRange": {
704
- "startIndex": 1,
705
- "endIndex": 2
706
- },
707
- "isOptional": false
708
- }
709
- ],
710
- "isOptional": false,
711
- "isAbstract": false,
712
- "name": "onBitrate"
713
- },
714
696
  {
715
697
  "kind": "Method",
716
698
  "canonicalReference": "@gcorevideo/player!ClapprStats#setUpdateMetrics:member(1)",
717
- "docComment": "/**\n * Registers a callback to receive the metrics.\n *\n * @param updateMetricsFn - \n */\n",
699
+ "docComment": "/**\n * Registers a callback to receive the metrics.\n *\n * @param updateMetricsFn - The callback to receive the metrics\n */\n",
718
700
  "excerptTokens": [
719
701
  {
720
702
  "kind": "Content",
@@ -801,7 +783,7 @@
801
783
  {
802
784
  "kind": "Class",
803
785
  "canonicalReference": "@gcorevideo/player!ClipsPlugin:class",
804
- "docComment": "/**\n * Adds a behavior of showing a text over the seekbar to indicate the current clip.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
786
+ "docComment": "/**\n * PLUGIN that shows text over the seekbar to indicate the current clip.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
805
787
  "excerptTokens": [
806
788
  {
807
789
  "kind": "Content",
@@ -881,7 +863,7 @@
881
863
  {
882
864
  "kind": "Interface",
883
865
  "canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
884
- "docComment": "/**\n * Configuration options\n */\n",
866
+ "docComment": "/**\n * Configuration options for the {@link ClipsPlugin | clips} plugin.\n *\n * @beta\n */\n",
885
867
  "excerptTokens": [
886
868
  {
887
869
  "kind": "Content",
@@ -889,7 +871,7 @@
889
871
  }
890
872
  ],
891
873
  "fileUrlPath": "src/plugins/clips/Clips.ts",
892
- "releaseTag": "Public",
874
+ "releaseTag": "Beta",
893
875
  "name": "ClipsPluginSettings",
894
876
  "preserveMemberOrder": false,
895
877
  "members": [
@@ -913,7 +895,7 @@
913
895
  ],
914
896
  "isReadonly": false,
915
897
  "isOptional": false,
916
- "releaseTag": "Public",
898
+ "releaseTag": "Beta",
917
899
  "name": "text",
918
900
  "propertyTypeTokenRange": {
919
901
  "startIndex": 1,
@@ -923,6 +905,41 @@
923
905
  ],
924
906
  "extendsTokenRanges": []
925
907
  },
908
+ {
909
+ "kind": "TypeAlias",
910
+ "canonicalReference": "@gcorevideo/player!ContainerPluginConstructor:type",
911
+ "docComment": "/**\n * @beta\n */\n",
912
+ "excerptTokens": [
913
+ {
914
+ "kind": "Content",
915
+ "text": "export type ContainerPluginConstructor = "
916
+ },
917
+ {
918
+ "kind": "Content",
919
+ "text": "((container: unknown) => "
920
+ },
921
+ {
922
+ "kind": "Reference",
923
+ "text": "PlayerPlugin",
924
+ "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
925
+ },
926
+ {
927
+ "kind": "Content",
928
+ "text": ") & {\n type: 'container';\n}"
929
+ },
930
+ {
931
+ "kind": "Content",
932
+ "text": ";"
933
+ }
934
+ ],
935
+ "fileUrlPath": "src/types.ts",
936
+ "releaseTag": "Beta",
937
+ "name": "ContainerPluginConstructor",
938
+ "typeTokenRange": {
939
+ "startIndex": 1,
940
+ "endIndex": 4
941
+ }
942
+ },
926
943
  {
927
944
  "kind": "TypeAlias",
928
945
  "canonicalReference": "@gcorevideo/player!ContainerSize:type",
@@ -1113,6 +1130,41 @@
1113
1130
  ],
1114
1131
  "extendsTokenRanges": []
1115
1132
  },
1133
+ {
1134
+ "kind": "TypeAlias",
1135
+ "canonicalReference": "@gcorevideo/player!CorePluginConstructor:type",
1136
+ "docComment": "/**\n * @beta\n */\n",
1137
+ "excerptTokens": [
1138
+ {
1139
+ "kind": "Content",
1140
+ "text": "export type CorePluginConstructor = "
1141
+ },
1142
+ {
1143
+ "kind": "Content",
1144
+ "text": "((core: unknown) => "
1145
+ },
1146
+ {
1147
+ "kind": "Reference",
1148
+ "text": "PlayerPlugin",
1149
+ "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
1150
+ },
1151
+ {
1152
+ "kind": "Content",
1153
+ "text": ") & {\n type: 'core';\n}"
1154
+ },
1155
+ {
1156
+ "kind": "Content",
1157
+ "text": ";"
1158
+ }
1159
+ ],
1160
+ "fileUrlPath": "src/types.ts",
1161
+ "releaseTag": "Beta",
1162
+ "name": "CorePluginConstructor",
1163
+ "typeTokenRange": {
1164
+ "startIndex": 1,
1165
+ "endIndex": 4
1166
+ }
1167
+ },
1116
1168
  {
1117
1169
  "kind": "TypeAlias",
1118
1170
  "canonicalReference": "@gcorevideo/player!DashSettings:type",
@@ -1211,385 +1263,113 @@
1211
1263
  },
1212
1264
  {
1213
1265
  "kind": "TypeAlias",
1214
- "canonicalReference": "@gcorevideo/player!ErrorLevel:type",
1215
- "docComment": "/**\n * Levels of severity of errors. Non-fatal errors usually can be ignored.\n *\n * @beta\n */\n",
1266
+ "canonicalReference": "@gcorevideo/player!ErrorDesc:type",
1267
+ "docComment": "/**\n * An error fired in the player and plugins code to be handled in the UI\n *\n * @beta\n */\n",
1216
1268
  "excerptTokens": [
1217
1269
  {
1218
1270
  "kind": "Content",
1219
- "text": "export type ErrorLevel = "
1271
+ "text": "export type ErrorDesc = "
1220
1272
  },
1221
1273
  {
1222
1274
  "kind": "Content",
1223
- "text": "'FATAL' | 'WARN' | 'INFO'"
1275
+ "text": "{\n description: string;\n level: string;\n code: string;\n origin: string;\n scope: string;\n raw?: string;\n UI?: {\n icon?: string;\n title: string;\n message: string;\n };\n}"
1224
1276
  },
1225
1277
  {
1226
1278
  "kind": "Content",
1227
1279
  "text": ";"
1228
1280
  }
1229
1281
  ],
1230
- "fileUrlPath": "src/playback.types.ts",
1282
+ "fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
1231
1283
  "releaseTag": "Beta",
1232
- "name": "ErrorLevel",
1284
+ "name": "ErrorDesc",
1233
1285
  "typeTokenRange": {
1234
1286
  "startIndex": 1,
1235
1287
  "endIndex": 2
1236
1288
  }
1237
1289
  },
1238
1290
  {
1239
- "kind": "Class",
1240
- "canonicalReference": "@gcorevideo/player!ErrorScreen:class",
1241
- "docComment": "/**\n * Displays a descriptive error in the overlay on top of the player.\n *\n * @beta\n */\n",
1291
+ "kind": "TypeAlias",
1292
+ "canonicalReference": "@gcorevideo/player!ErrorLevel:type",
1293
+ "docComment": "/**\n * Levels of severity of errors. Non-fatal errors usually can be ignored.\n *\n * @beta\n */\n",
1242
1294
  "excerptTokens": [
1243
1295
  {
1244
1296
  "kind": "Content",
1245
- "text": "export declare class ErrorScreen extends "
1246
- },
1247
- {
1248
- "kind": "Reference",
1249
- "text": "UICorePlugin",
1250
- "canonicalReference": "@gcorevideo/player!~UICorePlugin"
1297
+ "text": "export type ErrorLevel = "
1251
1298
  },
1252
1299
  {
1253
1300
  "kind": "Content",
1254
- "text": " "
1255
- }
1256
- ],
1257
- "fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
1258
- "releaseTag": "Beta",
1259
- "isAbstract": false,
1260
- "name": "ErrorScreen",
1261
- "preserveMemberOrder": false,
1262
- "members": [
1263
- {
1264
- "kind": "Property",
1265
- "canonicalReference": "@gcorevideo/player!ErrorScreen#attributes:member",
1266
- "docComment": "",
1267
- "excerptTokens": [
1268
- {
1269
- "kind": "Content",
1270
- "text": "get attributes(): "
1271
- },
1272
- {
1273
- "kind": "Content",
1274
- "text": "{\n class: string;\n 'data-error-screen': string;\n }"
1275
- },
1276
- {
1277
- "kind": "Content",
1278
- "text": ";"
1279
- }
1280
- ],
1281
- "isReadonly": true,
1282
- "isOptional": false,
1283
- "releaseTag": "Beta",
1284
- "name": "attributes",
1285
- "propertyTypeTokenRange": {
1286
- "startIndex": 1,
1287
- "endIndex": 2
1288
- },
1289
- "isStatic": false,
1290
- "isProtected": false,
1291
- "isAbstract": false
1292
- },
1293
- {
1294
- "kind": "Method",
1295
- "canonicalReference": "@gcorevideo/player!ErrorScreen#bindEvents:member(1)",
1296
- "docComment": "",
1297
- "excerptTokens": [
1298
- {
1299
- "kind": "Content",
1300
- "text": "bindEvents(): "
1301
- },
1302
- {
1303
- "kind": "Content",
1304
- "text": "void"
1305
- },
1306
- {
1307
- "kind": "Content",
1308
- "text": ";"
1309
- }
1310
- ],
1311
- "isStatic": false,
1312
- "returnTypeTokenRange": {
1313
- "startIndex": 1,
1314
- "endIndex": 2
1315
- },
1316
- "releaseTag": "Beta",
1317
- "isProtected": false,
1318
- "overloadIndex": 1,
1319
- "parameters": [],
1320
- "isOptional": false,
1321
- "isAbstract": false,
1322
- "name": "bindEvents"
1323
- },
1324
- {
1325
- "kind": "Property",
1326
- "canonicalReference": "@gcorevideo/player!ErrorScreen#container:member",
1327
- "docComment": "",
1328
- "excerptTokens": [
1329
- {
1330
- "kind": "Content",
1331
- "text": "get container(): "
1332
- },
1333
- {
1334
- "kind": "Content",
1335
- "text": "any"
1336
- },
1337
- {
1338
- "kind": "Content",
1339
- "text": ";"
1340
- }
1341
- ],
1342
- "isReadonly": true,
1343
- "isOptional": false,
1344
- "releaseTag": "Beta",
1345
- "name": "container",
1346
- "propertyTypeTokenRange": {
1347
- "startIndex": 1,
1348
- "endIndex": 2
1349
- },
1350
- "isStatic": false,
1351
- "isProtected": false,
1352
- "isAbstract": false
1353
- },
1354
- {
1355
- "kind": "Method",
1356
- "canonicalReference": "@gcorevideo/player!ErrorScreen#hide:member(1)",
1357
- "docComment": "",
1358
- "excerptTokens": [
1359
- {
1360
- "kind": "Content",
1361
- "text": "hide(): "
1362
- },
1363
- {
1364
- "kind": "Content",
1365
- "text": "void"
1366
- },
1367
- {
1368
- "kind": "Content",
1369
- "text": ";"
1370
- }
1371
- ],
1372
- "isStatic": false,
1373
- "returnTypeTokenRange": {
1374
- "startIndex": 1,
1375
- "endIndex": 2
1376
- },
1377
- "releaseTag": "Beta",
1378
- "isProtected": false,
1379
- "overloadIndex": 1,
1380
- "parameters": [],
1381
- "isOptional": false,
1382
- "isAbstract": false,
1383
- "name": "hide"
1384
- },
1385
- {
1386
- "kind": "Property",
1387
- "canonicalReference": "@gcorevideo/player!ErrorScreen#name:member",
1388
- "docComment": "",
1389
- "excerptTokens": [
1390
- {
1391
- "kind": "Content",
1392
- "text": "get name(): "
1393
- },
1394
- {
1395
- "kind": "Content",
1396
- "text": "string"
1397
- },
1398
- {
1399
- "kind": "Content",
1400
- "text": ";"
1401
- }
1402
- ],
1403
- "isReadonly": true,
1404
- "isOptional": false,
1405
- "releaseTag": "Beta",
1406
- "name": "name",
1407
- "propertyTypeTokenRange": {
1408
- "startIndex": 1,
1409
- "endIndex": 2
1410
- },
1411
- "isStatic": false,
1412
- "isProtected": false,
1413
- "isAbstract": false
1414
- },
1415
- {
1416
- "kind": "Method",
1417
- "canonicalReference": "@gcorevideo/player!ErrorScreen#render:member(1)",
1418
- "docComment": "",
1419
- "excerptTokens": [
1420
- {
1421
- "kind": "Content",
1422
- "text": "render(): "
1423
- },
1424
- {
1425
- "kind": "Content",
1426
- "text": "this"
1427
- },
1428
- {
1429
- "kind": "Content",
1430
- "text": ";"
1431
- }
1432
- ],
1433
- "isStatic": false,
1434
- "returnTypeTokenRange": {
1435
- "startIndex": 1,
1436
- "endIndex": 2
1437
- },
1438
- "releaseTag": "Beta",
1439
- "isProtected": false,
1440
- "overloadIndex": 1,
1441
- "parameters": [],
1442
- "isOptional": false,
1443
- "isAbstract": false,
1444
- "name": "render"
1445
- },
1446
- {
1447
- "kind": "Method",
1448
- "canonicalReference": "@gcorevideo/player!ErrorScreen#show:member(1)",
1449
- "docComment": "",
1450
- "excerptTokens": [
1451
- {
1452
- "kind": "Content",
1453
- "text": "show(err?: "
1454
- },
1455
- {
1456
- "kind": "Reference",
1457
- "text": "PresentationalError",
1458
- "canonicalReference": "@gcorevideo/player!~PresentationalError:type"
1459
- },
1460
- {
1461
- "kind": "Content",
1462
- "text": "): "
1463
- },
1464
- {
1465
- "kind": "Content",
1466
- "text": "void"
1467
- },
1468
- {
1469
- "kind": "Content",
1470
- "text": ";"
1471
- }
1472
- ],
1473
- "isStatic": false,
1474
- "returnTypeTokenRange": {
1475
- "startIndex": 3,
1476
- "endIndex": 4
1477
- },
1478
- "releaseTag": "Beta",
1479
- "isProtected": false,
1480
- "overloadIndex": 1,
1481
- "parameters": [
1482
- {
1483
- "parameterName": "err",
1484
- "parameterTypeTokenRange": {
1485
- "startIndex": 1,
1486
- "endIndex": 2
1487
- },
1488
- "isOptional": true
1489
- }
1490
- ],
1491
- "isOptional": false,
1492
- "isAbstract": false,
1493
- "name": "show"
1301
+ "text": "'FATAL' | 'WARN' | 'INFO'"
1494
1302
  },
1495
1303
  {
1496
- "kind": "Property",
1497
- "canonicalReference": "@gcorevideo/player!ErrorScreen#supportedVersion:member",
1498
- "docComment": "",
1499
- "excerptTokens": [
1500
- {
1501
- "kind": "Content",
1502
- "text": "get supportedVersion(): "
1503
- },
1504
- {
1505
- "kind": "Content",
1506
- "text": "{\n min: string;\n }"
1507
- },
1508
- {
1509
- "kind": "Content",
1510
- "text": ";"
1511
- }
1512
- ],
1513
- "isReadonly": true,
1514
- "isOptional": false,
1515
- "releaseTag": "Beta",
1516
- "name": "supportedVersion",
1517
- "propertyTypeTokenRange": {
1518
- "startIndex": 1,
1519
- "endIndex": 2
1520
- },
1521
- "isStatic": false,
1522
- "isProtected": false,
1523
- "isAbstract": false
1304
+ "kind": "Content",
1305
+ "text": ";"
1306
+ }
1307
+ ],
1308
+ "fileUrlPath": "src/playback.types.ts",
1309
+ "releaseTag": "Beta",
1310
+ "name": "ErrorLevel",
1311
+ "typeTokenRange": {
1312
+ "startIndex": 1,
1313
+ "endIndex": 2
1314
+ }
1315
+ },
1316
+ {
1317
+ "kind": "Class",
1318
+ "canonicalReference": "@gcorevideo/player!ErrorScreen:class",
1319
+ "docComment": "/**\n * PLUGIN that displays errors nicely in the overlay on top of the player.\n *\n * @beta\n */\n",
1320
+ "excerptTokens": [
1321
+ {
1322
+ "kind": "Content",
1323
+ "text": "export declare class ErrorScreen extends "
1524
1324
  },
1525
1325
  {
1526
- "kind": "Property",
1527
- "canonicalReference": "@gcorevideo/player!ErrorScreen#template:member",
1528
- "docComment": "",
1529
- "excerptTokens": [
1530
- {
1531
- "kind": "Content",
1532
- "text": "get template(): "
1533
- },
1534
- {
1535
- "kind": "Content",
1536
- "text": "any"
1537
- },
1538
- {
1539
- "kind": "Content",
1540
- "text": ";"
1541
- }
1542
- ],
1543
- "isReadonly": true,
1544
- "isOptional": false,
1545
- "releaseTag": "Beta",
1546
- "name": "template",
1547
- "propertyTypeTokenRange": {
1548
- "startIndex": 1,
1549
- "endIndex": 2
1550
- },
1551
- "isStatic": false,
1552
- "isProtected": false,
1553
- "isAbstract": false
1326
+ "kind": "Reference",
1327
+ "text": "UICorePlugin",
1328
+ "canonicalReference": "@gcorevideo/player!~UICorePlugin"
1554
1329
  },
1555
1330
  {
1556
- "kind": "Method",
1557
- "canonicalReference": "@gcorevideo/player!ErrorScreen#unBindEvents:member(1)",
1558
- "docComment": "",
1559
- "excerptTokens": [
1560
- {
1561
- "kind": "Content",
1562
- "text": "unBindEvents(): "
1563
- },
1564
- {
1565
- "kind": "Content",
1566
- "text": "void"
1567
- },
1568
- {
1569
- "kind": "Content",
1570
- "text": ";"
1571
- }
1572
- ],
1573
- "isStatic": false,
1574
- "returnTypeTokenRange": {
1575
- "startIndex": 1,
1576
- "endIndex": 2
1577
- },
1578
- "releaseTag": "Beta",
1579
- "isProtected": false,
1580
- "overloadIndex": 1,
1581
- "parameters": [],
1582
- "isOptional": false,
1583
- "isAbstract": false,
1584
- "name": "unBindEvents"
1331
+ "kind": "Content",
1332
+ "text": " "
1585
1333
  }
1586
1334
  ],
1335
+ "fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
1336
+ "releaseTag": "Beta",
1337
+ "isAbstract": false,
1338
+ "name": "ErrorScreen",
1339
+ "preserveMemberOrder": false,
1340
+ "members": [],
1587
1341
  "extendsTokenRange": {
1588
1342
  "startIndex": 1,
1589
1343
  "endIndex": 2
1590
1344
  },
1591
1345
  "implementsTokenRanges": []
1592
1346
  },
1347
+ {
1348
+ "kind": "TypeAlias",
1349
+ "canonicalReference": "@gcorevideo/player!ErrorScreenPluginSettings:type",
1350
+ "docComment": "/**\n * Configuration options for the {@link ErrorScreen | error screen} plugin.\n *\n * @beta\n */\n",
1351
+ "excerptTokens": [
1352
+ {
1353
+ "kind": "Content",
1354
+ "text": "export type ErrorScreenPluginSettings = "
1355
+ },
1356
+ {
1357
+ "kind": "Content",
1358
+ "text": "{\n noReload?: boolean;\n}"
1359
+ },
1360
+ {
1361
+ "kind": "Content",
1362
+ "text": ";"
1363
+ }
1364
+ ],
1365
+ "fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
1366
+ "releaseTag": "Beta",
1367
+ "name": "ErrorScreenPluginSettings",
1368
+ "typeTokenRange": {
1369
+ "startIndex": 1,
1370
+ "endIndex": 2
1371
+ }
1372
+ },
1593
1373
  {
1594
1374
  "kind": "Class",
1595
1375
  "canonicalReference": "@gcorevideo/player!Favicon:class",
@@ -1839,44 +1619,6 @@
1839
1619
  },
1840
1620
  "implementsTokenRanges": []
1841
1621
  },
1842
- {
1843
- "kind": "Enum",
1844
- "canonicalReference": "@gcorevideo/player!GearEvents:enum",
1845
- "docComment": "/**\n * Custom events emitted by the plugin\n *\n * @beta\n */\n",
1846
- "excerptTokens": [
1847
- {
1848
- "kind": "Content",
1849
- "text": "export declare enum GearEvents "
1850
- }
1851
- ],
1852
- "fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
1853
- "releaseTag": "Beta",
1854
- "name": "GearEvents",
1855
- "preserveMemberOrder": false,
1856
- "members": [
1857
- {
1858
- "kind": "EnumMember",
1859
- "canonicalReference": "@gcorevideo/player!GearEvents.MEDIACONTROL_GEAR_RENDERED:member",
1860
- "docComment": "/**\n * Emitted when the gear menu is rendered\n */\n",
1861
- "excerptTokens": [
1862
- {
1863
- "kind": "Content",
1864
- "text": "MEDIACONTROL_GEAR_RENDERED = "
1865
- },
1866
- {
1867
- "kind": "Content",
1868
- "text": "\"mediacontrol:gear:rendered\""
1869
- }
1870
- ],
1871
- "initializerTokenRange": {
1872
- "startIndex": 1,
1873
- "endIndex": 2
1874
- },
1875
- "releaseTag": "Beta",
1876
- "name": "MEDIACONTROL_GEAR_RENDERED"
1877
- }
1878
- ]
1879
- },
1880
1622
  {
1881
1623
  "kind": "TypeAlias",
1882
1624
  "canonicalReference": "@gcorevideo/player!GearItemElement:type",
@@ -2650,7 +2392,7 @@
2650
2392
  {
2651
2393
  "kind": "Class",
2652
2394
  "canonicalReference": "@gcorevideo/player!LevelSelector:class",
2653
- "docComment": "/**\n * A {@link MediaControl | media control} plugin that provides a UI to control the quality level of the playback.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows a list of quality levels to choose from.\n *\n * Configuration options:\n *\n * - `labels`: The labels to show in the level selector. [video resolution]: string\n *\n * - `restrictResolution`: The maximum resolution to allow in the level selector.\n *\n * @example\n * ```ts\n * new Player({\n * levelSelector: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @beta\n */\n",
2395
+ "docComment": "/**\n * PLUGIN that provides a UI to select the desired quality level of the playback.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.\n *\n * Configuration options - {@link LevelSelectorPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * levelSelector: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @beta\n */\n",
2654
2396
  "excerptTokens": [
2655
2397
  {
2656
2398
  "kind": "Content",
@@ -2709,6 +2451,83 @@
2709
2451
  },
2710
2452
  "implementsTokenRanges": []
2711
2453
  },
2454
+ {
2455
+ "kind": "Interface",
2456
+ "canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings:interface",
2457
+ "docComment": "/**\n * Configuration options for the {@link LevelSelector | level selector} plugin.\n *\n * @beta\n */\n",
2458
+ "excerptTokens": [
2459
+ {
2460
+ "kind": "Content",
2461
+ "text": "export interface LevelSelectorPluginSettings "
2462
+ }
2463
+ ],
2464
+ "fileUrlPath": "src/plugins/level-selector/LevelSelector.ts",
2465
+ "releaseTag": "Beta",
2466
+ "name": "LevelSelectorPluginSettings",
2467
+ "preserveMemberOrder": false,
2468
+ "members": [
2469
+ {
2470
+ "kind": "PropertySignature",
2471
+ "canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings#labels:member",
2472
+ "docComment": "/**\n * The labels to show in the level selector.\n *\n * @example\n * ```ts\n * { 360: 'SD', 720: 'HD' }\n * ```\n *\n */\n",
2473
+ "excerptTokens": [
2474
+ {
2475
+ "kind": "Content",
2476
+ "text": "labels?: "
2477
+ },
2478
+ {
2479
+ "kind": "Reference",
2480
+ "text": "Record",
2481
+ "canonicalReference": "!Record:type"
2482
+ },
2483
+ {
2484
+ "kind": "Content",
2485
+ "text": "<number, string>"
2486
+ },
2487
+ {
2488
+ "kind": "Content",
2489
+ "text": ";"
2490
+ }
2491
+ ],
2492
+ "isReadonly": false,
2493
+ "isOptional": true,
2494
+ "releaseTag": "Beta",
2495
+ "name": "labels",
2496
+ "propertyTypeTokenRange": {
2497
+ "startIndex": 1,
2498
+ "endIndex": 3
2499
+ }
2500
+ },
2501
+ {
2502
+ "kind": "PropertySignature",
2503
+ "canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings#restrictResolution:member",
2504
+ "docComment": "/**\n * The maximum resolution to allow in the level selector.\n */\n",
2505
+ "excerptTokens": [
2506
+ {
2507
+ "kind": "Content",
2508
+ "text": "restrictResolution?: "
2509
+ },
2510
+ {
2511
+ "kind": "Content",
2512
+ "text": "number"
2513
+ },
2514
+ {
2515
+ "kind": "Content",
2516
+ "text": ";"
2517
+ }
2518
+ ],
2519
+ "isReadonly": false,
2520
+ "isOptional": true,
2521
+ "releaseTag": "Beta",
2522
+ "name": "restrictResolution",
2523
+ "propertyTypeTokenRange": {
2524
+ "startIndex": 1,
2525
+ "endIndex": 2
2526
+ }
2527
+ }
2528
+ ],
2529
+ "extendsTokenRanges": []
2530
+ },
2712
2531
  {
2713
2532
  "kind": "Class",
2714
2533
  "canonicalReference": "@gcorevideo/player!Logo:class",
@@ -2990,7 +2809,7 @@
2990
2809
  {
2991
2810
  "kind": "Class",
2992
2811
  "canonicalReference": "@gcorevideo/player!MediaControl:class",
2993
- "docComment": "/**\n * The MediaControl provides a foundation for developing custom media controls UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other plugin that depends on it.\n *\n * @example\n * ```ts\n * Player.registerPlugin(MediaControl) // <--- This must go first\n * Player.registerPlugin(LevelSelector) // a media control plugin\n * Player.registerPlugin(NerdStats) // another media control plugin\n * ```\n *\n * @beta\n */\n",
2812
+ "docComment": "/**\n * PLUGIN that provides a foundation for developing custom media controls UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other plugin that depends on it.\n *\n * @example\n * ```ts\n * Player.registerPlugin(MediaControl) // <--- This must go first\n * Player.registerPlugin(LevelSelector) // a media control plugin\n * Player.registerPlugin(NerdStats) // another media control plugin\n * ```\n *\n * @beta\n */\n",
2994
2813
  "excerptTokens": [
2995
2814
  {
2996
2815
  "kind": "Content",
@@ -3045,10 +2864,40 @@
3045
2864
  }
3046
2865
  ]
3047
2866
  },
2867
+ {
2868
+ "kind": "Property",
2869
+ "canonicalReference": "@gcorevideo/player!MediaControl#currentSeekPos:member",
2870
+ "docComment": "",
2871
+ "excerptTokens": [
2872
+ {
2873
+ "kind": "Content",
2874
+ "text": "get currentSeekPos(): "
2875
+ },
2876
+ {
2877
+ "kind": "Content",
2878
+ "text": "number"
2879
+ },
2880
+ {
2881
+ "kind": "Content",
2882
+ "text": ";"
2883
+ }
2884
+ ],
2885
+ "isReadonly": true,
2886
+ "isOptional": false,
2887
+ "releaseTag": "Beta",
2888
+ "name": "currentSeekPos",
2889
+ "propertyTypeTokenRange": {
2890
+ "startIndex": 1,
2891
+ "endIndex": 2
2892
+ },
2893
+ "isStatic": false,
2894
+ "isProtected": false,
2895
+ "isAbstract": false
2896
+ },
3048
2897
  {
3049
2898
  "kind": "Method",
3050
2899
  "canonicalReference": "@gcorevideo/player!MediaControl#disable:member(1)",
3051
- "docComment": "/**\n * Disables the plugin and unmounts its UI\n */\n",
2900
+ "docComment": "/**\n * Hides the media control UI\n */\n",
3052
2901
  "excerptTokens": [
3053
2902
  {
3054
2903
  "kind": "Content",
@@ -3433,14 +3282,52 @@
3433
3282
  "kind": "Content",
3434
3283
  "text": ";"
3435
3284
  }
3436
- ],
3437
- "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
3438
- "releaseTag": "Beta",
3439
- "name": "MediaControlElement",
3440
- "typeTokenRange": {
3441
- "startIndex": 1,
3442
- "endIndex": 2
3443
- }
3285
+ ],
3286
+ "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
3287
+ "releaseTag": "Beta",
3288
+ "name": "MediaControlElement",
3289
+ "typeTokenRange": {
3290
+ "startIndex": 1,
3291
+ "endIndex": 2
3292
+ }
3293
+ },
3294
+ {
3295
+ "kind": "Enum",
3296
+ "canonicalReference": "@gcorevideo/player!MediaControlEvents:enum",
3297
+ "docComment": "/**\n * Custom events emitted by the plugins to communicate with one another\n *\n * @beta\n */\n",
3298
+ "excerptTokens": [
3299
+ {
3300
+ "kind": "Content",
3301
+ "text": "export declare enum MediaControlEvents "
3302
+ }
3303
+ ],
3304
+ "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
3305
+ "releaseTag": "Beta",
3306
+ "name": "MediaControlEvents",
3307
+ "preserveMemberOrder": false,
3308
+ "members": [
3309
+ {
3310
+ "kind": "EnumMember",
3311
+ "canonicalReference": "@gcorevideo/player!MediaControlEvents.MEDIACONTROL_GEAR_RENDERED:member",
3312
+ "docComment": "/**\n * Emitted when the gear menu is rendered\n */\n",
3313
+ "excerptTokens": [
3314
+ {
3315
+ "kind": "Content",
3316
+ "text": "MEDIACONTROL_GEAR_RENDERED = "
3317
+ },
3318
+ {
3319
+ "kind": "Content",
3320
+ "text": "\"mediacontrol:gear:rendered\""
3321
+ }
3322
+ ],
3323
+ "initializerTokenRange": {
3324
+ "startIndex": 1,
3325
+ "endIndex": 2
3326
+ },
3327
+ "releaseTag": "Beta",
3328
+ "name": "MEDIACONTROL_GEAR_RENDERED"
3329
+ }
3330
+ ]
3444
3331
  },
3445
3332
  {
3446
3333
  "kind": "TypeAlias",
@@ -3471,7 +3358,7 @@
3471
3358
  {
3472
3359
  "kind": "Class",
3473
3360
  "canonicalReference": "@gcorevideo/player!MultiCamera:class",
3474
- "docComment": "/**\n * The plugin adds support for loading multiple streams and switching between them using the media control UI.\n *\n * @beta\n */\n",
3361
+ "docComment": "/**\n * PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.\n *\n * @beta\n */\n",
3475
3362
  "excerptTokens": [
3476
3363
  {
3477
3364
  "kind": "Content",
@@ -3681,78 +3568,6 @@
3681
3568
  "isProtected": false,
3682
3569
  "isAbstract": false
3683
3570
  },
3684
- {
3685
- "kind": "Method",
3686
- "canonicalReference": "@gcorevideo/player!MultiCamera#getCamerasList:member(1)",
3687
- "docComment": "",
3688
- "excerptTokens": [
3689
- {
3690
- "kind": "Content",
3691
- "text": "getCamerasList(): "
3692
- },
3693
- {
3694
- "kind": "Reference",
3695
- "text": "MediaSourceInfo",
3696
- "canonicalReference": "@gcorevideo/player!~MediaSourceInfo:type"
3697
- },
3698
- {
3699
- "kind": "Content",
3700
- "text": "[]"
3701
- },
3702
- {
3703
- "kind": "Content",
3704
- "text": ";"
3705
- }
3706
- ],
3707
- "isStatic": false,
3708
- "returnTypeTokenRange": {
3709
- "startIndex": 1,
3710
- "endIndex": 3
3711
- },
3712
- "releaseTag": "Beta",
3713
- "isProtected": false,
3714
- "overloadIndex": 1,
3715
- "parameters": [],
3716
- "isOptional": false,
3717
- "isAbstract": false,
3718
- "name": "getCamerasList"
3719
- },
3720
- {
3721
- "kind": "Method",
3722
- "canonicalReference": "@gcorevideo/player!MultiCamera#getCurrentCamera:member(1)",
3723
- "docComment": "",
3724
- "excerptTokens": [
3725
- {
3726
- "kind": "Content",
3727
- "text": "getCurrentCamera(): "
3728
- },
3729
- {
3730
- "kind": "Reference",
3731
- "text": "MediaSourceInfo",
3732
- "canonicalReference": "@gcorevideo/player!~MediaSourceInfo:type"
3733
- },
3734
- {
3735
- "kind": "Content",
3736
- "text": " | null"
3737
- },
3738
- {
3739
- "kind": "Content",
3740
- "text": ";"
3741
- }
3742
- ],
3743
- "isStatic": false,
3744
- "returnTypeTokenRange": {
3745
- "startIndex": 1,
3746
- "endIndex": 3
3747
- },
3748
- "releaseTag": "Beta",
3749
- "isProtected": false,
3750
- "overloadIndex": 1,
3751
- "parameters": [],
3752
- "isOptional": false,
3753
- "isAbstract": false,
3754
- "name": "getCurrentCamera"
3755
- },
3756
3571
  {
3757
3572
  "kind": "Property",
3758
3573
  "canonicalReference": "@gcorevideo/player!MultiCamera#name:member",
@@ -4152,6 +3967,33 @@
4152
3967
  "startIndex": 1,
4153
3968
  "endIndex": 2
4154
3969
  }
3970
+ },
3971
+ {
3972
+ "kind": "PropertySignature",
3973
+ "canonicalReference": "@gcorevideo/player!PlaybackError#UI:member",
3974
+ "docComment": "/**\n * UI description of the error.\n */\n",
3975
+ "excerptTokens": [
3976
+ {
3977
+ "kind": "Content",
3978
+ "text": "UI?: "
3979
+ },
3980
+ {
3981
+ "kind": "Content",
3982
+ "text": "{\n title: string;\n message: string;\n }"
3983
+ },
3984
+ {
3985
+ "kind": "Content",
3986
+ "text": ";"
3987
+ }
3988
+ ],
3989
+ "isReadonly": false,
3990
+ "isOptional": true,
3991
+ "releaseTag": "Beta",
3992
+ "name": "UI",
3993
+ "propertyTypeTokenRange": {
3994
+ "startIndex": 1,
3995
+ "endIndex": 2
3996
+ }
4155
3997
  }
4156
3998
  ],
4157
3999
  "extendsTokenRanges": []
@@ -4182,7 +4024,7 @@
4182
4024
  },
4183
4025
  {
4184
4026
  "kind": "Content",
4185
- "text": "0"
4027
+ "text": "\"GENERIC_ERROR\""
4186
4028
  }
4187
4029
  ],
4188
4030
  "initializerTokenRange": {
@@ -4203,7 +4045,7 @@
4203
4045
  },
4204
4046
  {
4205
4047
  "kind": "Content",
4206
- "text": "3"
4048
+ "text": "\"MEDIA_SOURCE_ACCESS_DENIED\""
4207
4049
  }
4208
4050
  ],
4209
4051
  "initializerTokenRange": {
@@ -4224,7 +4066,7 @@
4224
4066
  },
4225
4067
  {
4226
4068
  "kind": "Content",
4227
- "text": "1"
4069
+ "text": "\"MEDIA_SOURCE_UNAVAILABLE\""
4228
4070
  }
4229
4071
  ],
4230
4072
  "initializerTokenRange": {
@@ -4265,7 +4107,7 @@
4265
4107
  {
4266
4108
  "kind": "Class",
4267
4109
  "canonicalReference": "@gcorevideo/player!PlaybackRate:class",
4268
- "docComment": "/**\n * Allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the available playback rates.\n *\n * @beta\n */\n",
4110
+ "docComment": "/**\n * PLUGIN that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.\n *\n * @beta\n */\n",
4269
4111
  "excerptTokens": [
4270
4112
  {
4271
4113
  "kind": "Content",
@@ -4286,7 +4128,41 @@
4286
4128
  "isAbstract": false,
4287
4129
  "name": "PlaybackRate",
4288
4130
  "preserveMemberOrder": false,
4289
- "members": [],
4131
+ "members": [
4132
+ {
4133
+ "kind": "Constructor",
4134
+ "canonicalReference": "@gcorevideo/player!PlaybackRate:constructor(1)",
4135
+ "docComment": "/**\n * Constructs a new instance of the `PlaybackRate` class\n */\n",
4136
+ "excerptTokens": [
4137
+ {
4138
+ "kind": "Content",
4139
+ "text": "constructor(core: "
4140
+ },
4141
+ {
4142
+ "kind": "Reference",
4143
+ "text": "Core",
4144
+ "canonicalReference": "@clappr/core!default:class"
4145
+ },
4146
+ {
4147
+ "kind": "Content",
4148
+ "text": ");"
4149
+ }
4150
+ ],
4151
+ "releaseTag": "Beta",
4152
+ "isProtected": false,
4153
+ "overloadIndex": 1,
4154
+ "parameters": [
4155
+ {
4156
+ "parameterName": "core",
4157
+ "parameterTypeTokenRange": {
4158
+ "startIndex": 1,
4159
+ "endIndex": 2
4160
+ },
4161
+ "isOptional": false
4162
+ }
4163
+ ]
4164
+ }
4165
+ ],
4290
4166
  "extendsTokenRange": {
4291
4167
  "startIndex": 1,
4292
4168
  "endIndex": 2
@@ -5013,8 +4889,8 @@
5013
4889
  },
5014
4890
  {
5015
4891
  "kind": "Reference",
5016
- "text": "PlayerPlugin",
5017
- "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
4892
+ "text": "PlayerPluginConstructor",
4893
+ "canonicalReference": "@gcorevideo/player!PlayerPluginConstructor:type"
5018
4894
  },
5019
4895
  {
5020
4896
  "kind": "Content",
@@ -5269,8 +5145,8 @@
5269
5145
  },
5270
5146
  {
5271
5147
  "kind": "Reference",
5272
- "text": "PlayerPlugin",
5273
- "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
5148
+ "text": "PlayerPluginConstructor",
5149
+ "canonicalReference": "@gcorevideo/player!PlayerPluginConstructor:type"
5274
5150
  },
5275
5151
  {
5276
5152
  "kind": "Content",
@@ -6263,6 +6139,42 @@
6263
6139
  "endIndex": 2
6264
6140
  }
6265
6141
  },
6142
+ {
6143
+ "kind": "TypeAlias",
6144
+ "canonicalReference": "@gcorevideo/player!PlayerPluginConstructor:type",
6145
+ "docComment": "/**\n * @beta\n */\n",
6146
+ "excerptTokens": [
6147
+ {
6148
+ "kind": "Content",
6149
+ "text": "export type PlayerPluginConstructor = "
6150
+ },
6151
+ {
6152
+ "kind": "Reference",
6153
+ "text": "CorePluginConstructor",
6154
+ "canonicalReference": "@gcorevideo/player!CorePluginConstructor:type"
6155
+ },
6156
+ {
6157
+ "kind": "Content",
6158
+ "text": " | "
6159
+ },
6160
+ {
6161
+ "kind": "Reference",
6162
+ "text": "ContainerPluginConstructor",
6163
+ "canonicalReference": "@gcorevideo/player!ContainerPluginConstructor:type"
6164
+ },
6165
+ {
6166
+ "kind": "Content",
6167
+ "text": ";"
6168
+ }
6169
+ ],
6170
+ "fileUrlPath": "src/types.ts",
6171
+ "releaseTag": "Beta",
6172
+ "name": "PlayerPluginConstructor",
6173
+ "typeTokenRange": {
6174
+ "startIndex": 1,
6175
+ "endIndex": 4
6176
+ }
6177
+ },
6266
6178
  {
6267
6179
  "kind": "Class",
6268
6180
  "canonicalReference": "@gcorevideo/player!Poster:class",
@@ -6913,7 +6825,7 @@
6913
6825
  {
6914
6826
  "kind": "Class",
6915
6827
  "canonicalReference": "@gcorevideo/player!Share:class",
6916
- "docComment": "/**\n * The plugin adds a share button to the media control UI.\n */\n",
6828
+ "docComment": "/**\n * PLUGIN that adds a share button to the media control UI.\n *\n * @beta\n */\n",
6917
6829
  "excerptTokens": [
6918
6830
  {
6919
6831
  "kind": "Content",
@@ -6930,7 +6842,7 @@
6930
6842
  }
6931
6843
  ],
6932
6844
  "fileUrlPath": "src/plugins/share/Share.ts",
6933
- "releaseTag": "Public",
6845
+ "releaseTag": "Beta",
6934
6846
  "isAbstract": false,
6935
6847
  "name": "Share",
6936
6848
  "preserveMemberOrder": false,
@@ -6955,7 +6867,7 @@
6955
6867
  ],
6956
6868
  "isReadonly": true,
6957
6869
  "isOptional": false,
6958
- "releaseTag": "Public",
6870
+ "releaseTag": "Beta",
6959
6871
  "name": "attributes",
6960
6872
  "propertyTypeTokenRange": {
6961
6873
  "startIndex": 1,
@@ -6988,7 +6900,7 @@
6988
6900
  "startIndex": 1,
6989
6901
  "endIndex": 2
6990
6902
  },
6991
- "releaseTag": "Public",
6903
+ "releaseTag": "Beta",
6992
6904
  "isProtected": false,
6993
6905
  "overloadIndex": 1,
6994
6906
  "parameters": [],
@@ -7019,7 +6931,7 @@
7019
6931
  "startIndex": 1,
7020
6932
  "endIndex": 2
7021
6933
  },
7022
- "releaseTag": "Public",
6934
+ "releaseTag": "Beta",
7023
6935
  "isProtected": false,
7024
6936
  "overloadIndex": 1,
7025
6937
  "parameters": [],
@@ -7047,7 +6959,7 @@
7047
6959
  ],
7048
6960
  "isReadonly": true,
7049
6961
  "isOptional": false,
7050
- "releaseTag": "Public",
6962
+ "releaseTag": "Beta",
7051
6963
  "name": "events",
7052
6964
  "propertyTypeTokenRange": {
7053
6965
  "startIndex": 1,
@@ -7080,7 +6992,7 @@
7080
6992
  "startIndex": 1,
7081
6993
  "endIndex": 2
7082
6994
  },
7083
- "releaseTag": "Public",
6995
+ "releaseTag": "Beta",
7084
6996
  "isProtected": false,
7085
6997
  "overloadIndex": 1,
7086
6998
  "parameters": [],
@@ -7111,7 +7023,7 @@
7111
7023
  "startIndex": 1,
7112
7024
  "endIndex": 2
7113
7025
  },
7114
- "releaseTag": "Public",
7026
+ "releaseTag": "Beta",
7115
7027
  "isProtected": false,
7116
7028
  "overloadIndex": 1,
7117
7029
  "parameters": [],
@@ -7139,7 +7051,7 @@
7139
7051
  ],
7140
7052
  "isReadonly": true,
7141
7053
  "isOptional": false,
7142
- "releaseTag": "Public",
7054
+ "releaseTag": "Beta",
7143
7055
  "name": "name",
7144
7056
  "propertyTypeTokenRange": {
7145
7057
  "startIndex": 1,
@@ -7172,7 +7084,7 @@
7172
7084
  "startIndex": 1,
7173
7085
  "endIndex": 2
7174
7086
  },
7175
- "releaseTag": "Public",
7087
+ "releaseTag": "Beta",
7176
7088
  "isProtected": false,
7177
7089
  "overloadIndex": 1,
7178
7090
  "parameters": [],
@@ -7203,7 +7115,7 @@
7203
7115
  "startIndex": 1,
7204
7116
  "endIndex": 2
7205
7117
  },
7206
- "releaseTag": "Public",
7118
+ "releaseTag": "Beta",
7207
7119
  "isProtected": false,
7208
7120
  "overloadIndex": 1,
7209
7121
  "parameters": [],
@@ -7234,7 +7146,7 @@
7234
7146
  "startIndex": 1,
7235
7147
  "endIndex": 2
7236
7148
  },
7237
- "releaseTag": "Public",
7149
+ "releaseTag": "Beta",
7238
7150
  "isProtected": false,
7239
7151
  "overloadIndex": 1,
7240
7152
  "parameters": [],
@@ -7265,7 +7177,7 @@
7265
7177
  "startIndex": 1,
7266
7178
  "endIndex": 2
7267
7179
  },
7268
- "releaseTag": "Public",
7180
+ "releaseTag": "Beta",
7269
7181
  "isProtected": false,
7270
7182
  "overloadIndex": 1,
7271
7183
  "parameters": [],
@@ -7296,7 +7208,7 @@
7296
7208
  "startIndex": 1,
7297
7209
  "endIndex": 2
7298
7210
  },
7299
- "releaseTag": "Public",
7211
+ "releaseTag": "Beta",
7300
7212
  "isProtected": false,
7301
7213
  "overloadIndex": 1,
7302
7214
  "parameters": [],
@@ -7327,7 +7239,7 @@
7327
7239
  "startIndex": 1,
7328
7240
  "endIndex": 2
7329
7241
  },
7330
- "releaseTag": "Public",
7242
+ "releaseTag": "Beta",
7331
7243
  "isProtected": false,
7332
7244
  "overloadIndex": 1,
7333
7245
  "parameters": [],
@@ -7358,7 +7270,7 @@
7358
7270
  "startIndex": 1,
7359
7271
  "endIndex": 2
7360
7272
  },
7361
- "releaseTag": "Public",
7273
+ "releaseTag": "Beta",
7362
7274
  "isProtected": false,
7363
7275
  "overloadIndex": 1,
7364
7276
  "parameters": [],
@@ -7389,7 +7301,7 @@
7389
7301
  "startIndex": 1,
7390
7302
  "endIndex": 2
7391
7303
  },
7392
- "releaseTag": "Public",
7304
+ "releaseTag": "Beta",
7393
7305
  "isProtected": false,
7394
7306
  "overloadIndex": 1,
7395
7307
  "parameters": [],
@@ -7417,7 +7329,7 @@
7417
7329
  ],
7418
7330
  "isReadonly": true,
7419
7331
  "isOptional": false,
7420
- "releaseTag": "Public",
7332
+ "releaseTag": "Beta",
7421
7333
  "name": "supportedVersion",
7422
7334
  "propertyTypeTokenRange": {
7423
7335
  "startIndex": 1,
@@ -7447,7 +7359,7 @@
7447
7359
  ],
7448
7360
  "isReadonly": true,
7449
7361
  "isOptional": false,
7450
- "releaseTag": "Public",
7362
+ "releaseTag": "Beta",
7451
7363
  "name": "template",
7452
7364
  "propertyTypeTokenRange": {
7453
7365
  "startIndex": 1,
@@ -7480,7 +7392,7 @@
7480
7392
  "startIndex": 1,
7481
7393
  "endIndex": 2
7482
7394
  },
7483
- "releaseTag": "Public",
7395
+ "releaseTag": "Beta",
7484
7396
  "isProtected": false,
7485
7397
  "overloadIndex": 1,
7486
7398
  "parameters": [],
@@ -7498,7 +7410,7 @@
7498
7410
  {
7499
7411
  "kind": "Class",
7500
7412
  "canonicalReference": "@gcorevideo/player!SkipTime:class",
7501
- "docComment": "/**\n * The plugin adds skip controls to the media control UI.\n */\n",
7413
+ "docComment": "/**\n * PLUGIN that adds skip controls to the media control UI.\n *\n * @beta\n */\n",
7502
7414
  "excerptTokens": [
7503
7415
  {
7504
7416
  "kind": "Content",
@@ -7515,7 +7427,7 @@
7515
7427
  }
7516
7428
  ],
7517
7429
  "fileUrlPath": "src/plugins/skip-time/SkipTime.ts",
7518
- "releaseTag": "Public",
7430
+ "releaseTag": "Beta",
7519
7431
  "isAbstract": false,
7520
7432
  "name": "SkipTime",
7521
7433
  "preserveMemberOrder": false,
@@ -7540,7 +7452,7 @@
7540
7452
  ],
7541
7453
  "isReadonly": true,
7542
7454
  "isOptional": false,
7543
- "releaseTag": "Public",
7455
+ "releaseTag": "Beta",
7544
7456
  "name": "attributes",
7545
7457
  "propertyTypeTokenRange": {
7546
7458
  "startIndex": 1,
@@ -7573,7 +7485,7 @@
7573
7485
  "startIndex": 1,
7574
7486
  "endIndex": 2
7575
7487
  },
7576
- "releaseTag": "Public",
7488
+ "releaseTag": "Beta",
7577
7489
  "isProtected": false,
7578
7490
  "overloadIndex": 1,
7579
7491
  "parameters": [],
@@ -7601,7 +7513,7 @@
7601
7513
  ],
7602
7514
  "isReadonly": true,
7603
7515
  "isOptional": false,
7604
- "releaseTag": "Public",
7516
+ "releaseTag": "Beta",
7605
7517
  "name": "container",
7606
7518
  "propertyTypeTokenRange": {
7607
7519
  "startIndex": 1,
@@ -7631,7 +7543,7 @@
7631
7543
  ],
7632
7544
  "isReadonly": true,
7633
7545
  "isOptional": false,
7634
- "releaseTag": "Public",
7546
+ "releaseTag": "Beta",
7635
7547
  "name": "events",
7636
7548
  "propertyTypeTokenRange": {
7637
7549
  "startIndex": 1,
@@ -7664,7 +7576,7 @@
7664
7576
  "startIndex": 1,
7665
7577
  "endIndex": 2
7666
7578
  },
7667
- "releaseTag": "Public",
7579
+ "releaseTag": "Beta",
7668
7580
  "isProtected": false,
7669
7581
  "overloadIndex": 1,
7670
7582
  "parameters": [],
@@ -7692,7 +7604,7 @@
7692
7604
  ],
7693
7605
  "isReadonly": true,
7694
7606
  "isOptional": false,
7695
- "releaseTag": "Public",
7607
+ "releaseTag": "Beta",
7696
7608
  "name": "name",
7697
7609
  "propertyTypeTokenRange": {
7698
7610
  "startIndex": 1,
@@ -7725,7 +7637,7 @@
7725
7637
  "startIndex": 1,
7726
7638
  "endIndex": 2
7727
7639
  },
7728
- "releaseTag": "Public",
7640
+ "releaseTag": "Beta",
7729
7641
  "isProtected": false,
7730
7642
  "overloadIndex": 1,
7731
7643
  "parameters": [],
@@ -7756,7 +7668,7 @@
7756
7668
  "startIndex": 1,
7757
7669
  "endIndex": 2
7758
7670
  },
7759
- "releaseTag": "Public",
7671
+ "releaseTag": "Beta",
7760
7672
  "isProtected": false,
7761
7673
  "overloadIndex": 1,
7762
7674
  "parameters": [],
@@ -7787,7 +7699,7 @@
7787
7699
  "startIndex": 1,
7788
7700
  "endIndex": 2
7789
7701
  },
7790
- "releaseTag": "Public",
7702
+ "releaseTag": "Beta",
7791
7703
  "isProtected": false,
7792
7704
  "overloadIndex": 1,
7793
7705
  "parameters": [],
@@ -7818,7 +7730,7 @@
7818
7730
  "startIndex": 1,
7819
7731
  "endIndex": 2
7820
7732
  },
7821
- "releaseTag": "Public",
7733
+ "releaseTag": "Beta",
7822
7734
  "isProtected": false,
7823
7735
  "overloadIndex": 1,
7824
7736
  "parameters": [],
@@ -7846,7 +7758,7 @@
7846
7758
  ],
7847
7759
  "isReadonly": true,
7848
7760
  "isOptional": false,
7849
- "releaseTag": "Public",
7761
+ "releaseTag": "Beta",
7850
7762
  "name": "supportedVersion",
7851
7763
  "propertyTypeTokenRange": {
7852
7764
  "startIndex": 1,
@@ -7876,7 +7788,7 @@
7876
7788
  ],
7877
7789
  "isReadonly": true,
7878
7790
  "isOptional": false,
7879
- "releaseTag": "Public",
7791
+ "releaseTag": "Beta",
7880
7792
  "name": "template",
7881
7793
  "propertyTypeTokenRange": {
7882
7794
  "startIndex": 1,
@@ -7909,7 +7821,7 @@
7909
7821
  "startIndex": 1,
7910
7822
  "endIndex": 2
7911
7823
  },
7912
- "releaseTag": "Public",
7824
+ "releaseTag": "Beta",
7913
7825
  "isProtected": false,
7914
7826
  "overloadIndex": 1,
7915
7827
  "parameters": [],
@@ -7992,7 +7904,7 @@
7992
7904
  {
7993
7905
  "kind": "Enum",
7994
7906
  "canonicalReference": "@gcorevideo/player!SpinnerEvents:enum",
7995
- "docComment": "/**\n * Custom events emitted by the plugin\n */\n",
7907
+ "docComment": "/**\n * Custom events emitted by the plugin\n *\n * @beta\n */\n",
7996
7908
  "excerptTokens": [
7997
7909
  {
7998
7910
  "kind": "Content",
@@ -8000,7 +7912,7 @@
8000
7912
  }
8001
7913
  ],
8002
7914
  "fileUrlPath": "src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts",
8003
- "releaseTag": "Public",
7915
+ "releaseTag": "Beta",
8004
7916
  "name": "SpinnerEvents",
8005
7917
  "preserveMemberOrder": false,
8006
7918
  "members": [
@@ -8022,7 +7934,7 @@
8022
7934
  "startIndex": 1,
8023
7935
  "endIndex": 2
8024
7936
  },
8025
- "releaseTag": "Public",
7937
+ "releaseTag": "Beta",
8026
7938
  "name": "SYNC"
8027
7939
  }
8028
7940
  ]
@@ -8030,7 +7942,7 @@
8030
7942
  {
8031
7943
  "kind": "Class",
8032
7944
  "canonicalReference": "@gcorevideo/player!SpinnerThreeBounce:class",
8033
- "docComment": "/**\n * Shows a pending operation indicator when playback is buffering or in other appropriate cases\n *\n * @remarks\n *\n * The plugin emits\n *\n * @beta\n */\n",
7945
+ "docComment": "/**\n * PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state\n *\n * @remarks\n *\n * Events emitted- {@link SpinnerEvents} Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to implement custom pending/progress indication scenarios.\n *\n * @beta\n */\n",
8034
7946
  "excerptTokens": [
8035
7947
  {
8036
7948
  "kind": "Content",
@@ -8088,7 +8000,7 @@
8088
8000
  {
8089
8001
  "kind": "Method",
8090
8002
  "canonicalReference": "@gcorevideo/player!SpinnerThreeBounce#hide:member(1)",
8091
- "docComment": "/**\n * Hides the spinner\n */\n",
8003
+ "docComment": "/**\n * Hides the spinner.\n */\n",
8092
8004
  "excerptTokens": [
8093
8005
  {
8094
8006
  "kind": "Content",
@@ -8119,11 +8031,19 @@
8119
8031
  {
8120
8032
  "kind": "Method",
8121
8033
  "canonicalReference": "@gcorevideo/player!SpinnerThreeBounce#show:member(1)",
8122
- "docComment": "/**\n * Shows the spinner\n */\n",
8034
+ "docComment": "/**\n * Shows the spinner.\n *\n * When called, the spinner will not hide (due to its built-in logic) until {@link SpinnerThreeBounce.hide} is called\n */\n",
8123
8035
  "excerptTokens": [
8124
8036
  {
8125
8037
  "kind": "Content",
8126
- "text": "show(): "
8038
+ "text": "show(delay?: "
8039
+ },
8040
+ {
8041
+ "kind": "Content",
8042
+ "text": "number"
8043
+ },
8044
+ {
8045
+ "kind": "Content",
8046
+ "text": "): "
8127
8047
  },
8128
8048
  {
8129
8049
  "kind": "Content",
@@ -8136,13 +8056,22 @@
8136
8056
  ],
8137
8057
  "isStatic": false,
8138
8058
  "returnTypeTokenRange": {
8139
- "startIndex": 1,
8140
- "endIndex": 2
8059
+ "startIndex": 3,
8060
+ "endIndex": 4
8141
8061
  },
8142
8062
  "releaseTag": "Beta",
8143
8063
  "isProtected": false,
8144
8064
  "overloadIndex": 1,
8145
- "parameters": [],
8065
+ "parameters": [
8066
+ {
8067
+ "parameterName": "delay",
8068
+ "parameterTypeTokenRange": {
8069
+ "startIndex": 1,
8070
+ "endIndex": 2
8071
+ },
8072
+ "isOptional": true
8073
+ }
8074
+ ],
8146
8075
  "isOptional": false,
8147
8076
  "isAbstract": false,
8148
8077
  "name": "show"
@@ -8424,7 +8353,7 @@
8424
8353
  {
8425
8354
  "kind": "Class",
8426
8355
  "canonicalReference": "@gcorevideo/player!Telemetry:class",
8427
- "docComment": "/**\n * Collects and reports the performance statistics.\n *\n * @remarks\n *\n * This plugin is experimental and its API is likely to change.\n *\n * Configuration options {@link TelemetryPluginSettings}\n *\n * @example\n * ```ts\n * import { Statistics } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Statistics)\n *\n * const player = new Player({\n * statistics: {\n * send: (data) => {\n * fetch('/stats', {\n * method: 'POST',\n * body: JSON.stringify(data),\n * headers: { 'content-type': 'application/json' },\n * })\n * },\n * },\n * ...\n * })\n * ```\n *\n * @beta\n */\n",
8356
+ "docComment": "/**\n * PLUGIN that collects and reports the performance statistics.\n *\n * @remarks\n *\n * This plugin is experimental and its API is likely to change.\n *\n * Configuration options {@link TelemetryPluginSettings}\n *\n * @example\n * ```ts\n * import { Statistics } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Statistics)\n *\n * const player = new Player({\n * statistics: {\n * send: (data) => {\n * fetch('/stats', {\n * method: 'POST',\n * body: JSON.stringify(data),\n * headers: { 'content-type': 'application/json' },\n * })\n * },\n * },\n * ...\n * })\n * ```\n *\n * @beta\n */\n",
8428
8357
  "excerptTokens": [
8429
8358
  {
8430
8359
  "kind": "Content",
@@ -8728,7 +8657,7 @@
8728
8657
  {
8729
8658
  "kind": "Reference",
8730
8659
  "text": "TelemetrySendFn",
8731
- "canonicalReference": "@gcorevideo/player!~TelemetrySendFn:type"
8660
+ "canonicalReference": "@gcorevideo/player!TelemetrySendFn:type"
8732
8661
  },
8733
8662
  {
8734
8663
  "kind": "Content",
@@ -8787,6 +8716,41 @@
8787
8716
  "endIndex": 5
8788
8717
  }
8789
8718
  },
8719
+ {
8720
+ "kind": "TypeAlias",
8721
+ "canonicalReference": "@gcorevideo/player!TelemetrySendFn:type",
8722
+ "docComment": "/**\n * Callback to send the telemetry record to the storage.\n *\n * @param data - The telemetry record to send.\n *\n * @beta\n */\n",
8723
+ "excerptTokens": [
8724
+ {
8725
+ "kind": "Content",
8726
+ "text": "export type TelemetrySendFn = "
8727
+ },
8728
+ {
8729
+ "kind": "Content",
8730
+ "text": "(data: "
8731
+ },
8732
+ {
8733
+ "kind": "Reference",
8734
+ "text": "TelemetryRecord",
8735
+ "canonicalReference": "@gcorevideo/player!TelemetryRecord:type"
8736
+ },
8737
+ {
8738
+ "kind": "Content",
8739
+ "text": ") => void"
8740
+ },
8741
+ {
8742
+ "kind": "Content",
8743
+ "text": ";"
8744
+ }
8745
+ ],
8746
+ "fileUrlPath": "src/plugins/telemetry/Telemetry.ts",
8747
+ "releaseTag": "Beta",
8748
+ "name": "TelemetrySendFn",
8749
+ "typeTokenRange": {
8750
+ "startIndex": 1,
8751
+ "endIndex": 4
8752
+ }
8753
+ },
8790
8754
  {
8791
8755
  "kind": "Class",
8792
8756
  "canonicalReference": "@gcorevideo/player!Thumbnails:class",
@@ -9301,7 +9265,7 @@
9301
9265
  "text": ";"
9302
9266
  }
9303
9267
  ],
9304
- "fileUrlPath": "src/utils/types.ts",
9268
+ "fileUrlPath": "src/types.ts",
9305
9269
  "releaseTag": "Beta",
9306
9270
  "name": "ZeptoResult",
9307
9271
  "typeTokenRange": {