@gcorevideo/player 2.22.0 → 2.22.2
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.
- package/assets/bottom-gear/bottomgear copy.ejs +10 -0
- package/assets/bottom-gear/bottomgear.ejs +4 -8
- package/assets/bottom-gear/gear-sub-menu.scss +0 -1
- package/assets/bottom-gear/gear.scss +0 -1
- package/assets/clappr-nerd-stats/button.ejs +3 -3
- package/assets/level-selector/button.ejs +2 -4
- package/assets/level-selector/list.ejs +14 -10
- package/assets/level-selector/style.scss +9 -4
- package/assets/media-control/container.scss +1 -1
- package/assets/playback-rate/list.ejs +5 -5
- package/assets/spinner-three-bounce/spinner.scss +1 -1
- package/dist/core.js +1 -2
- package/dist/index.css +885 -884
- package/dist/index.js +3938 -3779
- package/dist/player.d.ts +246 -108
- package/dist/plugins/index.css +1230 -1229
- package/dist/plugins/index.js +4036 -3878
- package/docs/api/player.bottomgear.additem.md +95 -0
- package/docs/api/player.bottomgear.md +63 -19
- package/docs/api/player.bottomgear.refresh.md +5 -1
- package/docs/api/player.clapprnerdstats.md +0 -2
- package/docs/api/player.clicktopause.md +1 -1
- package/docs/api/player.closedcaptions.md +2 -2
- package/docs/api/player.closedcaptionspluginsettings.md +5 -0
- package/docs/api/player.errorscreen.md +18 -4
- package/docs/api/player.errorscreenpluginsettings.md +1 -4
- package/docs/api/player.errorscreensettings.md +15 -0
- package/docs/api/{player.mediacontrolevents.md → player.gearevents.md} +7 -7
- package/docs/api/player.levelselector.events.md +0 -1
- package/docs/api/player.levelselector.md +1 -1
- package/docs/api/player.md +33 -36
- package/docs/api/{player.bottomgear.setcontent.md → player.mediacontrol.handlecustomarea.md} +5 -9
- package/docs/api/player.mediacontrol.md +10 -24
- package/docs/api/player.mediacontrol.putelement.md +2 -2
- package/docs/api/{player.bottomgear.getelement.md → player.mediacontrol.toggleelement.md} +23 -9
- package/docs/api/player.mediacontrolelement.md +1 -1
- package/docs/api/player.playbackrate.md +22 -3
- package/docs/api/{player.gearoptionsitem.md → player.playbackrateoption.md} +6 -4
- package/docs/api/{player.mediacontrol.getcenterpanel.md → player.playbackratesettings.md} +8 -6
- package/docs/api/player.sourcecontroller._constructor_.md +49 -0
- package/docs/api/player.sourcecontroller.md +70 -7
- package/docs/api/player.spinnerevents.md +1 -4
- package/docs/api/player.spinnerthreebounce._constructor_.md +0 -3
- package/docs/api/player.spinnerthreebounce.hide.md +0 -3
- package/docs/api/player.spinnerthreebounce.md +5 -8
- package/docs/api/player.spinnerthreebounce.show.md +2 -5
- package/lib/internal.types.d.ts +5 -0
- package/lib/internal.types.d.ts.map +1 -1
- package/lib/playback/dash-playback/DashPlayback.d.ts.map +1 -1
- package/lib/playback/dash-playback/DashPlayback.js +0 -1
- package/lib/playback.types.d.ts +0 -5
- package/lib/playback.types.d.ts.map +1 -1
- package/lib/plugins/bottom-gear/BottomGear.d.ts +93 -20
- package/lib/plugins/bottom-gear/BottomGear.d.ts.map +1 -1
- package/lib/plugins/bottom-gear/BottomGear.js +145 -37
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts +2 -3
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts.map +1 -1
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js +18 -15
- package/lib/plugins/click-to-pause/ClickToPause.d.ts +1 -1
- package/lib/plugins/click-to-pause/ClickToPause.d.ts.map +1 -1
- package/lib/plugins/click-to-pause/ClickToPause.js +3 -2
- package/lib/plugins/dvr-controls/DvrControls.js +1 -1
- package/lib/plugins/error-screen/ErrorScreen.d.ts +29 -4
- package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
- package/lib/plugins/error-screen/ErrorScreen.js +17 -2
- package/lib/plugins/level-selector/LevelSelector.d.ts +8 -11
- package/lib/plugins/level-selector/LevelSelector.d.ts.map +1 -1
- package/lib/plugins/level-selector/LevelSelector.js +66 -102
- package/lib/plugins/media-control/MediaControl.d.ts +6 -15
- package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
- package/lib/plugins/media-control/MediaControl.js +36 -30
- package/lib/plugins/picture-in-picture/PictureInPicture.d.ts.map +1 -1
- package/lib/plugins/picture-in-picture/PictureInPicture.js +7 -2
- package/lib/plugins/playback-rate/PlaybackRate.d.ts +42 -14
- package/lib/plugins/playback-rate/PlaybackRate.d.ts.map +1 -1
- package/lib/plugins/playback-rate/PlaybackRate.js +101 -83
- package/lib/plugins/source-controller/SourceController.d.ts +40 -4
- package/lib/plugins/source-controller/SourceController.d.ts.map +1 -1
- package/lib/plugins/source-controller/SourceController.js +41 -4
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts +8 -6
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map +1 -1
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +10 -6
- package/lib/plugins/subtitles/ClosedCaptions.d.ts +7 -7
- package/lib/plugins/subtitles/ClosedCaptions.d.ts.map +1 -1
- package/lib/plugins/subtitles/ClosedCaptions.js +3 -3
- package/lib/testUtils.d.ts +1 -0
- package/lib/testUtils.d.ts.map +1 -1
- package/lib/testUtils.js +13 -0
- package/package.json +1 -1
- package/src/internal.types.ts +6 -0
- package/src/playback/dash-playback/DashPlayback.ts +0 -1
- package/src/playback.types.ts +0 -5
- package/src/plugins/bottom-gear/BottomGear.ts +186 -77
- package/src/plugins/bottom-gear/__tests__/BottomGear.test.ts +21 -5
- package/src/plugins/bottom-gear/__tests__/__snapshots__/BottomGear.test.ts.snap +5 -12
- package/src/plugins/clappr-nerd-stats/ClapprNerdStats.ts +27 -25
- package/src/plugins/click-to-pause/ClickToPause.ts +3 -2
- package/src/plugins/dvr-controls/DvrControls.ts +1 -1
- package/src/plugins/dvr-controls/__tests__/DvrControls.test.ts +1 -1
- package/src/plugins/error-screen/ErrorScreen.ts +30 -4
- package/src/plugins/level-selector/LevelSelector.ts +80 -120
- package/src/plugins/level-selector/__tests__/LevelSelector.test.ts +69 -79
- package/src/plugins/level-selector/__tests__/__snapshots__/LevelSelector.test.ts.snap +38 -71
- package/src/plugins/media-control/MediaControl.ts +50 -36
- package/src/plugins/media-control/__tests__/MediaControl.test.ts +4 -4
- package/src/plugins/picture-in-picture/PictureInPicture.ts +7 -2
- package/src/plugins/playback-rate/PlaybackRate.ts +136 -108
- package/src/plugins/playback-rate/__tests__/PlaybackRate.test.ts +84 -37
- package/src/plugins/playback-rate/__tests__/__snapshots__/PlaybackRate.test.ts.snap +55 -6
- package/src/plugins/source-controller/SourceController.ts +41 -4
- package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +10 -6
- package/src/plugins/subtitles/ClosedCaptions.ts +9 -10
- package/src/plugins/subtitles/__tests__/ClosedCaptions.test.ts +1 -1
- package/src/testUtils.ts +14 -0
- package/src/typings/vitest.d.ts +1 -0
- package/temp/player.api.json +303 -370
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.gearitemelement.md +0 -18
- package/docs/api/player.mediacontrol.getleftpanel.md +0 -22
- package/docs/api/player.mediacontrol.getrightpanel.md +0 -22
- package/docs/api/player.subtitlespluginsettings.md +0 -18
- package/docs/api/player.texttrackitem.id.md +0 -11
- package/docs/api/player.texttrackitem.md +0 -87
- package/docs/api/player.texttrackitem.name.md +0 -11
- package/docs/api/player.texttrackitem.track.md +0 -11
package/temp/player.api.json
CHANGED
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
{
|
|
238
238
|
"kind": "Class",
|
|
239
239
|
"canonicalReference": "@gcorevideo/player!BottomGear:class",
|
|
240
|
-
"docComment": "/**\n * `PLUGIN` that adds the
|
|
240
|
+
"docComment": "/**\n * `PLUGIN` that adds a button to extend the media controls UI with extra options.\n *\n * @remarks\n *\n * The plugin renders small gear icon to the right of the media controls. It provides a base for attaching custom settings UI in the gear menu\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * @example\n *\n * You can use bottom gear to add custom settings UI to the gear menu.\n * ```ts\n * import { BottomGear } from '@gcorevideo/player/plugins/bottom-gear';\n *\n * class CustomOptionsPlugin extends UICorePlugin {\n * // ...\n *\n * override get events() {\n * return {\n * 'click #my-button': 'doMyAction',\n * }\n * }\n *\n * private doMyAction() {\n * // ...\n * }\n *\n * override render() {\n * const bottomGear = this.core.getPlugin('bottom_gear');\n * if (!bottomGear) {\n * return this;\n * }\n * this.$el.html('<button class=\"custom-option\">Custom option</button>');\n * // Put rendered element into the gear menu\n * bottomGear.addItem('custom').html(this.$el)\n * return this;\n * }\n *\n * // alternatively, add an option with a submenu\n * override render() {\n * this.$el.html(template(templateHtml)({\n * // ...\n * })));\n * return this;\n * }\n *\n * private addGearOption() {\n * this.core.getPlugin('bottom_gear')\n * .addItem('custom', this.$el)\n * .html($('<button class=\"custom-option\">Custom option</button>'))\n * }\n *\n * override bindEvents() {\n * this.listenToOnce(this.core, ClapprEvents.CORE_READY, () => {\n * const bottomGear = this.core.getPlugin('bottom_gear');\n * assert(bottomGear, 'bottom_gear plugin is required');\n * // simple case\n * this.listenTo(bottomGear, GearEvents.RENDERED, this.render);\n * // or with a submenu\n * this.listenTo(bottomGear, GearEvents.RENDERED, this.addGearOption);\n * });\n * }\n * }\n * ```\n *\n * @beta\n */\n",
|
|
241
241
|
"excerptTokens": [
|
|
242
242
|
{
|
|
243
243
|
"kind": "Content",
|
|
@@ -261,21 +261,20 @@
|
|
|
261
261
|
"members": [
|
|
262
262
|
{
|
|
263
263
|
"kind": "Method",
|
|
264
|
-
"canonicalReference": "@gcorevideo/player!BottomGear#
|
|
265
|
-
"docComment": "/**\n * @param name -
|
|
264
|
+
"canonicalReference": "@gcorevideo/player!BottomGear#addItem:member(1)",
|
|
265
|
+
"docComment": "/**\n * Adds a custom option to the gear menu\n *\n * @remarks\n *\n * When called with $submenu param, a click on the added item will toggle the submenu visibility.\n *\n * When added without submenu, it's responsibility of the caller to handle the click event however needed.\n *\n * @param name - A unique name of the option\n *\n * @param $subMenu - The submenu to attach to the option\n *\n * @returns The added item placeholder to attach custom markup\n *\n * @example\n * ```ts\n * class MyPlugin extends UICorePlugin {\n * override render() {\n * this.$el.html('<div class=\"my-awesome-settings\">...</div>')\n * this.core.getPlugin('bottom_gear')\n * ?.addItem('custom', this.$el)\n * .html($('<button>Custom settings</button>'))\n * return this\n * }\n * }\n * ```\n *\n */\n",
|
|
266
266
|
"excerptTokens": [
|
|
267
267
|
{
|
|
268
268
|
"kind": "Content",
|
|
269
|
-
"text": "
|
|
269
|
+
"text": "addItem(name: "
|
|
270
270
|
},
|
|
271
271
|
{
|
|
272
|
-
"kind": "
|
|
273
|
-
"text": "
|
|
274
|
-
"canonicalReference": "@gcorevideo/player!GearOptionsItem:type"
|
|
272
|
+
"kind": "Content",
|
|
273
|
+
"text": "string"
|
|
275
274
|
},
|
|
276
275
|
{
|
|
277
276
|
"kind": "Content",
|
|
278
|
-
"text": "
|
|
277
|
+
"text": ", $subMenu?: "
|
|
279
278
|
},
|
|
280
279
|
{
|
|
281
280
|
"kind": "Reference",
|
|
@@ -284,7 +283,12 @@
|
|
|
284
283
|
},
|
|
285
284
|
{
|
|
286
285
|
"kind": "Content",
|
|
287
|
-
"text": "
|
|
286
|
+
"text": "): "
|
|
287
|
+
},
|
|
288
|
+
{
|
|
289
|
+
"kind": "Reference",
|
|
290
|
+
"text": "ZeptoResult",
|
|
291
|
+
"canonicalReference": "@gcorevideo/player!ZeptoResult:type"
|
|
288
292
|
},
|
|
289
293
|
{
|
|
290
294
|
"kind": "Content",
|
|
@@ -293,8 +297,8 @@
|
|
|
293
297
|
],
|
|
294
298
|
"isStatic": false,
|
|
295
299
|
"returnTypeTokenRange": {
|
|
296
|
-
"startIndex":
|
|
297
|
-
"endIndex":
|
|
300
|
+
"startIndex": 5,
|
|
301
|
+
"endIndex": 6
|
|
298
302
|
},
|
|
299
303
|
"releaseTag": "Beta",
|
|
300
304
|
"isProtected": false,
|
|
@@ -307,16 +311,24 @@
|
|
|
307
311
|
"endIndex": 2
|
|
308
312
|
},
|
|
309
313
|
"isOptional": false
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"parameterName": "$subMenu",
|
|
317
|
+
"parameterTypeTokenRange": {
|
|
318
|
+
"startIndex": 3,
|
|
319
|
+
"endIndex": 4
|
|
320
|
+
},
|
|
321
|
+
"isOptional": true
|
|
310
322
|
}
|
|
311
323
|
],
|
|
312
324
|
"isOptional": false,
|
|
313
325
|
"isAbstract": false,
|
|
314
|
-
"name": "
|
|
326
|
+
"name": "addItem"
|
|
315
327
|
},
|
|
316
328
|
{
|
|
317
329
|
"kind": "Method",
|
|
318
330
|
"canonicalReference": "@gcorevideo/player!BottomGear#refresh:member(1)",
|
|
319
|
-
"docComment": "/**\n *
|
|
331
|
+
"docComment": "/**\n * Collapses any submenu open back to the gear menu.\n *\n * @remarks\n *\n * Should be called by the UI plugin that added a gear item with a submenu when the latter is closed (e.g., when a \"back\" button is clicked).\n */\n",
|
|
320
332
|
"excerptTokens": [
|
|
321
333
|
{
|
|
322
334
|
"kind": "Content",
|
|
@@ -343,55 +355,6 @@
|
|
|
343
355
|
"isOptional": false,
|
|
344
356
|
"isAbstract": false,
|
|
345
357
|
"name": "refresh"
|
|
346
|
-
},
|
|
347
|
-
{
|
|
348
|
-
"kind": "Method",
|
|
349
|
-
"canonicalReference": "@gcorevideo/player!BottomGear#setContent:member(1)",
|
|
350
|
-
"docComment": "/**\n * Replaces the content of the gear menu\n *\n * @param content - Zepto result of the element\n */\n",
|
|
351
|
-
"excerptTokens": [
|
|
352
|
-
{
|
|
353
|
-
"kind": "Content",
|
|
354
|
-
"text": "setContent(content: "
|
|
355
|
-
},
|
|
356
|
-
{
|
|
357
|
-
"kind": "Reference",
|
|
358
|
-
"text": "ZeptoResult",
|
|
359
|
-
"canonicalReference": "@gcorevideo/player!ZeptoResult:type"
|
|
360
|
-
},
|
|
361
|
-
{
|
|
362
|
-
"kind": "Content",
|
|
363
|
-
"text": "): "
|
|
364
|
-
},
|
|
365
|
-
{
|
|
366
|
-
"kind": "Content",
|
|
367
|
-
"text": "void"
|
|
368
|
-
},
|
|
369
|
-
{
|
|
370
|
-
"kind": "Content",
|
|
371
|
-
"text": ";"
|
|
372
|
-
}
|
|
373
|
-
],
|
|
374
|
-
"isStatic": false,
|
|
375
|
-
"returnTypeTokenRange": {
|
|
376
|
-
"startIndex": 3,
|
|
377
|
-
"endIndex": 4
|
|
378
|
-
},
|
|
379
|
-
"releaseTag": "Beta",
|
|
380
|
-
"isProtected": false,
|
|
381
|
-
"overloadIndex": 1,
|
|
382
|
-
"parameters": [
|
|
383
|
-
{
|
|
384
|
-
"parameterName": "content",
|
|
385
|
-
"parameterTypeTokenRange": {
|
|
386
|
-
"startIndex": 1,
|
|
387
|
-
"endIndex": 2
|
|
388
|
-
},
|
|
389
|
-
"isOptional": false
|
|
390
|
-
}
|
|
391
|
-
],
|
|
392
|
-
"isOptional": false,
|
|
393
|
-
"isAbstract": false,
|
|
394
|
-
"name": "setContent"
|
|
395
358
|
}
|
|
396
359
|
],
|
|
397
360
|
"extendsTokenRange": {
|
|
@@ -403,7 +366,7 @@
|
|
|
403
366
|
{
|
|
404
367
|
"kind": "Class",
|
|
405
368
|
"canonicalReference": "@gcorevideo/player!ClapprNerdStats:class",
|
|
406
|
-
"docComment": "/**\n * `PLUGIN` that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link
|
|
369
|
+
"docComment": "/**\n * `PLUGIN` that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\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",
|
|
407
370
|
"excerptTokens": [
|
|
408
371
|
{
|
|
409
372
|
"kind": "Content",
|
|
@@ -614,7 +577,7 @@
|
|
|
614
577
|
{
|
|
615
578
|
"kind": "Class",
|
|
616
579
|
"canonicalReference": "@gcorevideo/player!ClickToPause:class",
|
|
617
|
-
"docComment": "/**\n * `PLUGIN` that
|
|
580
|
+
"docComment": "/**\n * A small `PLUGIN` that toggles the playback state on click over the video container\n *\n * @beta\n */\n",
|
|
618
581
|
"excerptTokens": [
|
|
619
582
|
{
|
|
620
583
|
"kind": "Content",
|
|
@@ -770,7 +733,7 @@
|
|
|
770
733
|
{
|
|
771
734
|
"kind": "Class",
|
|
772
735
|
"canonicalReference": "@gcorevideo/player!ClosedCaptions:class",
|
|
773
|
-
"docComment": "/**\n * `PLUGIN` that provides a UI to select the subtitles when available.\n *\n * @remarks\n *\n * The plugin is activated when closed captions tracks are
|
|
736
|
+
"docComment": "/**\n * `PLUGIN` that provides a UI to select the subtitles when available.\n *\n * @remarks\n *\n * The plugin is activated when closed captions tracks are detected in the media source. It shows a familiar \"CC\" button with a dropdown menu to select the subtitles language.\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClosedCaptionsPluginSettings}\n *\n * @example\n * ```ts\n * import { ClosedCaptions } from '@gcorevideo/player'\n *\n * Player.registerPlugin(ClosedCaptions)\n *\n * new Player({\n * ...\n * cc: {\n * language: 'pt-BR',\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
774
737
|
"excerptTokens": [
|
|
775
738
|
{
|
|
776
739
|
"kind": "Content",
|
|
@@ -864,7 +827,7 @@
|
|
|
864
827
|
{
|
|
865
828
|
"kind": "TypeAlias",
|
|
866
829
|
"canonicalReference": "@gcorevideo/player!ClosedCaptionsPluginSettings:type",
|
|
867
|
-
"docComment": "",
|
|
830
|
+
"docComment": "/**\n * Configuration options for the {@link ClosedCaptions} plugin.\n *\n * @beta\n */\n",
|
|
868
831
|
"excerptTokens": [
|
|
869
832
|
{
|
|
870
833
|
"kind": "Content",
|
|
@@ -880,7 +843,7 @@
|
|
|
880
843
|
}
|
|
881
844
|
],
|
|
882
845
|
"fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
|
|
883
|
-
"releaseTag": "
|
|
846
|
+
"releaseTag": "Beta",
|
|
884
847
|
"name": "ClosedCaptionsPluginSettings",
|
|
885
848
|
"typeTokenRange": {
|
|
886
849
|
"startIndex": 1,
|
|
@@ -1256,7 +1219,7 @@
|
|
|
1256
1219
|
{
|
|
1257
1220
|
"kind": "Class",
|
|
1258
1221
|
"canonicalReference": "@gcorevideo/player!ErrorScreen:class",
|
|
1259
|
-
"docComment": "/**\n * `PLUGIN` that displays errors nicely in the overlay on top of the player.\n *\n * @
|
|
1222
|
+
"docComment": "/**\n * `PLUGIN` that displays fatal errors nicely in the overlay on top of the player.\n *\n * @remarks\n *\n * A fatal error is an error that prevents the player from playing the content. It's usually a network error that persists after multiple retries.\n *\n * The error screen should not be confused with the content stub that is shown when no media sources are available. This can happen due to the lack of the support of the given sources type or because the sources are misconfigured (e.g., omitted).\n *\n * Configuration options - {@link ErrorScreenPluginSettings}\n *\n * @example\n * ```ts\n * import { ErrorScreen, Player } from '@gcorevideo/player'\n *\n * Player.registerPlugin(ErrorScreen)\n * ```\n *\n * @public\n */\n",
|
|
1260
1223
|
"excerptTokens": [
|
|
1261
1224
|
{
|
|
1262
1225
|
"kind": "Content",
|
|
@@ -1273,7 +1236,7 @@
|
|
|
1273
1236
|
}
|
|
1274
1237
|
],
|
|
1275
1238
|
"fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
|
|
1276
|
-
"releaseTag": "
|
|
1239
|
+
"releaseTag": "Public",
|
|
1277
1240
|
"isAbstract": false,
|
|
1278
1241
|
"name": "ErrorScreen",
|
|
1279
1242
|
"preserveMemberOrder": false,
|
|
@@ -1287,7 +1250,7 @@
|
|
|
1287
1250
|
{
|
|
1288
1251
|
"kind": "TypeAlias",
|
|
1289
1252
|
"canonicalReference": "@gcorevideo/player!ErrorScreenPluginSettings:type",
|
|
1290
|
-
"docComment": "/**\n * Configuration options for the {@link ErrorScreen
|
|
1253
|
+
"docComment": "/**\n * Configuration options for the {@link ErrorScreen} plugin.\n *\n * @public\n */\n",
|
|
1291
1254
|
"excerptTokens": [
|
|
1292
1255
|
{
|
|
1293
1256
|
"kind": "Content",
|
|
@@ -1303,13 +1266,39 @@
|
|
|
1303
1266
|
}
|
|
1304
1267
|
],
|
|
1305
1268
|
"fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
|
|
1306
|
-
"releaseTag": "
|
|
1269
|
+
"releaseTag": "Public",
|
|
1307
1270
|
"name": "ErrorScreenPluginSettings",
|
|
1308
1271
|
"typeTokenRange": {
|
|
1309
1272
|
"startIndex": 1,
|
|
1310
1273
|
"endIndex": 2
|
|
1311
1274
|
}
|
|
1312
1275
|
},
|
|
1276
|
+
{
|
|
1277
|
+
"kind": "TypeAlias",
|
|
1278
|
+
"canonicalReference": "@gcorevideo/player!ErrorScreenSettings:type",
|
|
1279
|
+
"docComment": "/**\n * Settings for the {@link ErrorScreen} plugin.\n *\n * @public\n */\n",
|
|
1280
|
+
"excerptTokens": [
|
|
1281
|
+
{
|
|
1282
|
+
"kind": "Content",
|
|
1283
|
+
"text": "export type ErrorScreenSettings = "
|
|
1284
|
+
},
|
|
1285
|
+
{
|
|
1286
|
+
"kind": "Content",
|
|
1287
|
+
"text": "{\n noReload?: boolean;\n}"
|
|
1288
|
+
},
|
|
1289
|
+
{
|
|
1290
|
+
"kind": "Content",
|
|
1291
|
+
"text": ";"
|
|
1292
|
+
}
|
|
1293
|
+
],
|
|
1294
|
+
"fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
|
|
1295
|
+
"releaseTag": "Public",
|
|
1296
|
+
"name": "ErrorScreenSettings",
|
|
1297
|
+
"typeTokenRange": {
|
|
1298
|
+
"startIndex": 1,
|
|
1299
|
+
"endIndex": 2
|
|
1300
|
+
}
|
|
1301
|
+
},
|
|
1313
1302
|
{
|
|
1314
1303
|
"kind": "Class",
|
|
1315
1304
|
"canonicalReference": "@gcorevideo/player!Favicon:class",
|
|
@@ -1387,57 +1376,42 @@
|
|
|
1387
1376
|
"extendsTokenRanges": []
|
|
1388
1377
|
},
|
|
1389
1378
|
{
|
|
1390
|
-
"kind": "
|
|
1391
|
-
"canonicalReference": "@gcorevideo/player!
|
|
1392
|
-
"docComment": "/**\n *
|
|
1379
|
+
"kind": "Enum",
|
|
1380
|
+
"canonicalReference": "@gcorevideo/player!GearEvents:enum",
|
|
1381
|
+
"docComment": "/**\n * Events triggered by the plugin\n *\n * @beta\n */\n",
|
|
1393
1382
|
"excerptTokens": [
|
|
1394
1383
|
{
|
|
1395
1384
|
"kind": "Content",
|
|
1396
|
-
"text": "export
|
|
1397
|
-
},
|
|
1398
|
-
{
|
|
1399
|
-
"kind": "Reference",
|
|
1400
|
-
"text": "GearOptionsItem",
|
|
1401
|
-
"canonicalReference": "@gcorevideo/player!GearOptionsItem:type"
|
|
1402
|
-
},
|
|
1403
|
-
{
|
|
1404
|
-
"kind": "Content",
|
|
1405
|
-
"text": ";"
|
|
1385
|
+
"text": "export declare enum GearEvents "
|
|
1406
1386
|
}
|
|
1407
1387
|
],
|
|
1408
1388
|
"fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
|
|
1409
|
-
"releaseTag": "
|
|
1410
|
-
"name": "
|
|
1411
|
-
"
|
|
1412
|
-
|
|
1413
|
-
"endIndex": 2
|
|
1414
|
-
}
|
|
1415
|
-
},
|
|
1416
|
-
{
|
|
1417
|
-
"kind": "TypeAlias",
|
|
1418
|
-
"canonicalReference": "@gcorevideo/player!GearOptionsItem:type",
|
|
1419
|
-
"docComment": "/**\n * An element inside the gear menu\n *\n * @beta\n */\n",
|
|
1420
|
-
"excerptTokens": [
|
|
1421
|
-
{
|
|
1422
|
-
"kind": "Content",
|
|
1423
|
-
"text": "export type GearOptionsItem = "
|
|
1424
|
-
},
|
|
1425
|
-
{
|
|
1426
|
-
"kind": "Content",
|
|
1427
|
-
"text": "'quality' | 'rate' | 'nerd'"
|
|
1428
|
-
},
|
|
1389
|
+
"releaseTag": "Beta",
|
|
1390
|
+
"name": "GearEvents",
|
|
1391
|
+
"preserveMemberOrder": false,
|
|
1392
|
+
"members": [
|
|
1429
1393
|
{
|
|
1430
|
-
"kind": "
|
|
1431
|
-
"
|
|
1394
|
+
"kind": "EnumMember",
|
|
1395
|
+
"canonicalReference": "@gcorevideo/player!GearEvents.RENDERED:member",
|
|
1396
|
+
"docComment": "/**\n * Use this event to accurately attach an item to the gear menu\n */\n",
|
|
1397
|
+
"excerptTokens": [
|
|
1398
|
+
{
|
|
1399
|
+
"kind": "Content",
|
|
1400
|
+
"text": "RENDERED = "
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"kind": "Content",
|
|
1404
|
+
"text": "\"rendered\""
|
|
1405
|
+
}
|
|
1406
|
+
],
|
|
1407
|
+
"initializerTokenRange": {
|
|
1408
|
+
"startIndex": 1,
|
|
1409
|
+
"endIndex": 2
|
|
1410
|
+
},
|
|
1411
|
+
"releaseTag": "Beta",
|
|
1412
|
+
"name": "RENDERED"
|
|
1432
1413
|
}
|
|
1433
|
-
]
|
|
1434
|
-
"fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
|
|
1435
|
-
"releaseTag": "Beta",
|
|
1436
|
-
"name": "GearOptionsItem",
|
|
1437
|
-
"typeTokenRange": {
|
|
1438
|
-
"startIndex": 1,
|
|
1439
|
-
"endIndex": 2
|
|
1440
|
-
}
|
|
1414
|
+
]
|
|
1441
1415
|
},
|
|
1442
1416
|
{
|
|
1443
1417
|
"kind": "Class",
|
|
@@ -2219,7 +2193,7 @@
|
|
|
2219
2193
|
},
|
|
2220
2194
|
{
|
|
2221
2195
|
"kind": "Content",
|
|
2222
|
-
"text": "{\n 'click .gear-sub-menu_btn': string;\n 'click .
|
|
2196
|
+
"text": "{\n 'click .gear-sub-menu_btn': string;\n 'click .go-back': string;\n }"
|
|
2223
2197
|
},
|
|
2224
2198
|
{
|
|
2225
2199
|
"kind": "Content",
|
|
@@ -2812,37 +2786,6 @@
|
|
|
2812
2786
|
"isAbstract": false,
|
|
2813
2787
|
"name": "enableControlButton"
|
|
2814
2788
|
},
|
|
2815
|
-
{
|
|
2816
|
-
"kind": "Method",
|
|
2817
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#getCenterPanel:member(1)",
|
|
2818
|
-
"docComment": "",
|
|
2819
|
-
"excerptTokens": [
|
|
2820
|
-
{
|
|
2821
|
-
"kind": "Content",
|
|
2822
|
-
"text": "getCenterPanel(): "
|
|
2823
|
-
},
|
|
2824
|
-
{
|
|
2825
|
-
"kind": "Content",
|
|
2826
|
-
"text": "any"
|
|
2827
|
-
},
|
|
2828
|
-
{
|
|
2829
|
-
"kind": "Content",
|
|
2830
|
-
"text": ";"
|
|
2831
|
-
}
|
|
2832
|
-
],
|
|
2833
|
-
"isStatic": false,
|
|
2834
|
-
"returnTypeTokenRange": {
|
|
2835
|
-
"startIndex": 1,
|
|
2836
|
-
"endIndex": 2
|
|
2837
|
-
},
|
|
2838
|
-
"releaseTag": "Beta",
|
|
2839
|
-
"isProtected": false,
|
|
2840
|
-
"overloadIndex": 1,
|
|
2841
|
-
"parameters": [],
|
|
2842
|
-
"isOptional": false,
|
|
2843
|
-
"isAbstract": false,
|
|
2844
|
-
"name": "getCenterPanel"
|
|
2845
|
-
},
|
|
2846
2789
|
{
|
|
2847
2790
|
"kind": "Method",
|
|
2848
2791
|
"canonicalReference": "@gcorevideo/player!MediaControl#getElement:member(1)",
|
|
@@ -2899,47 +2842,33 @@
|
|
|
2899
2842
|
},
|
|
2900
2843
|
{
|
|
2901
2844
|
"kind": "Method",
|
|
2902
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#
|
|
2903
|
-
"docComment": "
|
|
2845
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#handleCustomArea:member(1)",
|
|
2846
|
+
"docComment": "",
|
|
2904
2847
|
"excerptTokens": [
|
|
2905
2848
|
{
|
|
2906
2849
|
"kind": "Content",
|
|
2907
|
-
"text": "
|
|
2850
|
+
"text": "handleCustomArea(handler: "
|
|
2908
2851
|
},
|
|
2909
2852
|
{
|
|
2910
2853
|
"kind": "Content",
|
|
2911
|
-
"text": "
|
|
2854
|
+
"text": "(name: string, content: "
|
|
2855
|
+
},
|
|
2856
|
+
{
|
|
2857
|
+
"kind": "Reference",
|
|
2858
|
+
"text": "HTMLElement",
|
|
2859
|
+
"canonicalReference": "!HTMLElement:interface"
|
|
2912
2860
|
},
|
|
2913
2861
|
{
|
|
2914
2862
|
"kind": "Content",
|
|
2915
|
-
"text": "
|
|
2916
|
-
}
|
|
2917
|
-
],
|
|
2918
|
-
"isStatic": false,
|
|
2919
|
-
"returnTypeTokenRange": {
|
|
2920
|
-
"startIndex": 1,
|
|
2921
|
-
"endIndex": 2
|
|
2922
|
-
},
|
|
2923
|
-
"releaseTag": "Beta",
|
|
2924
|
-
"isProtected": false,
|
|
2925
|
-
"overloadIndex": 1,
|
|
2926
|
-
"parameters": [],
|
|
2927
|
-
"isOptional": false,
|
|
2928
|
-
"isAbstract": false,
|
|
2929
|
-
"name": "getLeftPanel"
|
|
2930
|
-
},
|
|
2931
|
-
{
|
|
2932
|
-
"kind": "Method",
|
|
2933
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#getRightPanel:member(1)",
|
|
2934
|
-
"docComment": "/**\n * Get the right panel area to append custom elements to\n *\n * @returns ZeptoSelector of the right panel element\n */\n",
|
|
2935
|
-
"excerptTokens": [
|
|
2863
|
+
"text": ") => void"
|
|
2864
|
+
},
|
|
2936
2865
|
{
|
|
2937
2866
|
"kind": "Content",
|
|
2938
|
-
"text": "
|
|
2867
|
+
"text": "): "
|
|
2939
2868
|
},
|
|
2940
2869
|
{
|
|
2941
2870
|
"kind": "Content",
|
|
2942
|
-
"text": "
|
|
2871
|
+
"text": "void"
|
|
2943
2872
|
},
|
|
2944
2873
|
{
|
|
2945
2874
|
"kind": "Content",
|
|
@@ -2948,16 +2877,25 @@
|
|
|
2948
2877
|
],
|
|
2949
2878
|
"isStatic": false,
|
|
2950
2879
|
"returnTypeTokenRange": {
|
|
2951
|
-
"startIndex":
|
|
2952
|
-
"endIndex":
|
|
2880
|
+
"startIndex": 5,
|
|
2881
|
+
"endIndex": 6
|
|
2953
2882
|
},
|
|
2954
2883
|
"releaseTag": "Beta",
|
|
2955
2884
|
"isProtected": false,
|
|
2956
2885
|
"overloadIndex": 1,
|
|
2957
|
-
"parameters": [
|
|
2886
|
+
"parameters": [
|
|
2887
|
+
{
|
|
2888
|
+
"parameterName": "handler",
|
|
2889
|
+
"parameterTypeTokenRange": {
|
|
2890
|
+
"startIndex": 1,
|
|
2891
|
+
"endIndex": 4
|
|
2892
|
+
},
|
|
2893
|
+
"isOptional": false
|
|
2894
|
+
}
|
|
2895
|
+
],
|
|
2958
2896
|
"isOptional": false,
|
|
2959
2897
|
"isAbstract": false,
|
|
2960
|
-
"name": "
|
|
2898
|
+
"name": "handleCustomArea"
|
|
2961
2899
|
},
|
|
2962
2900
|
{
|
|
2963
2901
|
"kind": "Property",
|
|
@@ -3009,8 +2947,8 @@
|
|
|
3009
2947
|
},
|
|
3010
2948
|
{
|
|
3011
2949
|
"kind": "Reference",
|
|
3012
|
-
"text": "
|
|
3013
|
-
"canonicalReference": "!
|
|
2950
|
+
"text": "ZeptoResult",
|
|
2951
|
+
"canonicalReference": "@gcorevideo/player!ZeptoResult:type"
|
|
3014
2952
|
},
|
|
3015
2953
|
{
|
|
3016
2954
|
"kind": "Content",
|
|
@@ -3084,24 +3022,89 @@
|
|
|
3084
3022
|
"parameters": [],
|
|
3085
3023
|
"isOptional": false,
|
|
3086
3024
|
"isAbstract": false,
|
|
3087
|
-
"name": "setInitialVolume"
|
|
3025
|
+
"name": "setInitialVolume"
|
|
3026
|
+
},
|
|
3027
|
+
{
|
|
3028
|
+
"kind": "Method",
|
|
3029
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#setVolume:member(1)",
|
|
3030
|
+
"docComment": "/**\n * Set the volume\n *\n * @remarks\n *\n * Initial volume can be restored later\n *\n * @param value - The volume value\n *\n * @param isInitialVolume - save as the initial volume\n */\n",
|
|
3031
|
+
"excerptTokens": [
|
|
3032
|
+
{
|
|
3033
|
+
"kind": "Content",
|
|
3034
|
+
"text": "setVolume(value: "
|
|
3035
|
+
},
|
|
3036
|
+
{
|
|
3037
|
+
"kind": "Content",
|
|
3038
|
+
"text": "number"
|
|
3039
|
+
},
|
|
3040
|
+
{
|
|
3041
|
+
"kind": "Content",
|
|
3042
|
+
"text": ", isInitialVolume?: "
|
|
3043
|
+
},
|
|
3044
|
+
{
|
|
3045
|
+
"kind": "Content",
|
|
3046
|
+
"text": "boolean"
|
|
3047
|
+
},
|
|
3048
|
+
{
|
|
3049
|
+
"kind": "Content",
|
|
3050
|
+
"text": "): "
|
|
3051
|
+
},
|
|
3052
|
+
{
|
|
3053
|
+
"kind": "Content",
|
|
3054
|
+
"text": "void"
|
|
3055
|
+
},
|
|
3056
|
+
{
|
|
3057
|
+
"kind": "Content",
|
|
3058
|
+
"text": ";"
|
|
3059
|
+
}
|
|
3060
|
+
],
|
|
3061
|
+
"isStatic": false,
|
|
3062
|
+
"returnTypeTokenRange": {
|
|
3063
|
+
"startIndex": 5,
|
|
3064
|
+
"endIndex": 6
|
|
3065
|
+
},
|
|
3066
|
+
"releaseTag": "Beta",
|
|
3067
|
+
"isProtected": false,
|
|
3068
|
+
"overloadIndex": 1,
|
|
3069
|
+
"parameters": [
|
|
3070
|
+
{
|
|
3071
|
+
"parameterName": "value",
|
|
3072
|
+
"parameterTypeTokenRange": {
|
|
3073
|
+
"startIndex": 1,
|
|
3074
|
+
"endIndex": 2
|
|
3075
|
+
},
|
|
3076
|
+
"isOptional": false
|
|
3077
|
+
},
|
|
3078
|
+
{
|
|
3079
|
+
"parameterName": "isInitialVolume",
|
|
3080
|
+
"parameterTypeTokenRange": {
|
|
3081
|
+
"startIndex": 3,
|
|
3082
|
+
"endIndex": 4
|
|
3083
|
+
},
|
|
3084
|
+
"isOptional": true
|
|
3085
|
+
}
|
|
3086
|
+
],
|
|
3087
|
+
"isOptional": false,
|
|
3088
|
+
"isAbstract": false,
|
|
3089
|
+
"name": "setVolume"
|
|
3088
3090
|
},
|
|
3089
3091
|
{
|
|
3090
3092
|
"kind": "Method",
|
|
3091
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#
|
|
3092
|
-
"docComment": "/**\n *
|
|
3093
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#toggleElement:member(1)",
|
|
3094
|
+
"docComment": "/**\n * Toggle the visibility of a media control element\n *\n * @param name - The name of the media control element\n *\n * @param show - Whether to show or hide the element\n */\n",
|
|
3093
3095
|
"excerptTokens": [
|
|
3094
3096
|
{
|
|
3095
3097
|
"kind": "Content",
|
|
3096
|
-
"text": "
|
|
3098
|
+
"text": "toggleElement(area: "
|
|
3097
3099
|
},
|
|
3098
3100
|
{
|
|
3099
|
-
"kind": "
|
|
3100
|
-
"text": "
|
|
3101
|
+
"kind": "Reference",
|
|
3102
|
+
"text": "MediaControlElement",
|
|
3103
|
+
"canonicalReference": "@gcorevideo/player!MediaControlElement:type"
|
|
3101
3104
|
},
|
|
3102
3105
|
{
|
|
3103
3106
|
"kind": "Content",
|
|
3104
|
-
"text": ",
|
|
3107
|
+
"text": ", show: "
|
|
3105
3108
|
},
|
|
3106
3109
|
{
|
|
3107
3110
|
"kind": "Content",
|
|
@@ -3130,7 +3133,7 @@
|
|
|
3130
3133
|
"overloadIndex": 1,
|
|
3131
3134
|
"parameters": [
|
|
3132
3135
|
{
|
|
3133
|
-
"parameterName": "
|
|
3136
|
+
"parameterName": "area",
|
|
3134
3137
|
"parameterTypeTokenRange": {
|
|
3135
3138
|
"startIndex": 1,
|
|
3136
3139
|
"endIndex": 2
|
|
@@ -3138,17 +3141,17 @@
|
|
|
3138
3141
|
"isOptional": false
|
|
3139
3142
|
},
|
|
3140
3143
|
{
|
|
3141
|
-
"parameterName": "
|
|
3144
|
+
"parameterName": "show",
|
|
3142
3145
|
"parameterTypeTokenRange": {
|
|
3143
3146
|
"startIndex": 3,
|
|
3144
3147
|
"endIndex": 4
|
|
3145
3148
|
},
|
|
3146
|
-
"isOptional":
|
|
3149
|
+
"isOptional": false
|
|
3147
3150
|
}
|
|
3148
3151
|
],
|
|
3149
3152
|
"isOptional": false,
|
|
3150
3153
|
"isAbstract": false,
|
|
3151
|
-
"name": "
|
|
3154
|
+
"name": "toggleElement"
|
|
3152
3155
|
},
|
|
3153
3156
|
{
|
|
3154
3157
|
"kind": "Property",
|
|
@@ -3198,7 +3201,7 @@
|
|
|
3198
3201
|
},
|
|
3199
3202
|
{
|
|
3200
3203
|
"kind": "Content",
|
|
3201
|
-
"text": "'audiotracks' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | '
|
|
3204
|
+
"text": "'audiotracks' | 'cc' | 'clipText' | 'dvr' | 'duration' | 'fullscreen' | 'gear' | 'multicamera' | 'pip' | 'playbackRate' | 'position' | 'seekBarContainer' | 'vr' | 'volume'"
|
|
3202
3205
|
},
|
|
3203
3206
|
{
|
|
3204
3207
|
"kind": "Content",
|
|
@@ -3213,44 +3216,6 @@
|
|
|
3213
3216
|
"endIndex": 2
|
|
3214
3217
|
}
|
|
3215
3218
|
},
|
|
3216
|
-
{
|
|
3217
|
-
"kind": "Enum",
|
|
3218
|
-
"canonicalReference": "@gcorevideo/player!MediaControlEvents:enum",
|
|
3219
|
-
"docComment": "/**\n * Custom events emitted by the plugins to communicate with one another\n *\n * @beta\n */\n",
|
|
3220
|
-
"excerptTokens": [
|
|
3221
|
-
{
|
|
3222
|
-
"kind": "Content",
|
|
3223
|
-
"text": "export declare enum MediaControlEvents "
|
|
3224
|
-
}
|
|
3225
|
-
],
|
|
3226
|
-
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3227
|
-
"releaseTag": "Beta",
|
|
3228
|
-
"name": "MediaControlEvents",
|
|
3229
|
-
"preserveMemberOrder": false,
|
|
3230
|
-
"members": [
|
|
3231
|
-
{
|
|
3232
|
-
"kind": "EnumMember",
|
|
3233
|
-
"canonicalReference": "@gcorevideo/player!MediaControlEvents.MEDIACONTROL_GEAR_RENDERED:member",
|
|
3234
|
-
"docComment": "/**\n * Emitted when the gear menu is rendered\n */\n",
|
|
3235
|
-
"excerptTokens": [
|
|
3236
|
-
{
|
|
3237
|
-
"kind": "Content",
|
|
3238
|
-
"text": "MEDIACONTROL_GEAR_RENDERED = "
|
|
3239
|
-
},
|
|
3240
|
-
{
|
|
3241
|
-
"kind": "Content",
|
|
3242
|
-
"text": "\"mediacontrol:gear:rendered\""
|
|
3243
|
-
}
|
|
3244
|
-
],
|
|
3245
|
-
"initializerTokenRange": {
|
|
3246
|
-
"startIndex": 1,
|
|
3247
|
-
"endIndex": 2
|
|
3248
|
-
},
|
|
3249
|
-
"releaseTag": "Beta",
|
|
3250
|
-
"name": "MEDIACONTROL_GEAR_RENDERED"
|
|
3251
|
-
}
|
|
3252
|
-
]
|
|
3253
|
-
},
|
|
3254
3219
|
{
|
|
3255
3220
|
"kind": "Class",
|
|
3256
3221
|
"canonicalReference": "@gcorevideo/player!MultiCamera:class",
|
|
@@ -4034,7 +3999,7 @@
|
|
|
4034
3999
|
{
|
|
4035
4000
|
"kind": "Class",
|
|
4036
4001
|
"canonicalReference": "@gcorevideo/player!PlaybackRate:class",
|
|
4037
|
-
"docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl
|
|
4002
|
+
"docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR-enabled live streams.\n *\n * Plugin settings - {@link PlaybackRateSettings}\n *\n * @example\n * ```ts\n * import { Player, PlaybackRateSettings } from '@gcorevideo/player'\n * Player.registerPlugin(PlaybackRate)\n * const player = new Player({\n * playbackRate: {\n * options: [\n * { value: 0.5, label: '0.5x' },\n * { value: 1, label: '1x' },\n * ],\n * defaultValue: 1,\n * } as PlaybackRateSettings,\n * })\n * ```\n *\n * @beta\n */\n",
|
|
4038
4003
|
"excerptTokens": [
|
|
4039
4004
|
{
|
|
4040
4005
|
"kind": "Content",
|
|
@@ -4096,6 +4061,67 @@
|
|
|
4096
4061
|
},
|
|
4097
4062
|
"implementsTokenRanges": []
|
|
4098
4063
|
},
|
|
4064
|
+
{
|
|
4065
|
+
"kind": "TypeAlias",
|
|
4066
|
+
"canonicalReference": "@gcorevideo/player!PlaybackRateOption:type",
|
|
4067
|
+
"docComment": "/**\n * @beta\n */\n",
|
|
4068
|
+
"excerptTokens": [
|
|
4069
|
+
{
|
|
4070
|
+
"kind": "Content",
|
|
4071
|
+
"text": "export type PlaybackRateOption = "
|
|
4072
|
+
},
|
|
4073
|
+
{
|
|
4074
|
+
"kind": "Content",
|
|
4075
|
+
"text": "{\n value: number;\n label: string;\n}"
|
|
4076
|
+
},
|
|
4077
|
+
{
|
|
4078
|
+
"kind": "Content",
|
|
4079
|
+
"text": ";"
|
|
4080
|
+
}
|
|
4081
|
+
],
|
|
4082
|
+
"fileUrlPath": "src/plugins/playback-rate/PlaybackRate.ts",
|
|
4083
|
+
"releaseTag": "Beta",
|
|
4084
|
+
"name": "PlaybackRateOption",
|
|
4085
|
+
"typeTokenRange": {
|
|
4086
|
+
"startIndex": 1,
|
|
4087
|
+
"endIndex": 2
|
|
4088
|
+
}
|
|
4089
|
+
},
|
|
4090
|
+
{
|
|
4091
|
+
"kind": "TypeAlias",
|
|
4092
|
+
"canonicalReference": "@gcorevideo/player!PlaybackRateSettings:type",
|
|
4093
|
+
"docComment": "/**\n * @beta\n */\n",
|
|
4094
|
+
"excerptTokens": [
|
|
4095
|
+
{
|
|
4096
|
+
"kind": "Content",
|
|
4097
|
+
"text": "export type PlaybackRateSettings = "
|
|
4098
|
+
},
|
|
4099
|
+
{
|
|
4100
|
+
"kind": "Content",
|
|
4101
|
+
"text": "{\n options?: "
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"kind": "Reference",
|
|
4105
|
+
"text": "PlaybackRateOption",
|
|
4106
|
+
"canonicalReference": "@gcorevideo/player!PlaybackRateOption:type"
|
|
4107
|
+
},
|
|
4108
|
+
{
|
|
4109
|
+
"kind": "Content",
|
|
4110
|
+
"text": "[];\n defaultValue?: number;\n}"
|
|
4111
|
+
},
|
|
4112
|
+
{
|
|
4113
|
+
"kind": "Content",
|
|
4114
|
+
"text": ";"
|
|
4115
|
+
}
|
|
4116
|
+
],
|
|
4117
|
+
"fileUrlPath": "src/plugins/playback-rate/PlaybackRate.ts",
|
|
4118
|
+
"releaseTag": "Beta",
|
|
4119
|
+
"name": "PlaybackRateSettings",
|
|
4120
|
+
"typeTokenRange": {
|
|
4121
|
+
"startIndex": 1,
|
|
4122
|
+
"endIndex": 4
|
|
4123
|
+
}
|
|
4124
|
+
},
|
|
4099
4125
|
{
|
|
4100
4126
|
"kind": "TypeAlias",
|
|
4101
4127
|
"canonicalReference": "@gcorevideo/player!PlaybackType:type",
|
|
@@ -7765,7 +7791,7 @@
|
|
|
7765
7791
|
{
|
|
7766
7792
|
"kind": "Class",
|
|
7767
7793
|
"canonicalReference": "@gcorevideo/player!SourceController:class",
|
|
7768
|
-
"docComment": "/**\n * `PLUGIN` that is responsible for managing the automatic failover between sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works
|
|
7794
|
+
"docComment": "/**\n * `PLUGIN` that is responsible for managing the automatic failover between media sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works. Below is a simplified diagram:\n * ```markdown\n * sources_list:\n * - a.mpd | +--------------------+\n * - b.m3u8 |--->| init |\n * - ... | |--------------------|\n * | current_source = 0 |\n * +--------------------+\n * |\n * | source = a.mpd\n * | playback = dash.js\n * v\n * +------------------+\n * +-->| load source |\n * | +---------|--------+\n * | v\n * | +------------------+\n * | | play |\n * | +---------|--------+\n * | |\n * | v\n * | +-----------------------+\n * | | on playback_error |\n * | |-----------------------|\n * | | current_source = |\n * | | (current_source + 1) |\n * | | % len sources_list |\n * | | |\n * | | delay 1..3s |\n * | +---------------|-------+\n * | |\n * | source=b.m3u8 |\n * | playback=hls.js |\n * +-------------------+\n *\n * ```\n *\n * This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.\n *\n * @example\n * ```ts\n * import { SourceController } from '@gcorevideo/player'\n *\n * Player.registerPlugin(SourceController)\n * ```\n *\n * @public\n */\n",
|
|
7769
7795
|
"excerptTokens": [
|
|
7770
7796
|
{
|
|
7771
7797
|
"kind": "Content",
|
|
@@ -7782,11 +7808,45 @@
|
|
|
7782
7808
|
}
|
|
7783
7809
|
],
|
|
7784
7810
|
"fileUrlPath": "src/plugins/source-controller/SourceController.ts",
|
|
7785
|
-
"releaseTag": "
|
|
7811
|
+
"releaseTag": "Public",
|
|
7786
7812
|
"isAbstract": false,
|
|
7787
7813
|
"name": "SourceController",
|
|
7788
7814
|
"preserveMemberOrder": false,
|
|
7789
|
-
"members": [
|
|
7815
|
+
"members": [
|
|
7816
|
+
{
|
|
7817
|
+
"kind": "Constructor",
|
|
7818
|
+
"canonicalReference": "@gcorevideo/player!SourceController:constructor(1)",
|
|
7819
|
+
"docComment": "/**\n * Constructs a new instance of the `SourceController` class\n *\n * @param core - The Clappr core instance.\n */\n",
|
|
7820
|
+
"excerptTokens": [
|
|
7821
|
+
{
|
|
7822
|
+
"kind": "Content",
|
|
7823
|
+
"text": "constructor(core: "
|
|
7824
|
+
},
|
|
7825
|
+
{
|
|
7826
|
+
"kind": "Reference",
|
|
7827
|
+
"text": "ClapprCore",
|
|
7828
|
+
"canonicalReference": "@clappr/core!default:class"
|
|
7829
|
+
},
|
|
7830
|
+
{
|
|
7831
|
+
"kind": "Content",
|
|
7832
|
+
"text": ");"
|
|
7833
|
+
}
|
|
7834
|
+
],
|
|
7835
|
+
"releaseTag": "Public",
|
|
7836
|
+
"isProtected": false,
|
|
7837
|
+
"overloadIndex": 1,
|
|
7838
|
+
"parameters": [
|
|
7839
|
+
{
|
|
7840
|
+
"parameterName": "core",
|
|
7841
|
+
"parameterTypeTokenRange": {
|
|
7842
|
+
"startIndex": 1,
|
|
7843
|
+
"endIndex": 2
|
|
7844
|
+
},
|
|
7845
|
+
"isOptional": false
|
|
7846
|
+
}
|
|
7847
|
+
]
|
|
7848
|
+
}
|
|
7849
|
+
],
|
|
7790
7850
|
"extendsTokenRange": {
|
|
7791
7851
|
"startIndex": 1,
|
|
7792
7852
|
"endIndex": 2
|
|
@@ -7796,7 +7856,7 @@
|
|
|
7796
7856
|
{
|
|
7797
7857
|
"kind": "Enum",
|
|
7798
7858
|
"canonicalReference": "@gcorevideo/player!SpinnerEvents:enum",
|
|
7799
|
-
"docComment": "/**\n * Custom events emitted by the plugin\n *\n * @
|
|
7859
|
+
"docComment": "/**\n * Custom events emitted by the plugin\n *\n * @public\n */\n",
|
|
7800
7860
|
"excerptTokens": [
|
|
7801
7861
|
{
|
|
7802
7862
|
"kind": "Content",
|
|
@@ -7804,14 +7864,14 @@
|
|
|
7804
7864
|
}
|
|
7805
7865
|
],
|
|
7806
7866
|
"fileUrlPath": "src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts",
|
|
7807
|
-
"releaseTag": "
|
|
7867
|
+
"releaseTag": "Public",
|
|
7808
7868
|
"name": "SpinnerEvents",
|
|
7809
7869
|
"preserveMemberOrder": false,
|
|
7810
7870
|
"members": [
|
|
7811
7871
|
{
|
|
7812
7872
|
"kind": "EnumMember",
|
|
7813
7873
|
"canonicalReference": "@gcorevideo/player!SpinnerEvents.SYNC:member",
|
|
7814
|
-
"docComment": "/**\n * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates,
|
|
7874
|
+
"docComment": "/**\n * Emitted at the end of the spinner animation cycle to facilitate smooth UI updates, for instance, {@link SourceController} listens to this event to reload the source when the spinner is hidden\n */\n",
|
|
7815
7875
|
"excerptTokens": [
|
|
7816
7876
|
{
|
|
7817
7877
|
"kind": "Content",
|
|
@@ -7826,7 +7886,7 @@
|
|
|
7826
7886
|
"startIndex": 1,
|
|
7827
7887
|
"endIndex": 2
|
|
7828
7888
|
},
|
|
7829
|
-
"releaseTag": "
|
|
7889
|
+
"releaseTag": "Public",
|
|
7830
7890
|
"name": "SYNC"
|
|
7831
7891
|
}
|
|
7832
7892
|
]
|
|
@@ -7834,7 +7894,7 @@
|
|
|
7834
7894
|
{
|
|
7835
7895
|
"kind": "Class",
|
|
7836
7896
|
"canonicalReference": "@gcorevideo/player!SpinnerThreeBounce:class",
|
|
7837
|
-
"docComment": "/**\n * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state
|
|
7897
|
+
"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 * @public\n */\n",
|
|
7838
7898
|
"excerptTokens": [
|
|
7839
7899
|
{
|
|
7840
7900
|
"kind": "Content",
|
|
@@ -7851,7 +7911,7 @@
|
|
|
7851
7911
|
}
|
|
7852
7912
|
],
|
|
7853
7913
|
"fileUrlPath": "src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts",
|
|
7854
|
-
"releaseTag": "
|
|
7914
|
+
"releaseTag": "Public",
|
|
7855
7915
|
"isAbstract": false,
|
|
7856
7916
|
"name": "SpinnerThreeBounce",
|
|
7857
7917
|
"preserveMemberOrder": false,
|
|
@@ -7875,7 +7935,7 @@
|
|
|
7875
7935
|
"text": ");"
|
|
7876
7936
|
}
|
|
7877
7937
|
],
|
|
7878
|
-
"releaseTag": "
|
|
7938
|
+
"releaseTag": "Public",
|
|
7879
7939
|
"isProtected": false,
|
|
7880
7940
|
"overloadIndex": 1,
|
|
7881
7941
|
"parameters": [
|
|
@@ -7912,7 +7972,7 @@
|
|
|
7912
7972
|
"startIndex": 1,
|
|
7913
7973
|
"endIndex": 2
|
|
7914
7974
|
},
|
|
7915
|
-
"releaseTag": "
|
|
7975
|
+
"releaseTag": "Public",
|
|
7916
7976
|
"isProtected": false,
|
|
7917
7977
|
"overloadIndex": 1,
|
|
7918
7978
|
"parameters": [],
|
|
@@ -7923,7 +7983,7 @@
|
|
|
7923
7983
|
{
|
|
7924
7984
|
"kind": "Method",
|
|
7925
7985
|
"canonicalReference": "@gcorevideo/player!SpinnerThreeBounce#show:member(1)",
|
|
7926
|
-
"docComment": "/**\n * Shows the spinner.\n *\n *
|
|
7986
|
+
"docComment": "/**\n * Shows the spinner.\n *\n * The method call prevents spinner's built-in logic from automatically hiding it until {@link SpinnerThreeBounce.hide} is called\n *\n * @param delay - The delay in milliseconds before the spinner is shown.\n */\n",
|
|
7927
7987
|
"excerptTokens": [
|
|
7928
7988
|
{
|
|
7929
7989
|
"kind": "Content",
|
|
@@ -7951,7 +8011,7 @@
|
|
|
7951
8011
|
"startIndex": 3,
|
|
7952
8012
|
"endIndex": 4
|
|
7953
8013
|
},
|
|
7954
|
-
"releaseTag": "
|
|
8014
|
+
"releaseTag": "Public",
|
|
7955
8015
|
"isProtected": false,
|
|
7956
8016
|
"overloadIndex": 1,
|
|
7957
8017
|
"parameters": [
|
|
@@ -8148,33 +8208,6 @@
|
|
|
8148
8208
|
],
|
|
8149
8209
|
"extendsTokenRanges": []
|
|
8150
8210
|
},
|
|
8151
|
-
{
|
|
8152
|
-
"kind": "TypeAlias",
|
|
8153
|
-
"canonicalReference": "@gcorevideo/player!SubtitlesPluginSettings:type",
|
|
8154
|
-
"docComment": "/**\n * @deprecated\n *\n * Use {@link ClosedCaptionsPluginSettings} instead.\n */\n",
|
|
8155
|
-
"excerptTokens": [
|
|
8156
|
-
{
|
|
8157
|
-
"kind": "Content",
|
|
8158
|
-
"text": "export type SubtitlesPluginSettings = "
|
|
8159
|
-
},
|
|
8160
|
-
{
|
|
8161
|
-
"kind": "Reference",
|
|
8162
|
-
"text": "ClosedCaptionsPluginSettings",
|
|
8163
|
-
"canonicalReference": "@gcorevideo/player!ClosedCaptionsPluginSettings:type"
|
|
8164
|
-
},
|
|
8165
|
-
{
|
|
8166
|
-
"kind": "Content",
|
|
8167
|
-
"text": ";"
|
|
8168
|
-
}
|
|
8169
|
-
],
|
|
8170
|
-
"fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
|
|
8171
|
-
"releaseTag": "Public",
|
|
8172
|
-
"name": "SubtitlesPluginSettings",
|
|
8173
|
-
"typeTokenRange": {
|
|
8174
|
-
"startIndex": 1,
|
|
8175
|
-
"endIndex": 2
|
|
8176
|
-
}
|
|
8177
|
-
},
|
|
8178
8211
|
{
|
|
8179
8212
|
"kind": "Class",
|
|
8180
8213
|
"canonicalReference": "@gcorevideo/player!Telemetry:class",
|
|
@@ -8576,106 +8609,6 @@
|
|
|
8576
8609
|
"endIndex": 4
|
|
8577
8610
|
}
|
|
8578
8611
|
},
|
|
8579
|
-
{
|
|
8580
|
-
"kind": "Interface",
|
|
8581
|
-
"canonicalReference": "@gcorevideo/player!TextTrackItem:interface",
|
|
8582
|
-
"docComment": "",
|
|
8583
|
-
"excerptTokens": [
|
|
8584
|
-
{
|
|
8585
|
-
"kind": "Content",
|
|
8586
|
-
"text": "export interface TextTrackItem "
|
|
8587
|
-
}
|
|
8588
|
-
],
|
|
8589
|
-
"fileUrlPath": "src/playback.types.ts",
|
|
8590
|
-
"releaseTag": "Public",
|
|
8591
|
-
"name": "TextTrackItem",
|
|
8592
|
-
"preserveMemberOrder": false,
|
|
8593
|
-
"members": [
|
|
8594
|
-
{
|
|
8595
|
-
"kind": "PropertySignature",
|
|
8596
|
-
"canonicalReference": "@gcorevideo/player!TextTrackItem#id:member",
|
|
8597
|
-
"docComment": "",
|
|
8598
|
-
"excerptTokens": [
|
|
8599
|
-
{
|
|
8600
|
-
"kind": "Content",
|
|
8601
|
-
"text": "id: "
|
|
8602
|
-
},
|
|
8603
|
-
{
|
|
8604
|
-
"kind": "Content",
|
|
8605
|
-
"text": "number"
|
|
8606
|
-
},
|
|
8607
|
-
{
|
|
8608
|
-
"kind": "Content",
|
|
8609
|
-
"text": ";"
|
|
8610
|
-
}
|
|
8611
|
-
],
|
|
8612
|
-
"isReadonly": false,
|
|
8613
|
-
"isOptional": false,
|
|
8614
|
-
"releaseTag": "Public",
|
|
8615
|
-
"name": "id",
|
|
8616
|
-
"propertyTypeTokenRange": {
|
|
8617
|
-
"startIndex": 1,
|
|
8618
|
-
"endIndex": 2
|
|
8619
|
-
}
|
|
8620
|
-
},
|
|
8621
|
-
{
|
|
8622
|
-
"kind": "PropertySignature",
|
|
8623
|
-
"canonicalReference": "@gcorevideo/player!TextTrackItem#name:member",
|
|
8624
|
-
"docComment": "",
|
|
8625
|
-
"excerptTokens": [
|
|
8626
|
-
{
|
|
8627
|
-
"kind": "Content",
|
|
8628
|
-
"text": "name: "
|
|
8629
|
-
},
|
|
8630
|
-
{
|
|
8631
|
-
"kind": "Content",
|
|
8632
|
-
"text": "string"
|
|
8633
|
-
},
|
|
8634
|
-
{
|
|
8635
|
-
"kind": "Content",
|
|
8636
|
-
"text": ";"
|
|
8637
|
-
}
|
|
8638
|
-
],
|
|
8639
|
-
"isReadonly": false,
|
|
8640
|
-
"isOptional": false,
|
|
8641
|
-
"releaseTag": "Public",
|
|
8642
|
-
"name": "name",
|
|
8643
|
-
"propertyTypeTokenRange": {
|
|
8644
|
-
"startIndex": 1,
|
|
8645
|
-
"endIndex": 2
|
|
8646
|
-
}
|
|
8647
|
-
},
|
|
8648
|
-
{
|
|
8649
|
-
"kind": "PropertySignature",
|
|
8650
|
-
"canonicalReference": "@gcorevideo/player!TextTrackItem#track:member",
|
|
8651
|
-
"docComment": "",
|
|
8652
|
-
"excerptTokens": [
|
|
8653
|
-
{
|
|
8654
|
-
"kind": "Content",
|
|
8655
|
-
"text": "track: "
|
|
8656
|
-
},
|
|
8657
|
-
{
|
|
8658
|
-
"kind": "Reference",
|
|
8659
|
-
"text": "TextTrack",
|
|
8660
|
-
"canonicalReference": "!TextTrack:interface"
|
|
8661
|
-
},
|
|
8662
|
-
{
|
|
8663
|
-
"kind": "Content",
|
|
8664
|
-
"text": ";"
|
|
8665
|
-
}
|
|
8666
|
-
],
|
|
8667
|
-
"isReadonly": false,
|
|
8668
|
-
"isOptional": false,
|
|
8669
|
-
"releaseTag": "Public",
|
|
8670
|
-
"name": "track",
|
|
8671
|
-
"propertyTypeTokenRange": {
|
|
8672
|
-
"startIndex": 1,
|
|
8673
|
-
"endIndex": 2
|
|
8674
|
-
}
|
|
8675
|
-
}
|
|
8676
|
-
],
|
|
8677
|
-
"extendsTokenRanges": []
|
|
8678
|
-
},
|
|
8679
8612
|
{
|
|
8680
8613
|
"kind": "Class",
|
|
8681
8614
|
"canonicalReference": "@gcorevideo/player!Thumbnails:class",
|