@gcorevideo/player 2.25.10 → 2.26.0
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/dist/core.js +1 -60
- package/dist/index.css +1170 -1170
- package/dist/index.embed.js +50 -130
- package/dist/index.js +79 -230
- package/dist/player.d.ts +2798 -2785
- package/docs/api/player.bigmutebutton.md +0 -3
- package/docs/api/player.bottomgear.additem.md +0 -3
- package/docs/api/player.bottomgear.md +2 -5
- package/docs/api/player.bottomgear.refresh.md +0 -3
- package/docs/api/player.clapprstats._constructor_.md +0 -3
- package/docs/api/player.clapprstats.clearmetrics.md +0 -3
- package/docs/api/player.clapprstats.exportmetrics.md +1 -4
- package/docs/api/player.clapprstats.md +2 -7
- package/docs/api/player.clapprstatsbitratetrack.md +0 -3
- package/docs/api/player.clapprstatschronograph.md +0 -13
- package/docs/api/player.clapprstatscounter.md +0 -25
- package/docs/api/player.clapprstatsevents.md +1 -4
- package/docs/api/player.clapprstatsmetrics.md +0 -3
- package/docs/api/player.clapprstatssettings.md +1 -4
- package/docs/api/player.clapprstatssettings.runeach.md +0 -3
- package/docs/api/player.clicktopause.md +0 -3
- package/docs/api/player.clips.destroy.md +0 -3
- package/docs/api/player.clips.disable.md +0 -3
- package/docs/api/player.clips.enable.md +0 -3
- package/docs/api/player.clips.gettext.md +0 -3
- package/docs/api/player.clips.md +1 -16
- package/docs/api/player.clips.render.md +0 -3
- package/docs/api/player.clips.supportedversion.md +0 -3
- package/docs/api/player.clips.version.md +0 -3
- package/docs/api/player.clipspluginsettings.md +1 -4
- package/docs/api/player.clipspluginsettings.text.md +0 -3
- package/docs/api/player.closedcaptions.hide.md +0 -3
- package/docs/api/player.closedcaptions.md +6 -5
- package/docs/api/player.closedcaptions.show.md +0 -3
- package/docs/api/player.closedcaptionspluginsettings.md +0 -3
- package/docs/api/player.cmcdconfig._constructor_.md +0 -3
- package/docs/api/player.cmcdconfig.exportids.md +0 -3
- package/docs/api/player.cmcdconfig.md +2 -5
- package/docs/api/player.cmcdconfigoptions.contentid.md +0 -3
- package/docs/api/player.cmcdconfigoptions.md +2 -5
- package/docs/api/player.cmcdconfigoptions.sessionid.md +0 -3
- package/docs/api/player.dvrcontrols.md +0 -3
- package/docs/api/player.extendedevents.md +0 -7
- package/docs/api/player.favicon.md +0 -3
- package/docs/api/player.faviconpluginsettings.faviconcolor.md +0 -3
- package/docs/api/player.faviconpluginsettings.md +1 -4
- package/docs/api/player.gearevents.md +1 -4
- package/docs/api/player.md +24 -43
- package/docs/api/player.mediacontrol.defaultsettings.md +5 -1
- package/docs/api/player.mediacontrol.getavailablepopupheight.md +20 -0
- package/docs/api/player.mediacontrol.md +14 -0
- package/docs/api/player.menuoption.md +0 -3
- package/docs/api/player.nerdstats._constructor_.md +0 -3
- package/docs/api/player.nerdstats.md +1 -4
- package/docs/api/player.pictureinpicture.attributes.md +0 -3
- package/docs/api/player.pictureinpicture.md +2 -7
- package/docs/api/player.playbackrateoption.md +0 -3
- package/docs/api/player.playbackratesettings.md +0 -3
- package/docs/api/player.poster.disable.md +0 -3
- package/docs/api/player.poster.enable.md +0 -3
- package/docs/api/player.poster.md +2 -5
- package/docs/api/player.posterpluginsettings.custom.md +0 -3
- package/docs/api/player.posterpluginsettings.md +4 -7
- package/docs/api/player.posterpluginsettings.showfornoop.md +0 -3
- package/docs/api/player.posterpluginsettings.showonvideoend.md +0 -3
- package/docs/api/player.posterpluginsettings.url.md +0 -3
- package/docs/api/player.qualitylevels.events.md +0 -3
- package/docs/api/player.qualitylevels.md +0 -5
- package/docs/api/player.qualitylevelspluginsettings.labels.md +0 -3
- package/docs/api/player.qualitylevelspluginsettings.md +2 -5
- package/docs/api/player.qualitylevelspluginsettings.restrictresolution.md +0 -3
- package/docs/api/player.skiptime.container.md +0 -3
- package/docs/api/player.skiptime.md +0 -9
- package/docs/api/player.skiptime.name.md +0 -3
- package/docs/api/player.skiptime.supportedversion.md +0 -3
- package/docs/api/player.volumefadeevents.md +0 -5
- package/docs/api/player.volumefadesettings.md +0 -3
- package/docs/api/player.zeptoresult.md +0 -3
- package/lib/Player.d.ts.map +1 -1
- package/lib/Player.js +0 -29
- package/lib/playback/HTML5Video.d.ts.map +1 -1
- package/lib/playback/HTML5Video.js +0 -18
- package/lib/playback/dash-playback/DashPlayback.d.ts.map +1 -1
- package/lib/playback/dash-playback/DashPlayback.js +0 -10
- package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
- package/lib/playback/hls-playback/HlsPlayback.js +0 -2
- package/lib/plugins/big-mute-button/BigMuteButton.d.ts +1 -1
- package/lib/plugins/big-mute-button/BigMuteButton.d.ts.map +1 -1
- package/lib/plugins/big-mute-button/BigMuteButton.js +1 -3
- package/lib/plugins/bottom-gear/BottomGear.d.ts +2 -2
- package/lib/plugins/bottom-gear/BottomGear.d.ts.map +1 -1
- package/lib/plugins/bottom-gear/BottomGear.js +4 -8
- package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts +1 -1
- package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts.map +1 -1
- package/lib/plugins/clappr-nerd-stats/NerdStats.js +3 -5
- package/lib/plugins/clappr-stats/ClapprStats.d.ts +3 -3
- package/lib/plugins/clappr-stats/ClapprStats.js +2 -2
- package/lib/plugins/clappr-stats/types.d.ts +5 -5
- package/lib/plugins/clappr-stats/types.js +3 -3
- 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 -7
- package/lib/plugins/clips/Clips.d.ts +2 -2
- package/lib/plugins/clips/Clips.d.ts.map +1 -1
- package/lib/plugins/clips/Clips.js +2 -6
- package/lib/plugins/cmcd-config/CmcdConfig.d.ts +2 -2
- package/lib/plugins/cmcd-config/CmcdConfig.js +1 -1
- package/lib/plugins/context-menu/ContextMenu.d.ts +1 -1
- package/lib/plugins/dvr-controls/DvrControls.d.ts +1 -1
- package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
- package/lib/plugins/dvr-controls/DvrControls.js +3 -4
- package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
- package/lib/plugins/error-screen/ErrorScreen.js +0 -3
- package/lib/plugins/favicon/Favicon.d.ts +2 -2
- package/lib/plugins/favicon/Favicon.js +1 -1
- package/lib/plugins/level-selector/QualityLevels.d.ts +2 -2
- package/lib/plugins/level-selector/QualityLevels.d.ts.map +1 -1
- package/lib/plugins/level-selector/QualityLevels.js +3 -11
- package/lib/plugins/media-control/MediaControl.d.ts +2 -5
- package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
- package/lib/plugins/media-control/MediaControl.js +4 -6
- package/lib/plugins/picture-in-picture/PictureInPicture.d.ts +3 -3
- package/lib/plugins/picture-in-picture/PictureInPicture.js +3 -3
- package/lib/plugins/playback-rate/PlaybackRate.d.ts +2 -2
- package/lib/plugins/playback-rate/PlaybackRate.d.ts.map +1 -1
- package/lib/plugins/playback-rate/PlaybackRate.js +0 -10
- package/lib/plugins/poster/Poster.d.ts +2 -2
- package/lib/plugins/poster/Poster.d.ts.map +1 -1
- package/lib/plugins/poster/Poster.js +3 -19
- package/lib/plugins/seek-time/SeekTime.d.ts.map +1 -1
- package/lib/plugins/seek-time/SeekTime.js +1 -6
- package/lib/plugins/skip-time/SkipTime.d.ts +1 -1
- package/lib/plugins/skip-time/SkipTime.d.ts.map +1 -1
- package/lib/plugins/skip-time/SkipTime.js +3 -15
- package/lib/plugins/source-controller/SourceController.d.ts.map +1 -1
- package/lib/plugins/source-controller/SourceController.js +0 -5
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map +1 -1
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +2 -18
- package/lib/plugins/subtitles/ClosedCaptions.d.ts +2 -2
- package/lib/plugins/subtitles/ClosedCaptions.js +1 -1
- package/lib/plugins/volume-fade/VolumeFade.d.ts +2 -2
- package/lib/plugins/volume-fade/VolumeFade.js +1 -1
- package/lib/types.d.ts +1 -1
- package/package.json +1 -1
- package/src/Player.ts +0 -29
- package/src/playback/HTML5Video.ts +0 -18
- package/src/playback/dash-playback/DashPlayback.ts +0 -11
- package/src/playback/hls-playback/HlsPlayback.ts +0 -3
- package/src/plugins/big-mute-button/BigMuteButton.ts +1 -4
- package/src/plugins/bottom-gear/BottomGear.ts +4 -8
- package/src/plugins/clappr-nerd-stats/NerdStats.ts +3 -5
- package/src/plugins/clappr-stats/ClapprStats.ts +3 -3
- package/src/plugins/clappr-stats/types.ts +5 -5
- package/src/plugins/click-to-pause/ClickToPause.ts +3 -8
- package/src/plugins/clips/Clips.ts +4 -7
- package/src/plugins/cmcd-config/CmcdConfig.ts +2 -2
- package/src/plugins/context-menu/ContextMenu.ts +1 -1
- package/src/plugins/dvr-controls/DvrControls.ts +3 -4
- package/src/plugins/error-screen/ErrorScreen.ts +0 -3
- package/src/plugins/favicon/Favicon.ts +2 -2
- package/src/plugins/level-selector/QualityLevels.ts +4 -12
- package/src/plugins/media-control/MediaControl.ts +4 -10
- package/src/plugins/picture-in-picture/PictureInPicture.ts +3 -3
- package/src/plugins/playback-rate/PlaybackRate.ts +2 -14
- package/src/plugins/poster/Poster.ts +4 -21
- package/src/plugins/seek-time/SeekTime.ts +2 -6
- package/src/plugins/skip-time/SkipTime.ts +3 -15
- package/src/plugins/source-controller/SourceController.ts +0 -5
- package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +2 -18
- package/src/plugins/subtitles/ClosedCaptions.ts +2 -2
- package/src/plugins/volume-fade/VolumeFade.ts +2 -2
- package/src/types.ts +1 -1
- package/temp/player.api.json +157 -152
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.mediacontrolpluginsettings.md +0 -13
package/temp/player.api.json
CHANGED
|
@@ -206,7 +206,7 @@
|
|
|
206
206
|
{
|
|
207
207
|
"kind": "Class",
|
|
208
208
|
"canonicalReference": "@gcorevideo/player!BigMuteButton:class",
|
|
209
|
-
"docComment": "/**\n * `PLUGIN` that displays a big mute button over the video when it's being played muted.\n *\n * @remarks\n *\n * When pressed, it unmutes the video.\n *\n * @example\n * ```ts\n * import { BigMuteButton } from '@gcorevideo/player'\n * Player.registerPlugin(BigMuteButton)\n * ```\n *\n * @
|
|
209
|
+
"docComment": "/**\n * `PLUGIN` that displays a big mute button over the video when it's being played muted.\n *\n * @remarks\n *\n * When pressed, it unmutes the video.\n *\n * @example\n * ```ts\n * import { BigMuteButton } from '@gcorevideo/player'\n * Player.registerPlugin(BigMuteButton)\n * ```\n *\n * @public\n */\n",
|
|
210
210
|
"excerptTokens": [
|
|
211
211
|
{
|
|
212
212
|
"kind": "Content",
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
}
|
|
224
224
|
],
|
|
225
225
|
"fileUrlPath": "src/plugins/big-mute-button/BigMuteButton.ts",
|
|
226
|
-
"releaseTag": "
|
|
226
|
+
"releaseTag": "Public",
|
|
227
227
|
"isAbstract": false,
|
|
228
228
|
"name": "BigMuteButton",
|
|
229
229
|
"preserveMemberOrder": false,
|
|
@@ -237,7 +237,7 @@
|
|
|
237
237
|
{
|
|
238
238
|
"kind": "Class",
|
|
239
239
|
"canonicalReference": "@gcorevideo/player!BottomGear:class",
|
|
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 * @
|
|
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 * @public\n */\n",
|
|
241
241
|
"excerptTokens": [
|
|
242
242
|
{
|
|
243
243
|
"kind": "Content",
|
|
@@ -254,7 +254,7 @@
|
|
|
254
254
|
}
|
|
255
255
|
],
|
|
256
256
|
"fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
|
|
257
|
-
"releaseTag": "
|
|
257
|
+
"releaseTag": "Public",
|
|
258
258
|
"isAbstract": false,
|
|
259
259
|
"name": "BottomGear",
|
|
260
260
|
"preserveMemberOrder": false,
|
|
@@ -300,7 +300,7 @@
|
|
|
300
300
|
"startIndex": 5,
|
|
301
301
|
"endIndex": 6
|
|
302
302
|
},
|
|
303
|
-
"releaseTag": "
|
|
303
|
+
"releaseTag": "Public",
|
|
304
304
|
"isProtected": false,
|
|
305
305
|
"overloadIndex": 1,
|
|
306
306
|
"parameters": [
|
|
@@ -348,7 +348,7 @@
|
|
|
348
348
|
"startIndex": 1,
|
|
349
349
|
"endIndex": 2
|
|
350
350
|
},
|
|
351
|
-
"releaseTag": "
|
|
351
|
+
"releaseTag": "Public",
|
|
352
352
|
"isProtected": false,
|
|
353
353
|
"overloadIndex": 1,
|
|
354
354
|
"parameters": [],
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
{
|
|
367
367
|
"kind": "Class",
|
|
368
368
|
"canonicalReference": "@gcorevideo/player!ClapprStats:class",
|
|
369
|
-
"docComment": "/**\n * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.\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 * @see\n *\n * {@link NerdStats} - a plugin that visualises the playback metrics\n *\n * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @
|
|
369
|
+
"docComment": "/**\n * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.\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 * @see\n *\n * {@link NerdStats} - a plugin that visualises the playback metrics\n *\n * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @public\n */\n",
|
|
370
370
|
"excerptTokens": [
|
|
371
371
|
{
|
|
372
372
|
"kind": "Content",
|
|
@@ -383,7 +383,7 @@
|
|
|
383
383
|
}
|
|
384
384
|
],
|
|
385
385
|
"fileUrlPath": "src/plugins/clappr-stats/ClapprStats.ts",
|
|
386
|
-
"releaseTag": "
|
|
386
|
+
"releaseTag": "Public",
|
|
387
387
|
"isAbstract": false,
|
|
388
388
|
"name": "ClapprStats",
|
|
389
389
|
"preserveMemberOrder": false,
|
|
@@ -407,7 +407,7 @@
|
|
|
407
407
|
"text": ");"
|
|
408
408
|
}
|
|
409
409
|
],
|
|
410
|
-
"releaseTag": "
|
|
410
|
+
"releaseTag": "Public",
|
|
411
411
|
"isProtected": false,
|
|
412
412
|
"overloadIndex": 1,
|
|
413
413
|
"parameters": [
|
|
@@ -444,7 +444,7 @@
|
|
|
444
444
|
"startIndex": 1,
|
|
445
445
|
"endIndex": 2
|
|
446
446
|
},
|
|
447
|
-
"releaseTag": "
|
|
447
|
+
"releaseTag": "Public",
|
|
448
448
|
"isProtected": false,
|
|
449
449
|
"overloadIndex": 1,
|
|
450
450
|
"parameters": [],
|
|
@@ -455,7 +455,7 @@
|
|
|
455
455
|
{
|
|
456
456
|
"kind": "Method",
|
|
457
457
|
"canonicalReference": "@gcorevideo/player!ClapprStats#exportMetrics:member(1)",
|
|
458
|
-
"docComment": "/**\n * Returns the collected metrics.\n *\n * @returns Measurements collected so far\n */\n",
|
|
458
|
+
"docComment": "/**\n * Returns the collected metrics.\n *\n * @returns {@link ClapprStatsMetrics | Measurements} collected so far\n */\n",
|
|
459
459
|
"excerptTokens": [
|
|
460
460
|
{
|
|
461
461
|
"kind": "Content",
|
|
@@ -476,7 +476,7 @@
|
|
|
476
476
|
"startIndex": 1,
|
|
477
477
|
"endIndex": 2
|
|
478
478
|
},
|
|
479
|
-
"releaseTag": "
|
|
479
|
+
"releaseTag": "Public",
|
|
480
480
|
"isProtected": false,
|
|
481
481
|
"overloadIndex": 1,
|
|
482
482
|
"parameters": [],
|
|
@@ -494,7 +494,7 @@
|
|
|
494
494
|
{
|
|
495
495
|
"kind": "TypeAlias",
|
|
496
496
|
"canonicalReference": "@gcorevideo/player!ClapprStatsBitrateTrack:type",
|
|
497
|
-
"docComment": "/**\n * @
|
|
497
|
+
"docComment": "/**\n * @public\n */\n",
|
|
498
498
|
"excerptTokens": [
|
|
499
499
|
{
|
|
500
500
|
"kind": "Content",
|
|
@@ -510,7 +510,7 @@
|
|
|
510
510
|
}
|
|
511
511
|
],
|
|
512
512
|
"fileUrlPath": "src/plugins/clappr-stats/types.ts",
|
|
513
|
-
"releaseTag": "
|
|
513
|
+
"releaseTag": "Public",
|
|
514
514
|
"name": "ClapprStatsBitrateTrack",
|
|
515
515
|
"typeTokenRange": {
|
|
516
516
|
"startIndex": 1,
|
|
@@ -520,7 +520,7 @@
|
|
|
520
520
|
{
|
|
521
521
|
"kind": "Enum",
|
|
522
522
|
"canonicalReference": "@gcorevideo/player!ClapprStatsChronograph:enum",
|
|
523
|
-
"docComment": "/**\n * @
|
|
523
|
+
"docComment": "/**\n * @public\n */\n",
|
|
524
524
|
"excerptTokens": [
|
|
525
525
|
{
|
|
526
526
|
"kind": "Content",
|
|
@@ -528,7 +528,7 @@
|
|
|
528
528
|
}
|
|
529
529
|
],
|
|
530
530
|
"fileUrlPath": "src/plugins/clappr-stats/types.ts",
|
|
531
|
-
"releaseTag": "
|
|
531
|
+
"releaseTag": "Public",
|
|
532
532
|
"name": "ClapprStatsChronograph",
|
|
533
533
|
"preserveMemberOrder": false,
|
|
534
534
|
"members": [
|
|
@@ -550,7 +550,7 @@
|
|
|
550
550
|
"startIndex": 1,
|
|
551
551
|
"endIndex": 2
|
|
552
552
|
},
|
|
553
|
-
"releaseTag": "
|
|
553
|
+
"releaseTag": "Public",
|
|
554
554
|
"name": "Buffering"
|
|
555
555
|
},
|
|
556
556
|
{
|
|
@@ -571,7 +571,7 @@
|
|
|
571
571
|
"startIndex": 1,
|
|
572
572
|
"endIndex": 2
|
|
573
573
|
},
|
|
574
|
-
"releaseTag": "
|
|
574
|
+
"releaseTag": "Public",
|
|
575
575
|
"name": "Pause"
|
|
576
576
|
},
|
|
577
577
|
{
|
|
@@ -592,7 +592,7 @@
|
|
|
592
592
|
"startIndex": 1,
|
|
593
593
|
"endIndex": 2
|
|
594
594
|
},
|
|
595
|
-
"releaseTag": "
|
|
595
|
+
"releaseTag": "Public",
|
|
596
596
|
"name": "Session"
|
|
597
597
|
},
|
|
598
598
|
{
|
|
@@ -613,7 +613,7 @@
|
|
|
613
613
|
"startIndex": 1,
|
|
614
614
|
"endIndex": 2
|
|
615
615
|
},
|
|
616
|
-
"releaseTag": "
|
|
616
|
+
"releaseTag": "Public",
|
|
617
617
|
"name": "Startup"
|
|
618
618
|
},
|
|
619
619
|
{
|
|
@@ -634,7 +634,7 @@
|
|
|
634
634
|
"startIndex": 1,
|
|
635
635
|
"endIndex": 2
|
|
636
636
|
},
|
|
637
|
-
"releaseTag": "
|
|
637
|
+
"releaseTag": "Public",
|
|
638
638
|
"name": "Watch"
|
|
639
639
|
}
|
|
640
640
|
]
|
|
@@ -642,7 +642,7 @@
|
|
|
642
642
|
{
|
|
643
643
|
"kind": "Enum",
|
|
644
644
|
"canonicalReference": "@gcorevideo/player!ClapprStatsCounter:enum",
|
|
645
|
-
"docComment": "/**\n * @
|
|
645
|
+
"docComment": "/**\n * @public\n */\n",
|
|
646
646
|
"excerptTokens": [
|
|
647
647
|
{
|
|
648
648
|
"kind": "Content",
|
|
@@ -650,7 +650,7 @@
|
|
|
650
650
|
}
|
|
651
651
|
],
|
|
652
652
|
"fileUrlPath": "src/plugins/clappr-stats/types.ts",
|
|
653
|
-
"releaseTag": "
|
|
653
|
+
"releaseTag": "Public",
|
|
654
654
|
"name": "ClapprStatsCounter",
|
|
655
655
|
"preserveMemberOrder": false,
|
|
656
656
|
"members": [
|
|
@@ -672,7 +672,7 @@
|
|
|
672
672
|
"startIndex": 1,
|
|
673
673
|
"endIndex": 2
|
|
674
674
|
},
|
|
675
|
-
"releaseTag": "
|
|
675
|
+
"releaseTag": "Public",
|
|
676
676
|
"name": "Buffering"
|
|
677
677
|
},
|
|
678
678
|
{
|
|
@@ -693,7 +693,7 @@
|
|
|
693
693
|
"startIndex": 1,
|
|
694
694
|
"endIndex": 2
|
|
695
695
|
},
|
|
696
|
-
"releaseTag": "
|
|
696
|
+
"releaseTag": "Public",
|
|
697
697
|
"name": "ChangeLevel"
|
|
698
698
|
},
|
|
699
699
|
{
|
|
@@ -714,7 +714,7 @@
|
|
|
714
714
|
"startIndex": 1,
|
|
715
715
|
"endIndex": 2
|
|
716
716
|
},
|
|
717
|
-
"releaseTag": "
|
|
717
|
+
"releaseTag": "Public",
|
|
718
718
|
"name": "DecodedFrames"
|
|
719
719
|
},
|
|
720
720
|
{
|
|
@@ -735,7 +735,7 @@
|
|
|
735
735
|
"startIndex": 1,
|
|
736
736
|
"endIndex": 2
|
|
737
737
|
},
|
|
738
|
-
"releaseTag": "
|
|
738
|
+
"releaseTag": "Public",
|
|
739
739
|
"name": "DroppedFrames"
|
|
740
740
|
},
|
|
741
741
|
{
|
|
@@ -756,7 +756,7 @@
|
|
|
756
756
|
"startIndex": 1,
|
|
757
757
|
"endIndex": 2
|
|
758
758
|
},
|
|
759
|
-
"releaseTag": "
|
|
759
|
+
"releaseTag": "Public",
|
|
760
760
|
"name": "DvrUsage"
|
|
761
761
|
},
|
|
762
762
|
{
|
|
@@ -777,7 +777,7 @@
|
|
|
777
777
|
"startIndex": 1,
|
|
778
778
|
"endIndex": 2
|
|
779
779
|
},
|
|
780
|
-
"releaseTag": "
|
|
780
|
+
"releaseTag": "Public",
|
|
781
781
|
"name": "Error"
|
|
782
782
|
},
|
|
783
783
|
{
|
|
@@ -798,7 +798,7 @@
|
|
|
798
798
|
"startIndex": 1,
|
|
799
799
|
"endIndex": 2
|
|
800
800
|
},
|
|
801
|
-
"releaseTag": "
|
|
801
|
+
"releaseTag": "Public",
|
|
802
802
|
"name": "Fps"
|
|
803
803
|
},
|
|
804
804
|
{
|
|
@@ -819,7 +819,7 @@
|
|
|
819
819
|
"startIndex": 1,
|
|
820
820
|
"endIndex": 2
|
|
821
821
|
},
|
|
822
|
-
"releaseTag": "
|
|
822
|
+
"releaseTag": "Public",
|
|
823
823
|
"name": "Fullscreen"
|
|
824
824
|
},
|
|
825
825
|
{
|
|
@@ -840,7 +840,7 @@
|
|
|
840
840
|
"startIndex": 1,
|
|
841
841
|
"endIndex": 2
|
|
842
842
|
},
|
|
843
|
-
"releaseTag": "
|
|
843
|
+
"releaseTag": "Public",
|
|
844
844
|
"name": "Pause"
|
|
845
845
|
},
|
|
846
846
|
{
|
|
@@ -861,7 +861,7 @@
|
|
|
861
861
|
"startIndex": 1,
|
|
862
862
|
"endIndex": 2
|
|
863
863
|
},
|
|
864
|
-
"releaseTag": "
|
|
864
|
+
"releaseTag": "Public",
|
|
865
865
|
"name": "Play"
|
|
866
866
|
},
|
|
867
867
|
{
|
|
@@ -882,7 +882,7 @@
|
|
|
882
882
|
"startIndex": 1,
|
|
883
883
|
"endIndex": 2
|
|
884
884
|
},
|
|
885
|
-
"releaseTag": "
|
|
885
|
+
"releaseTag": "Public",
|
|
886
886
|
"name": "Seek"
|
|
887
887
|
}
|
|
888
888
|
]
|
|
@@ -890,7 +890,7 @@
|
|
|
890
890
|
{
|
|
891
891
|
"kind": "Enum",
|
|
892
892
|
"canonicalReference": "@gcorevideo/player!ClapprStatsEvents:enum",
|
|
893
|
-
"docComment": "/**\n * @
|
|
893
|
+
"docComment": "/**\n * @public\n */\n",
|
|
894
894
|
"excerptTokens": [
|
|
895
895
|
{
|
|
896
896
|
"kind": "Content",
|
|
@@ -898,7 +898,7 @@
|
|
|
898
898
|
}
|
|
899
899
|
],
|
|
900
900
|
"fileUrlPath": "src/plugins/clappr-stats/types.ts",
|
|
901
|
-
"releaseTag": "
|
|
901
|
+
"releaseTag": "Public",
|
|
902
902
|
"name": "ClapprStatsEvents",
|
|
903
903
|
"preserveMemberOrder": false,
|
|
904
904
|
"members": [
|
|
@@ -920,7 +920,7 @@
|
|
|
920
920
|
"startIndex": 1,
|
|
921
921
|
"endIndex": 2
|
|
922
922
|
},
|
|
923
|
-
"releaseTag": "
|
|
923
|
+
"releaseTag": "Public",
|
|
924
924
|
"name": "REPORT"
|
|
925
925
|
}
|
|
926
926
|
]
|
|
@@ -928,7 +928,7 @@
|
|
|
928
928
|
{
|
|
929
929
|
"kind": "TypeAlias",
|
|
930
930
|
"canonicalReference": "@gcorevideo/player!ClapprStatsMetrics:type",
|
|
931
|
-
"docComment": "/**\n * @
|
|
931
|
+
"docComment": "/**\n * @public\n */\n",
|
|
932
932
|
"excerptTokens": [
|
|
933
933
|
{
|
|
934
934
|
"kind": "Content",
|
|
@@ -1106,7 +1106,7 @@
|
|
|
1106
1106
|
}
|
|
1107
1107
|
],
|
|
1108
1108
|
"fileUrlPath": "src/plugins/clappr-stats/types.ts",
|
|
1109
|
-
"releaseTag": "
|
|
1109
|
+
"releaseTag": "Public",
|
|
1110
1110
|
"name": "ClapprStatsMetrics",
|
|
1111
1111
|
"typeTokenRange": {
|
|
1112
1112
|
"startIndex": 1,
|
|
@@ -1116,7 +1116,7 @@
|
|
|
1116
1116
|
{
|
|
1117
1117
|
"kind": "Interface",
|
|
1118
1118
|
"canonicalReference": "@gcorevideo/player!ClapprStatsSettings:interface",
|
|
1119
|
-
"docComment": "/**\n * Config options for the {@link ClapprStats} plugin\n *\n * @
|
|
1119
|
+
"docComment": "/**\n * Config options for the {@link ClapprStats} plugin\n *\n * @public\n */\n",
|
|
1120
1120
|
"excerptTokens": [
|
|
1121
1121
|
{
|
|
1122
1122
|
"kind": "Content",
|
|
@@ -1124,7 +1124,7 @@
|
|
|
1124
1124
|
}
|
|
1125
1125
|
],
|
|
1126
1126
|
"fileUrlPath": "src/plugins/clappr-stats/ClapprStats.ts",
|
|
1127
|
-
"releaseTag": "
|
|
1127
|
+
"releaseTag": "Public",
|
|
1128
1128
|
"name": "ClapprStatsSettings",
|
|
1129
1129
|
"preserveMemberOrder": false,
|
|
1130
1130
|
"members": [
|
|
@@ -1148,7 +1148,7 @@
|
|
|
1148
1148
|
],
|
|
1149
1149
|
"isReadonly": false,
|
|
1150
1150
|
"isOptional": true,
|
|
1151
|
-
"releaseTag": "
|
|
1151
|
+
"releaseTag": "Public",
|
|
1152
1152
|
"name": "runEach",
|
|
1153
1153
|
"propertyTypeTokenRange": {
|
|
1154
1154
|
"startIndex": 1,
|
|
@@ -1161,7 +1161,7 @@
|
|
|
1161
1161
|
{
|
|
1162
1162
|
"kind": "Class",
|
|
1163
1163
|
"canonicalReference": "@gcorevideo/player!ClickToPause:class",
|
|
1164
|
-
"docComment": "/**\n * A small `PLUGIN` that toggles the playback state on click over the video container\n *\n * @
|
|
1164
|
+
"docComment": "/**\n * A small `PLUGIN` that toggles the playback state on click over the video container\n *\n * @public\n */\n",
|
|
1165
1165
|
"excerptTokens": [
|
|
1166
1166
|
{
|
|
1167
1167
|
"kind": "Content",
|
|
@@ -1178,7 +1178,7 @@
|
|
|
1178
1178
|
}
|
|
1179
1179
|
],
|
|
1180
1180
|
"fileUrlPath": "src/plugins/click-to-pause/ClickToPause.ts",
|
|
1181
|
-
"releaseTag": "
|
|
1181
|
+
"releaseTag": "Public",
|
|
1182
1182
|
"isAbstract": false,
|
|
1183
1183
|
"name": "ClickToPause",
|
|
1184
1184
|
"preserveMemberOrder": false,
|
|
@@ -1192,7 +1192,7 @@
|
|
|
1192
1192
|
{
|
|
1193
1193
|
"kind": "Class",
|
|
1194
1194
|
"canonicalReference": "@gcorevideo/player!Clips:class",
|
|
1195
|
-
"docComment": "/**\n * `PLUGIN` that allows marking up the timeline of the video\n *\n * @remarks\n *\n * The plugin decorates the seekbar with notches to indicate the clips of the video and displays current clip text in the left panel\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @
|
|
1195
|
+
"docComment": "/**\n * `PLUGIN` that allows marking up the timeline of the video\n *\n * @remarks\n *\n * The plugin decorates the seekbar with notches to indicate the clips of the video and displays current clip text in the left panel\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @public\n */\n",
|
|
1196
1196
|
"excerptTokens": [
|
|
1197
1197
|
{
|
|
1198
1198
|
"kind": "Content",
|
|
@@ -1209,7 +1209,7 @@
|
|
|
1209
1209
|
}
|
|
1210
1210
|
],
|
|
1211
1211
|
"fileUrlPath": "src/plugins/clips/Clips.ts",
|
|
1212
|
-
"releaseTag": "
|
|
1212
|
+
"releaseTag": "Public",
|
|
1213
1213
|
"isAbstract": false,
|
|
1214
1214
|
"name": "Clips",
|
|
1215
1215
|
"preserveMemberOrder": false,
|
|
@@ -1242,7 +1242,7 @@
|
|
|
1242
1242
|
"startIndex": 1,
|
|
1243
1243
|
"endIndex": 3
|
|
1244
1244
|
},
|
|
1245
|
-
"releaseTag": "
|
|
1245
|
+
"releaseTag": "Public",
|
|
1246
1246
|
"isProtected": false,
|
|
1247
1247
|
"overloadIndex": 1,
|
|
1248
1248
|
"parameters": [],
|
|
@@ -1273,7 +1273,7 @@
|
|
|
1273
1273
|
"startIndex": 1,
|
|
1274
1274
|
"endIndex": 2
|
|
1275
1275
|
},
|
|
1276
|
-
"releaseTag": "
|
|
1276
|
+
"releaseTag": "Public",
|
|
1277
1277
|
"isProtected": false,
|
|
1278
1278
|
"overloadIndex": 1,
|
|
1279
1279
|
"parameters": [],
|
|
@@ -1304,7 +1304,7 @@
|
|
|
1304
1304
|
"startIndex": 1,
|
|
1305
1305
|
"endIndex": 2
|
|
1306
1306
|
},
|
|
1307
|
-
"releaseTag": "
|
|
1307
|
+
"releaseTag": "Public",
|
|
1308
1308
|
"isProtected": false,
|
|
1309
1309
|
"overloadIndex": 1,
|
|
1310
1310
|
"parameters": [],
|
|
@@ -1344,7 +1344,7 @@
|
|
|
1344
1344
|
"startIndex": 3,
|
|
1345
1345
|
"endIndex": 4
|
|
1346
1346
|
},
|
|
1347
|
-
"releaseTag": "
|
|
1347
|
+
"releaseTag": "Public",
|
|
1348
1348
|
"isProtected": false,
|
|
1349
1349
|
"overloadIndex": 1,
|
|
1350
1350
|
"parameters": [
|
|
@@ -1384,7 +1384,7 @@
|
|
|
1384
1384
|
"startIndex": 1,
|
|
1385
1385
|
"endIndex": 2
|
|
1386
1386
|
},
|
|
1387
|
-
"releaseTag": "
|
|
1387
|
+
"releaseTag": "Public",
|
|
1388
1388
|
"isProtected": false,
|
|
1389
1389
|
"overloadIndex": 1,
|
|
1390
1390
|
"parameters": [],
|
|
@@ -1412,7 +1412,7 @@
|
|
|
1412
1412
|
],
|
|
1413
1413
|
"isReadonly": true,
|
|
1414
1414
|
"isOptional": false,
|
|
1415
|
-
"releaseTag": "
|
|
1415
|
+
"releaseTag": "Public",
|
|
1416
1416
|
"name": "supportedVersion",
|
|
1417
1417
|
"propertyTypeTokenRange": {
|
|
1418
1418
|
"startIndex": 1,
|
|
@@ -1442,7 +1442,7 @@
|
|
|
1442
1442
|
],
|
|
1443
1443
|
"isReadonly": true,
|
|
1444
1444
|
"isOptional": false,
|
|
1445
|
-
"releaseTag": "
|
|
1445
|
+
"releaseTag": "Public",
|
|
1446
1446
|
"name": "version",
|
|
1447
1447
|
"propertyTypeTokenRange": {
|
|
1448
1448
|
"startIndex": 1,
|
|
@@ -1462,7 +1462,7 @@
|
|
|
1462
1462
|
{
|
|
1463
1463
|
"kind": "Interface",
|
|
1464
1464
|
"canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
|
|
1465
|
-
"docComment": "/**\n * Configuration options for the {@link Clips} plugin.\n *\n * @
|
|
1465
|
+
"docComment": "/**\n * Configuration options for the {@link Clips} plugin.\n *\n * @public\n */\n",
|
|
1466
1466
|
"excerptTokens": [
|
|
1467
1467
|
{
|
|
1468
1468
|
"kind": "Content",
|
|
@@ -1470,7 +1470,7 @@
|
|
|
1470
1470
|
}
|
|
1471
1471
|
],
|
|
1472
1472
|
"fileUrlPath": "src/plugins/clips/Clips.ts",
|
|
1473
|
-
"releaseTag": "
|
|
1473
|
+
"releaseTag": "Public",
|
|
1474
1474
|
"name": "ClipsPluginSettings",
|
|
1475
1475
|
"preserveMemberOrder": false,
|
|
1476
1476
|
"members": [
|
|
@@ -1494,7 +1494,7 @@
|
|
|
1494
1494
|
],
|
|
1495
1495
|
"isReadonly": false,
|
|
1496
1496
|
"isOptional": false,
|
|
1497
|
-
"releaseTag": "
|
|
1497
|
+
"releaseTag": "Public",
|
|
1498
1498
|
"name": "text",
|
|
1499
1499
|
"propertyTypeTokenRange": {
|
|
1500
1500
|
"startIndex": 1,
|
|
@@ -1507,7 +1507,7 @@
|
|
|
1507
1507
|
{
|
|
1508
1508
|
"kind": "Class",
|
|
1509
1509
|
"canonicalReference": "@gcorevideo/player!ClosedCaptions:class",
|
|
1510
|
-
"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 * @
|
|
1510
|
+
"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 * Known issues:\n *\n * 1. When media source changes, the subtitles tracks aren't reloaded. Possible solution: use `playback.recycleVideo = false` {@link PlayerConfig | main config option}, which will force new video element creation every time media source changes. However, this may lead to other issues, such as autoplay not working (after media source has been changed). {@link https://github.com/video-dev/hls.js/issues/2198 | related discussion}\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 * @public\n */\n",
|
|
1511
1511
|
"excerptTokens": [
|
|
1512
1512
|
{
|
|
1513
1513
|
"kind": "Content",
|
|
@@ -1524,7 +1524,7 @@
|
|
|
1524
1524
|
}
|
|
1525
1525
|
],
|
|
1526
1526
|
"fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
|
|
1527
|
-
"releaseTag": "
|
|
1527
|
+
"releaseTag": "Public",
|
|
1528
1528
|
"isAbstract": false,
|
|
1529
1529
|
"name": "ClosedCaptions",
|
|
1530
1530
|
"preserveMemberOrder": false,
|
|
@@ -1552,7 +1552,7 @@
|
|
|
1552
1552
|
"startIndex": 1,
|
|
1553
1553
|
"endIndex": 2
|
|
1554
1554
|
},
|
|
1555
|
-
"releaseTag": "
|
|
1555
|
+
"releaseTag": "Public",
|
|
1556
1556
|
"isProtected": false,
|
|
1557
1557
|
"overloadIndex": 1,
|
|
1558
1558
|
"parameters": [],
|
|
@@ -1583,7 +1583,7 @@
|
|
|
1583
1583
|
"startIndex": 1,
|
|
1584
1584
|
"endIndex": 2
|
|
1585
1585
|
},
|
|
1586
|
-
"releaseTag": "
|
|
1586
|
+
"releaseTag": "Public",
|
|
1587
1587
|
"isProtected": false,
|
|
1588
1588
|
"overloadIndex": 1,
|
|
1589
1589
|
"parameters": [],
|
|
@@ -1601,7 +1601,7 @@
|
|
|
1601
1601
|
{
|
|
1602
1602
|
"kind": "TypeAlias",
|
|
1603
1603
|
"canonicalReference": "@gcorevideo/player!ClosedCaptionsPluginSettings:type",
|
|
1604
|
-
"docComment": "/**\n * Configuration options for the {@link ClosedCaptions} plugin.\n *\n * @
|
|
1604
|
+
"docComment": "/**\n * Configuration options for the {@link ClosedCaptions} plugin.\n *\n * @public\n */\n",
|
|
1605
1605
|
"excerptTokens": [
|
|
1606
1606
|
{
|
|
1607
1607
|
"kind": "Content",
|
|
@@ -1617,7 +1617,7 @@
|
|
|
1617
1617
|
}
|
|
1618
1618
|
],
|
|
1619
1619
|
"fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
|
|
1620
|
-
"releaseTag": "
|
|
1620
|
+
"releaseTag": "Public",
|
|
1621
1621
|
"name": "ClosedCaptionsPluginSettings",
|
|
1622
1622
|
"typeTokenRange": {
|
|
1623
1623
|
"startIndex": 1,
|
|
@@ -1627,7 +1627,7 @@
|
|
|
1627
1627
|
{
|
|
1628
1628
|
"kind": "Class",
|
|
1629
1629
|
"canonicalReference": "@gcorevideo/player!CmcdConfig:class",
|
|
1630
|
-
"docComment": "/**\n * A `PLUGIN` that configures {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf | CMCD} for playback\n *\n * @remarks\n *\n * Configuration options - {@link CmcdConfigOptions}.\n *\n * @example\n * ```ts\n * import { CmcdConfig } from '@gcorevideo/player'\n * Player.registerPlugin(CmcdConfig)\n *\n * const player = new Player({\n * source: 'https://example.com/video.mp4',\n * cmcd: {\n * sessionId: '1234567890',\n * contentId: 'f572d396fae9206628714fb2ce00f72e94f2258f',\n * },\n * })\n * ```\n *\n * @
|
|
1630
|
+
"docComment": "/**\n * A `PLUGIN` that configures {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf | CMCD} for playback\n *\n * @remarks\n *\n * Configuration options - {@link CmcdConfigOptions}.\n *\n * @example\n * ```ts\n * import { CmcdConfig } from '@gcorevideo/player'\n * Player.registerPlugin(CmcdConfig)\n *\n * const player = new Player({\n * source: 'https://example.com/video.mp4',\n * cmcd: {\n * sessionId: '1234567890',\n * contentId: 'f572d396fae9206628714fb2ce00f72e94f2258f',\n * },\n * })\n * ```\n *\n * @public\n */\n",
|
|
1631
1631
|
"excerptTokens": [
|
|
1632
1632
|
{
|
|
1633
1633
|
"kind": "Content",
|
|
@@ -1644,7 +1644,7 @@
|
|
|
1644
1644
|
}
|
|
1645
1645
|
],
|
|
1646
1646
|
"fileUrlPath": "src/plugins/cmcd-config/CmcdConfig.ts",
|
|
1647
|
-
"releaseTag": "
|
|
1647
|
+
"releaseTag": "Public",
|
|
1648
1648
|
"isAbstract": false,
|
|
1649
1649
|
"name": "CmcdConfig",
|
|
1650
1650
|
"preserveMemberOrder": false,
|
|
@@ -1668,7 +1668,7 @@
|
|
|
1668
1668
|
"text": ");"
|
|
1669
1669
|
}
|
|
1670
1670
|
],
|
|
1671
|
-
"releaseTag": "
|
|
1671
|
+
"releaseTag": "Public",
|
|
1672
1672
|
"isProtected": false,
|
|
1673
1673
|
"overloadIndex": 1,
|
|
1674
1674
|
"parameters": [
|
|
@@ -1705,7 +1705,7 @@
|
|
|
1705
1705
|
"startIndex": 1,
|
|
1706
1706
|
"endIndex": 2
|
|
1707
1707
|
},
|
|
1708
|
-
"releaseTag": "
|
|
1708
|
+
"releaseTag": "Public",
|
|
1709
1709
|
"isProtected": false,
|
|
1710
1710
|
"overloadIndex": 1,
|
|
1711
1711
|
"parameters": [],
|
|
@@ -1723,7 +1723,7 @@
|
|
|
1723
1723
|
{
|
|
1724
1724
|
"kind": "Interface",
|
|
1725
1725
|
"canonicalReference": "@gcorevideo/player!CmcdConfigOptions:interface",
|
|
1726
|
-
"docComment": "/**\n * Config options for the {@link CmcdConfig} plugin\n *\n * @
|
|
1726
|
+
"docComment": "/**\n * Config options for the {@link CmcdConfig} plugin\n *\n * @public\n */\n",
|
|
1727
1727
|
"excerptTokens": [
|
|
1728
1728
|
{
|
|
1729
1729
|
"kind": "Content",
|
|
@@ -1731,7 +1731,7 @@
|
|
|
1731
1731
|
}
|
|
1732
1732
|
],
|
|
1733
1733
|
"fileUrlPath": "src/plugins/cmcd-config/CmcdConfig.ts",
|
|
1734
|
-
"releaseTag": "
|
|
1734
|
+
"releaseTag": "Public",
|
|
1735
1735
|
"name": "CmcdConfigOptions",
|
|
1736
1736
|
"preserveMemberOrder": false,
|
|
1737
1737
|
"members": [
|
|
@@ -1755,7 +1755,7 @@
|
|
|
1755
1755
|
],
|
|
1756
1756
|
"isReadonly": false,
|
|
1757
1757
|
"isOptional": true,
|
|
1758
|
-
"releaseTag": "
|
|
1758
|
+
"releaseTag": "Public",
|
|
1759
1759
|
"name": "contentId",
|
|
1760
1760
|
"propertyTypeTokenRange": {
|
|
1761
1761
|
"startIndex": 1,
|
|
@@ -1782,7 +1782,7 @@
|
|
|
1782
1782
|
],
|
|
1783
1783
|
"isReadonly": false,
|
|
1784
1784
|
"isOptional": true,
|
|
1785
|
-
"releaseTag": "
|
|
1785
|
+
"releaseTag": "Public",
|
|
1786
1786
|
"name": "sessionId",
|
|
1787
1787
|
"propertyTypeTokenRange": {
|
|
1788
1788
|
"startIndex": 1,
|
|
@@ -2055,7 +2055,7 @@
|
|
|
2055
2055
|
{
|
|
2056
2056
|
"kind": "Class",
|
|
2057
2057
|
"canonicalReference": "@gcorevideo/player!DvrControls:class",
|
|
2058
|
-
"docComment": "/**\n * `PLUGIN` that adds the DVR controls to the media control UI\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * The plugin renders live stream indicator. If DVR is enabled, the indicator shows whether the current position is at the live edge of the stream or not. In the latter case, the indicator can be clicked to seek to the live edge.\n *\n * @
|
|
2058
|
+
"docComment": "/**\n * `PLUGIN` that adds the DVR controls to the media control UI\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * The plugin renders live stream indicator. If DVR is enabled, the indicator shows whether the current position is at the live edge of the stream or not. In the latter case, the indicator can be clicked to seek to the live edge.\n *\n * @public\n */\n",
|
|
2059
2059
|
"excerptTokens": [
|
|
2060
2060
|
{
|
|
2061
2061
|
"kind": "Content",
|
|
@@ -2072,7 +2072,7 @@
|
|
|
2072
2072
|
}
|
|
2073
2073
|
],
|
|
2074
2074
|
"fileUrlPath": "src/plugins/dvr-controls/DvrControls.ts",
|
|
2075
|
-
"releaseTag": "
|
|
2075
|
+
"releaseTag": "Public",
|
|
2076
2076
|
"isAbstract": false,
|
|
2077
2077
|
"name": "DvrControls",
|
|
2078
2078
|
"preserveMemberOrder": false,
|
|
@@ -2195,7 +2195,7 @@
|
|
|
2195
2195
|
{
|
|
2196
2196
|
"kind": "Enum",
|
|
2197
2197
|
"canonicalReference": "@gcorevideo/player!ExtendedEvents:enum",
|
|
2198
|
-
"docComment": "/**\n * Extended events for the {@link MediaControl} plugin\n *\n * @
|
|
2198
|
+
"docComment": "/**\n * Extended events for the {@link MediaControl} plugin\n *\n * @public\n */\n",
|
|
2199
2199
|
"excerptTokens": [
|
|
2200
2200
|
{
|
|
2201
2201
|
"kind": "Content",
|
|
@@ -2203,7 +2203,7 @@
|
|
|
2203
2203
|
}
|
|
2204
2204
|
],
|
|
2205
2205
|
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
2206
|
-
"releaseTag": "
|
|
2206
|
+
"releaseTag": "Public",
|
|
2207
2207
|
"name": "ExtendedEvents",
|
|
2208
2208
|
"preserveMemberOrder": false,
|
|
2209
2209
|
"members": [
|
|
@@ -2225,7 +2225,7 @@
|
|
|
2225
2225
|
"startIndex": 1,
|
|
2226
2226
|
"endIndex": 2
|
|
2227
2227
|
},
|
|
2228
|
-
"releaseTag": "
|
|
2228
|
+
"releaseTag": "Public",
|
|
2229
2229
|
"name": "MEDIACONTROL_MENU_COLLAPSE"
|
|
2230
2230
|
},
|
|
2231
2231
|
{
|
|
@@ -2246,7 +2246,7 @@
|
|
|
2246
2246
|
"startIndex": 1,
|
|
2247
2247
|
"endIndex": 2
|
|
2248
2248
|
},
|
|
2249
|
-
"releaseTag": "
|
|
2249
|
+
"releaseTag": "Public",
|
|
2250
2250
|
"name": "MEDIACONTROL_VOLUME"
|
|
2251
2251
|
}
|
|
2252
2252
|
]
|
|
@@ -2254,7 +2254,7 @@
|
|
|
2254
2254
|
{
|
|
2255
2255
|
"kind": "Class",
|
|
2256
2256
|
"canonicalReference": "@gcorevideo/player!Favicon:class",
|
|
2257
|
-
"docComment": "/**\n * `PLUGIN` that changes the favicon according to the player's state.\n *\n * @remarks\n *\n * There are three states: stopped, playing and paused.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Favicon` class.\n *\n * @
|
|
2257
|
+
"docComment": "/**\n * `PLUGIN` that changes the favicon according to the player's state.\n *\n * @remarks\n *\n * There are three states: stopped, playing and paused.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Favicon` class.\n *\n * @public\n */\n",
|
|
2258
2258
|
"excerptTokens": [
|
|
2259
2259
|
{
|
|
2260
2260
|
"kind": "Content",
|
|
@@ -2271,7 +2271,7 @@
|
|
|
2271
2271
|
}
|
|
2272
2272
|
],
|
|
2273
2273
|
"fileUrlPath": "src/plugins/favicon/Favicon.ts",
|
|
2274
|
-
"releaseTag": "
|
|
2274
|
+
"releaseTag": "Public",
|
|
2275
2275
|
"isAbstract": false,
|
|
2276
2276
|
"name": "Favicon",
|
|
2277
2277
|
"preserveMemberOrder": false,
|
|
@@ -2285,7 +2285,7 @@
|
|
|
2285
2285
|
{
|
|
2286
2286
|
"kind": "Interface",
|
|
2287
2287
|
"canonicalReference": "@gcorevideo/player!FaviconPluginSettings:interface",
|
|
2288
|
-
"docComment": "/**\n * @
|
|
2288
|
+
"docComment": "/**\n * @public\n */\n",
|
|
2289
2289
|
"excerptTokens": [
|
|
2290
2290
|
{
|
|
2291
2291
|
"kind": "Content",
|
|
@@ -2293,7 +2293,7 @@
|
|
|
2293
2293
|
}
|
|
2294
2294
|
],
|
|
2295
2295
|
"fileUrlPath": "src/plugins/favicon/Favicon.ts",
|
|
2296
|
-
"releaseTag": "
|
|
2296
|
+
"releaseTag": "Public",
|
|
2297
2297
|
"name": "FaviconPluginSettings",
|
|
2298
2298
|
"preserveMemberOrder": false,
|
|
2299
2299
|
"members": [
|
|
@@ -2317,7 +2317,7 @@
|
|
|
2317
2317
|
],
|
|
2318
2318
|
"isReadonly": false,
|
|
2319
2319
|
"isOptional": true,
|
|
2320
|
-
"releaseTag": "
|
|
2320
|
+
"releaseTag": "Public",
|
|
2321
2321
|
"name": "faviconColor",
|
|
2322
2322
|
"propertyTypeTokenRange": {
|
|
2323
2323
|
"startIndex": 1,
|
|
@@ -2330,7 +2330,7 @@
|
|
|
2330
2330
|
{
|
|
2331
2331
|
"kind": "Enum",
|
|
2332
2332
|
"canonicalReference": "@gcorevideo/player!GearEvents:enum",
|
|
2333
|
-
"docComment": "/**\n * Events triggered by the plugin\n *\n * @
|
|
2333
|
+
"docComment": "/**\n * Events triggered by the plugin\n *\n * @public\n */\n",
|
|
2334
2334
|
"excerptTokens": [
|
|
2335
2335
|
{
|
|
2336
2336
|
"kind": "Content",
|
|
@@ -2338,7 +2338,7 @@
|
|
|
2338
2338
|
}
|
|
2339
2339
|
],
|
|
2340
2340
|
"fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
|
|
2341
|
-
"releaseTag": "
|
|
2341
|
+
"releaseTag": "Public",
|
|
2342
2342
|
"name": "GearEvents",
|
|
2343
2343
|
"preserveMemberOrder": false,
|
|
2344
2344
|
"members": [
|
|
@@ -2360,7 +2360,7 @@
|
|
|
2360
2360
|
"startIndex": 1,
|
|
2361
2361
|
"endIndex": 2
|
|
2362
2362
|
},
|
|
2363
|
-
"releaseTag": "
|
|
2363
|
+
"releaseTag": "Public",
|
|
2364
2364
|
"name": "RENDERED"
|
|
2365
2365
|
}
|
|
2366
2366
|
]
|
|
@@ -3478,7 +3478,7 @@
|
|
|
3478
3478
|
{
|
|
3479
3479
|
"kind": "Method",
|
|
3480
3480
|
"canonicalReference": "@gcorevideo/player!MediaControl.defaultSettings:member(1)",
|
|
3481
|
-
"docComment": "/**\n * @
|
|
3481
|
+
"docComment": "/**\n * @remarks\n *\n * The method can be used to change the default dashboard layout, for example, removing the standard UI elements\n *\n * @returns Default media control layout settings\n *\n * @example\n * ```ts\n * const settings = MediaControl.defaultSettings()\n * settings.left = settings.filter(item => item !== 'playpause' && item !== 'playstop')\n * ...\n * new Player({\n * mediaControl: settings,\n * })\n * ```\n *\n */\n",
|
|
3482
3482
|
"excerptTokens": [
|
|
3483
3483
|
{
|
|
3484
3484
|
"kind": "Content",
|
|
@@ -3661,6 +3661,37 @@
|
|
|
3661
3661
|
"isAbstract": false,
|
|
3662
3662
|
"name": "getAvailableHeight"
|
|
3663
3663
|
},
|
|
3664
|
+
{
|
|
3665
|
+
"kind": "Method",
|
|
3666
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#getAvailablePopupHeight:member(1)",
|
|
3667
|
+
"docComment": "/**\n * @returns Vertical space available to render a popup menu\n */\n",
|
|
3668
|
+
"excerptTokens": [
|
|
3669
|
+
{
|
|
3670
|
+
"kind": "Content",
|
|
3671
|
+
"text": "getAvailablePopupHeight(): "
|
|
3672
|
+
},
|
|
3673
|
+
{
|
|
3674
|
+
"kind": "Content",
|
|
3675
|
+
"text": "number"
|
|
3676
|
+
},
|
|
3677
|
+
{
|
|
3678
|
+
"kind": "Content",
|
|
3679
|
+
"text": ";"
|
|
3680
|
+
}
|
|
3681
|
+
],
|
|
3682
|
+
"isStatic": false,
|
|
3683
|
+
"returnTypeTokenRange": {
|
|
3684
|
+
"startIndex": 1,
|
|
3685
|
+
"endIndex": 2
|
|
3686
|
+
},
|
|
3687
|
+
"releaseTag": "Beta",
|
|
3688
|
+
"isProtected": false,
|
|
3689
|
+
"overloadIndex": 1,
|
|
3690
|
+
"parameters": [],
|
|
3691
|
+
"isOptional": false,
|
|
3692
|
+
"isAbstract": false,
|
|
3693
|
+
"name": "getAvailablePopupHeight"
|
|
3694
|
+
},
|
|
3664
3695
|
{
|
|
3665
3696
|
"kind": "Method",
|
|
3666
3697
|
"canonicalReference": "@gcorevideo/player!MediaControl#mount:member(1)",
|
|
@@ -4046,32 +4077,6 @@
|
|
|
4046
4077
|
"endIndex": 2
|
|
4047
4078
|
}
|
|
4048
4079
|
},
|
|
4049
|
-
{
|
|
4050
|
-
"kind": "TypeAlias",
|
|
4051
|
-
"canonicalReference": "@gcorevideo/player!MediaControlPluginSettings:type",
|
|
4052
|
-
"docComment": "",
|
|
4053
|
-
"excerptTokens": [
|
|
4054
|
-
{
|
|
4055
|
-
"kind": "Content",
|
|
4056
|
-
"text": "export type MediaControlPluginSettings = "
|
|
4057
|
-
},
|
|
4058
|
-
{
|
|
4059
|
-
"kind": "Content",
|
|
4060
|
-
"text": "{\n hideMediaControlDelay?: number;\n}"
|
|
4061
|
-
},
|
|
4062
|
-
{
|
|
4063
|
-
"kind": "Content",
|
|
4064
|
-
"text": ";"
|
|
4065
|
-
}
|
|
4066
|
-
],
|
|
4067
|
-
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
4068
|
-
"releaseTag": "Public",
|
|
4069
|
-
"name": "MediaControlPluginSettings",
|
|
4070
|
-
"typeTokenRange": {
|
|
4071
|
-
"startIndex": 1,
|
|
4072
|
-
"endIndex": 2
|
|
4073
|
-
}
|
|
4074
|
-
},
|
|
4075
4080
|
{
|
|
4076
4081
|
"kind": "TypeAlias",
|
|
4077
4082
|
"canonicalReference": "@gcorevideo/player!MediaControlSettings:type",
|
|
@@ -4154,7 +4159,7 @@
|
|
|
4154
4159
|
{
|
|
4155
4160
|
"kind": "TypeAlias",
|
|
4156
4161
|
"canonicalReference": "@gcorevideo/player!MenuOption:type",
|
|
4157
|
-
"docComment": "/**\n * @
|
|
4162
|
+
"docComment": "/**\n * @public\n */\n",
|
|
4158
4163
|
"excerptTokens": [
|
|
4159
4164
|
{
|
|
4160
4165
|
"kind": "Content",
|
|
@@ -4170,7 +4175,7 @@
|
|
|
4170
4175
|
}
|
|
4171
4176
|
],
|
|
4172
4177
|
"fileUrlPath": "src/plugins/context-menu/ContextMenu.ts",
|
|
4173
|
-
"releaseTag": "
|
|
4178
|
+
"releaseTag": "Public",
|
|
4174
4179
|
"name": "MenuOption",
|
|
4175
4180
|
"typeTokenRange": {
|
|
4176
4181
|
"startIndex": 1,
|
|
@@ -4582,7 +4587,7 @@
|
|
|
4582
4587
|
{
|
|
4583
4588
|
"kind": "Class",
|
|
4584
4589
|
"canonicalReference": "@gcorevideo/player!NerdStats:class",
|
|
4585
|
-
"docComment": "/**\n * `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link BottomGear} - where the button is attached\n *\n * - {@link ClapprStats} - to get the metrics from\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 * @
|
|
4590
|
+
"docComment": "/**\n * `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link BottomGear} - where the button is attached\n *\n * - {@link ClapprStats} - to get the metrics from\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 * @public\n */\n",
|
|
4586
4591
|
"excerptTokens": [
|
|
4587
4592
|
{
|
|
4588
4593
|
"kind": "Content",
|
|
@@ -4599,7 +4604,7 @@
|
|
|
4599
4604
|
}
|
|
4600
4605
|
],
|
|
4601
4606
|
"fileUrlPath": "src/plugins/clappr-nerd-stats/NerdStats.ts",
|
|
4602
|
-
"releaseTag": "
|
|
4607
|
+
"releaseTag": "Public",
|
|
4603
4608
|
"isAbstract": false,
|
|
4604
4609
|
"name": "NerdStats",
|
|
4605
4610
|
"preserveMemberOrder": false,
|
|
@@ -4623,7 +4628,7 @@
|
|
|
4623
4628
|
"text": ");"
|
|
4624
4629
|
}
|
|
4625
4630
|
],
|
|
4626
|
-
"releaseTag": "
|
|
4631
|
+
"releaseTag": "Public",
|
|
4627
4632
|
"isProtected": false,
|
|
4628
4633
|
"overloadIndex": 1,
|
|
4629
4634
|
"parameters": [
|
|
@@ -4647,7 +4652,7 @@
|
|
|
4647
4652
|
{
|
|
4648
4653
|
"kind": "Class",
|
|
4649
4654
|
"canonicalReference": "@gcorevideo/player!PictureInPicture:class",
|
|
4650
|
-
"docComment": "/**\n * `PLUGIN` that enables picture
|
|
4655
|
+
"docComment": "/**\n * `PLUGIN` that enables picture-in-picture mode.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * It renders a button to toggle picture-in-picture mode in the media control UI.\n *\n * @public\n */\n",
|
|
4651
4656
|
"excerptTokens": [
|
|
4652
4657
|
{
|
|
4653
4658
|
"kind": "Content",
|
|
@@ -4664,7 +4669,7 @@
|
|
|
4664
4669
|
}
|
|
4665
4670
|
],
|
|
4666
4671
|
"fileUrlPath": "src/plugins/picture-in-picture/PictureInPicture.ts",
|
|
4667
|
-
"releaseTag": "
|
|
4672
|
+
"releaseTag": "Public",
|
|
4668
4673
|
"isAbstract": false,
|
|
4669
4674
|
"name": "PictureInPicture",
|
|
4670
4675
|
"preserveMemberOrder": false,
|
|
@@ -4689,7 +4694,7 @@
|
|
|
4689
4694
|
],
|
|
4690
4695
|
"isReadonly": true,
|
|
4691
4696
|
"isOptional": false,
|
|
4692
|
-
"releaseTag": "
|
|
4697
|
+
"releaseTag": "Public",
|
|
4693
4698
|
"name": "attributes",
|
|
4694
4699
|
"propertyTypeTokenRange": {
|
|
4695
4700
|
"startIndex": 1,
|
|
@@ -5090,7 +5095,7 @@
|
|
|
5090
5095
|
{
|
|
5091
5096
|
"kind": "TypeAlias",
|
|
5092
5097
|
"canonicalReference": "@gcorevideo/player!PlaybackRateOption:type",
|
|
5093
|
-
"docComment": "/**\n * @
|
|
5098
|
+
"docComment": "/**\n * @public\n */\n",
|
|
5094
5099
|
"excerptTokens": [
|
|
5095
5100
|
{
|
|
5096
5101
|
"kind": "Content",
|
|
@@ -5106,7 +5111,7 @@
|
|
|
5106
5111
|
}
|
|
5107
5112
|
],
|
|
5108
5113
|
"fileUrlPath": "src/plugins/playback-rate/PlaybackRate.ts",
|
|
5109
|
-
"releaseTag": "
|
|
5114
|
+
"releaseTag": "Public",
|
|
5110
5115
|
"name": "PlaybackRateOption",
|
|
5111
5116
|
"typeTokenRange": {
|
|
5112
5117
|
"startIndex": 1,
|
|
@@ -5116,7 +5121,7 @@
|
|
|
5116
5121
|
{
|
|
5117
5122
|
"kind": "TypeAlias",
|
|
5118
5123
|
"canonicalReference": "@gcorevideo/player!PlaybackRateSettings:type",
|
|
5119
|
-
"docComment": "/**\n * @
|
|
5124
|
+
"docComment": "/**\n * @public\n */\n",
|
|
5120
5125
|
"excerptTokens": [
|
|
5121
5126
|
{
|
|
5122
5127
|
"kind": "Content",
|
|
@@ -5141,7 +5146,7 @@
|
|
|
5141
5146
|
}
|
|
5142
5147
|
],
|
|
5143
5148
|
"fileUrlPath": "src/plugins/playback-rate/PlaybackRate.ts",
|
|
5144
|
-
"releaseTag": "
|
|
5149
|
+
"releaseTag": "Public",
|
|
5145
5150
|
"name": "PlaybackRateSettings",
|
|
5146
5151
|
"typeTokenRange": {
|
|
5147
5152
|
"startIndex": 1,
|
|
@@ -7156,7 +7161,7 @@
|
|
|
7156
7161
|
{
|
|
7157
7162
|
"kind": "Class",
|
|
7158
7163
|
"canonicalReference": "@gcorevideo/player!Poster:class",
|
|
7159
|
-
"docComment": "/**\n * `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped\n *\n * @remarks\n *\n * When the playback is stopped or not yet started, the media control UI is disabled and hidden. Media control gets activated once the metadata is loaded after playback is initiated. This plugin displays a big play button on top of the poster image to allow user to start playback. Note that the poster image, if specified via the player config, will be used to update video element's poster attribute by the HTML5-video-based playback module.\n *\n * Configuration options - {@link PosterPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * ...\n * poster: {\n * showForNoOp: true,\n * url: 'https://via.placeholder.com/150.png',\n * }\n * })\n * ```\n *\n * @
|
|
7164
|
+
"docComment": "/**\n * `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped\n *\n * @remarks\n *\n * When the playback is stopped or not yet started, the media control UI is disabled and hidden. Media control gets activated once the metadata is loaded after playback is initiated. This plugin displays a big play button on top of the poster image to allow user to start playback. Note that the poster image, if specified via the player config, will be used to update video element's poster attribute by the HTML5-video-based playback module.\n *\n * Configuration options - {@link PosterPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * ...\n * poster: {\n * showForNoOp: true,\n * url: 'https://via.placeholder.com/150.png',\n * }\n * })\n * ```\n *\n * @public\n */\n",
|
|
7160
7165
|
"excerptTokens": [
|
|
7161
7166
|
{
|
|
7162
7167
|
"kind": "Content",
|
|
@@ -7173,7 +7178,7 @@
|
|
|
7173
7178
|
}
|
|
7174
7179
|
],
|
|
7175
7180
|
"fileUrlPath": "src/plugins/poster/Poster.ts",
|
|
7176
|
-
"releaseTag": "
|
|
7181
|
+
"releaseTag": "Public",
|
|
7177
7182
|
"isAbstract": false,
|
|
7178
7183
|
"name": "Poster",
|
|
7179
7184
|
"preserveMemberOrder": false,
|
|
@@ -7201,7 +7206,7 @@
|
|
|
7201
7206
|
"startIndex": 1,
|
|
7202
7207
|
"endIndex": 2
|
|
7203
7208
|
},
|
|
7204
|
-
"releaseTag": "
|
|
7209
|
+
"releaseTag": "Public",
|
|
7205
7210
|
"isProtected": false,
|
|
7206
7211
|
"overloadIndex": 1,
|
|
7207
7212
|
"parameters": [],
|
|
@@ -7232,7 +7237,7 @@
|
|
|
7232
7237
|
"startIndex": 1,
|
|
7233
7238
|
"endIndex": 2
|
|
7234
7239
|
},
|
|
7235
|
-
"releaseTag": "
|
|
7240
|
+
"releaseTag": "Public",
|
|
7236
7241
|
"isProtected": false,
|
|
7237
7242
|
"overloadIndex": 1,
|
|
7238
7243
|
"parameters": [],
|
|
@@ -7250,7 +7255,7 @@
|
|
|
7250
7255
|
{
|
|
7251
7256
|
"kind": "Interface",
|
|
7252
7257
|
"canonicalReference": "@gcorevideo/player!PosterPluginSettings:interface",
|
|
7253
|
-
"docComment": "/**\n * Config options for the {@link Poster} plugin\n *\n * @
|
|
7258
|
+
"docComment": "/**\n * Config options for the {@link Poster} plugin\n *\n * @public\n */\n",
|
|
7254
7259
|
"excerptTokens": [
|
|
7255
7260
|
{
|
|
7256
7261
|
"kind": "Content",
|
|
@@ -7258,7 +7263,7 @@
|
|
|
7258
7263
|
}
|
|
7259
7264
|
],
|
|
7260
7265
|
"fileUrlPath": "src/plugins/poster/Poster.ts",
|
|
7261
|
-
"releaseTag": "
|
|
7266
|
+
"releaseTag": "Public",
|
|
7262
7267
|
"name": "PosterPluginSettings",
|
|
7263
7268
|
"preserveMemberOrder": false,
|
|
7264
7269
|
"members": [
|
|
@@ -7282,7 +7287,7 @@
|
|
|
7282
7287
|
],
|
|
7283
7288
|
"isReadonly": false,
|
|
7284
7289
|
"isOptional": true,
|
|
7285
|
-
"releaseTag": "
|
|
7290
|
+
"releaseTag": "Public",
|
|
7286
7291
|
"name": "custom",
|
|
7287
7292
|
"propertyTypeTokenRange": {
|
|
7288
7293
|
"startIndex": 1,
|
|
@@ -7309,7 +7314,7 @@
|
|
|
7309
7314
|
],
|
|
7310
7315
|
"isReadonly": false,
|
|
7311
7316
|
"isOptional": true,
|
|
7312
|
-
"releaseTag": "
|
|
7317
|
+
"releaseTag": "Public",
|
|
7313
7318
|
"name": "showForNoOp",
|
|
7314
7319
|
"propertyTypeTokenRange": {
|
|
7315
7320
|
"startIndex": 1,
|
|
@@ -7336,7 +7341,7 @@
|
|
|
7336
7341
|
],
|
|
7337
7342
|
"isReadonly": false,
|
|
7338
7343
|
"isOptional": true,
|
|
7339
|
-
"releaseTag": "
|
|
7344
|
+
"releaseTag": "Public",
|
|
7340
7345
|
"name": "showOnVideoEnd",
|
|
7341
7346
|
"propertyTypeTokenRange": {
|
|
7342
7347
|
"startIndex": 1,
|
|
@@ -7363,7 +7368,7 @@
|
|
|
7363
7368
|
],
|
|
7364
7369
|
"isReadonly": false,
|
|
7365
7370
|
"isOptional": true,
|
|
7366
|
-
"releaseTag": "
|
|
7371
|
+
"releaseTag": "Public",
|
|
7367
7372
|
"name": "url",
|
|
7368
7373
|
"propertyTypeTokenRange": {
|
|
7369
7374
|
"startIndex": 1,
|
|
@@ -7502,7 +7507,7 @@
|
|
|
7502
7507
|
{
|
|
7503
7508
|
"kind": "Class",
|
|
7504
7509
|
"canonicalReference": "@gcorevideo/player!QualityLevels:class",
|
|
7505
|
-
"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 QualityLevelsPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * qualityLevels: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @
|
|
7510
|
+
"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 QualityLevelsPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * qualityLevels: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @public\n */\n",
|
|
7506
7511
|
"excerptTokens": [
|
|
7507
7512
|
{
|
|
7508
7513
|
"kind": "Content",
|
|
@@ -7519,7 +7524,7 @@
|
|
|
7519
7524
|
}
|
|
7520
7525
|
],
|
|
7521
7526
|
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
7522
|
-
"releaseTag": "
|
|
7527
|
+
"releaseTag": "Public",
|
|
7523
7528
|
"isAbstract": false,
|
|
7524
7529
|
"name": "QualityLevels",
|
|
7525
7530
|
"preserveMemberOrder": false,
|
|
@@ -7544,7 +7549,7 @@
|
|
|
7544
7549
|
],
|
|
7545
7550
|
"isReadonly": true,
|
|
7546
7551
|
"isOptional": false,
|
|
7547
|
-
"releaseTag": "
|
|
7552
|
+
"releaseTag": "Public",
|
|
7548
7553
|
"name": "events",
|
|
7549
7554
|
"propertyTypeTokenRange": {
|
|
7550
7555
|
"startIndex": 1,
|
|
@@ -7564,7 +7569,7 @@
|
|
|
7564
7569
|
{
|
|
7565
7570
|
"kind": "Interface",
|
|
7566
7571
|
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings:interface",
|
|
7567
|
-
"docComment": "/**\n * Configuration options for the {@link QualityLevels} plugin.\n *\n * @
|
|
7572
|
+
"docComment": "/**\n * Configuration options for the {@link QualityLevels} plugin.\n *\n * @public\n */\n",
|
|
7568
7573
|
"excerptTokens": [
|
|
7569
7574
|
{
|
|
7570
7575
|
"kind": "Content",
|
|
@@ -7572,7 +7577,7 @@
|
|
|
7572
7577
|
}
|
|
7573
7578
|
],
|
|
7574
7579
|
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
7575
|
-
"releaseTag": "
|
|
7580
|
+
"releaseTag": "Public",
|
|
7576
7581
|
"name": "QualityLevelsPluginSettings",
|
|
7577
7582
|
"preserveMemberOrder": false,
|
|
7578
7583
|
"members": [
|
|
@@ -7601,7 +7606,7 @@
|
|
|
7601
7606
|
],
|
|
7602
7607
|
"isReadonly": false,
|
|
7603
7608
|
"isOptional": true,
|
|
7604
|
-
"releaseTag": "
|
|
7609
|
+
"releaseTag": "Public",
|
|
7605
7610
|
"name": "labels",
|
|
7606
7611
|
"propertyTypeTokenRange": {
|
|
7607
7612
|
"startIndex": 1,
|
|
@@ -7628,7 +7633,7 @@
|
|
|
7628
7633
|
],
|
|
7629
7634
|
"isReadonly": false,
|
|
7630
7635
|
"isOptional": true,
|
|
7631
|
-
"releaseTag": "
|
|
7636
|
+
"releaseTag": "Public",
|
|
7632
7637
|
"name": "restrictResolution",
|
|
7633
7638
|
"propertyTypeTokenRange": {
|
|
7634
7639
|
"startIndex": 1,
|
|
@@ -8374,7 +8379,7 @@
|
|
|
8374
8379
|
{
|
|
8375
8380
|
"kind": "Class",
|
|
8376
8381
|
"canonicalReference": "@gcorevideo/player!SkipTime:class",
|
|
8377
|
-
"docComment": "/**\n * `PLUGIN` that allows skipping time by tapping on the left or right side of the video.\n *\n * @
|
|
8382
|
+
"docComment": "/**\n * `PLUGIN` that allows skipping time by tapping on the left or right side of the video.\n *\n * @public\n */\n",
|
|
8378
8383
|
"excerptTokens": [
|
|
8379
8384
|
{
|
|
8380
8385
|
"kind": "Content",
|
|
@@ -8391,7 +8396,7 @@
|
|
|
8391
8396
|
}
|
|
8392
8397
|
],
|
|
8393
8398
|
"fileUrlPath": "src/plugins/skip-time/SkipTime.ts",
|
|
8394
|
-
"releaseTag": "
|
|
8399
|
+
"releaseTag": "Public",
|
|
8395
8400
|
"isAbstract": false,
|
|
8396
8401
|
"name": "SkipTime",
|
|
8397
8402
|
"preserveMemberOrder": false,
|
|
@@ -8416,7 +8421,7 @@
|
|
|
8416
8421
|
],
|
|
8417
8422
|
"isReadonly": true,
|
|
8418
8423
|
"isOptional": false,
|
|
8419
|
-
"releaseTag": "
|
|
8424
|
+
"releaseTag": "Public",
|
|
8420
8425
|
"name": "container",
|
|
8421
8426
|
"propertyTypeTokenRange": {
|
|
8422
8427
|
"startIndex": 1,
|
|
@@ -8446,7 +8451,7 @@
|
|
|
8446
8451
|
],
|
|
8447
8452
|
"isReadonly": true,
|
|
8448
8453
|
"isOptional": false,
|
|
8449
|
-
"releaseTag": "
|
|
8454
|
+
"releaseTag": "Public",
|
|
8450
8455
|
"name": "name",
|
|
8451
8456
|
"propertyTypeTokenRange": {
|
|
8452
8457
|
"startIndex": 1,
|
|
@@ -8476,7 +8481,7 @@
|
|
|
8476
8481
|
],
|
|
8477
8482
|
"isReadonly": true,
|
|
8478
8483
|
"isOptional": false,
|
|
8479
|
-
"releaseTag": "
|
|
8484
|
+
"releaseTag": "Public",
|
|
8480
8485
|
"name": "supportedVersion",
|
|
8481
8486
|
"propertyTypeTokenRange": {
|
|
8482
8487
|
"startIndex": 1,
|
|
@@ -9857,7 +9862,7 @@
|
|
|
9857
9862
|
{
|
|
9858
9863
|
"kind": "Enum",
|
|
9859
9864
|
"canonicalReference": "@gcorevideo/player!VolumeFadeEvents:enum",
|
|
9860
|
-
"docComment": "/**\n * Events emitted by the VolumeFade plugin.\n *\n * @
|
|
9865
|
+
"docComment": "/**\n * Events emitted by the VolumeFade plugin.\n *\n * @public\n */\n",
|
|
9861
9866
|
"excerptTokens": [
|
|
9862
9867
|
{
|
|
9863
9868
|
"kind": "Content",
|
|
@@ -9865,7 +9870,7 @@
|
|
|
9865
9870
|
}
|
|
9866
9871
|
],
|
|
9867
9872
|
"fileUrlPath": "src/plugins/volume-fade/VolumeFade.ts",
|
|
9868
|
-
"releaseTag": "
|
|
9873
|
+
"releaseTag": "Public",
|
|
9869
9874
|
"name": "VolumeFadeEvents",
|
|
9870
9875
|
"preserveMemberOrder": false,
|
|
9871
9876
|
"members": [
|
|
@@ -9887,7 +9892,7 @@
|
|
|
9887
9892
|
"startIndex": 1,
|
|
9888
9893
|
"endIndex": 2
|
|
9889
9894
|
},
|
|
9890
|
-
"releaseTag": "
|
|
9895
|
+
"releaseTag": "Public",
|
|
9891
9896
|
"name": "FADE"
|
|
9892
9897
|
}
|
|
9893
9898
|
]
|
|
@@ -9895,7 +9900,7 @@
|
|
|
9895
9900
|
{
|
|
9896
9901
|
"kind": "TypeAlias",
|
|
9897
9902
|
"canonicalReference": "@gcorevideo/player!VolumeFadeSettings:type",
|
|
9898
|
-
"docComment": "/**\n * @
|
|
9903
|
+
"docComment": "/**\n * @public\n */\n",
|
|
9899
9904
|
"excerptTokens": [
|
|
9900
9905
|
{
|
|
9901
9906
|
"kind": "Content",
|
|
@@ -9911,7 +9916,7 @@
|
|
|
9911
9916
|
}
|
|
9912
9917
|
],
|
|
9913
9918
|
"fileUrlPath": "src/plugins/volume-fade/VolumeFade.ts",
|
|
9914
|
-
"releaseTag": "
|
|
9919
|
+
"releaseTag": "Public",
|
|
9915
9920
|
"name": "VolumeFadeSettings",
|
|
9916
9921
|
"typeTokenRange": {
|
|
9917
9922
|
"startIndex": 1,
|
|
@@ -9967,7 +9972,7 @@
|
|
|
9967
9972
|
{
|
|
9968
9973
|
"kind": "TypeAlias",
|
|
9969
9974
|
"canonicalReference": "@gcorevideo/player!ZeptoResult:type",
|
|
9970
|
-
"docComment": "/**\n * {@link https://zeptojs.com/#$() | Zepto query result}\n *\n * @
|
|
9975
|
+
"docComment": "/**\n * {@link https://zeptojs.com/#$() | Zepto query result}\n *\n * @public\n */\n",
|
|
9971
9976
|
"excerptTokens": [
|
|
9972
9977
|
{
|
|
9973
9978
|
"kind": "Content",
|
|
@@ -9997,7 +10002,7 @@
|
|
|
9997
10002
|
}
|
|
9998
10003
|
],
|
|
9999
10004
|
"fileUrlPath": "src/types.ts",
|
|
10000
|
-
"releaseTag": "
|
|
10005
|
+
"releaseTag": "Public",
|
|
10001
10006
|
"name": "ZeptoResult",
|
|
10002
10007
|
"typeTokenRange": {
|
|
10003
10008
|
"startIndex": 1,
|