@gcorevideo/player 2.20.9 → 2.20.12
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/dvr-controls/dvr_controls.scss +0 -2
- package/dist/core.js +5 -5
- package/dist/index.css +1521 -1524
- package/dist/index.js +101 -106
- package/dist/player.d.ts +141 -100
- package/dist/plugins/index.css +1376 -1379
- package/dist/plugins/index.js +96 -102
- package/docs/api/player.audioselector.md +1 -1
- package/docs/api/player.bigmutebutton.md +1 -1
- package/docs/api/player.bottomgear.md +1 -1
- package/docs/api/player.clapprnerdstats.md +1 -1
- package/docs/api/player.clapprstats.md +1 -1
- package/docs/api/player.clicktopause.md +1 -1
- package/docs/api/player.clipsplugin.md +1 -1
- package/docs/api/player.containerpluginconstructor.md +3 -5
- package/docs/api/player.containersize.md +0 -3
- package/docs/api/player.contextmenu.md +1 -1
- package/docs/api/player.contextmenupluginsettings.md +1 -1
- package/docs/api/player.corepluginconstructor.md +3 -5
- package/docs/api/player.dashsettings.md +0 -3
- package/docs/api/player.dvrcontrols.md +2 -35
- package/docs/api/player.errorlevel.md +0 -3
- package/docs/api/player.errorscreen.md +1 -1
- package/docs/api/player.favicon.md +4 -174
- package/docs/api/{player.favicon.disable.md → player.faviconpluginsettings.faviconcolor.md} +5 -7
- package/docs/api/{player.dvrcontrols._constructor_.md → player.faviconpluginsettings.md} +17 -8
- package/docs/api/player.googleanalytics.md +1 -1
- package/docs/api/player.langtag.md +0 -3
- package/docs/api/player.levelselector.md +1 -1
- package/docs/api/player.logo.md +1 -1
- package/docs/api/player.md +82 -82
- package/docs/api/{player.favicon.configure.md → player.mediacontrol.getcenterpanel.md} +4 -4
- package/docs/api/{player.favicon.destroy.md → player.mediacontrol.getleftpanel.md} +8 -4
- package/docs/api/player.mediacontrol.md +30 -2
- package/docs/api/player.multicamera.md +1 -1
- package/docs/api/player.pictureinpicture.md +1 -1
- package/docs/api/player.playbackerror.code.md +0 -3
- package/docs/api/player.playbackerror.description.md +0 -3
- package/docs/api/player.playbackerror.level.md +0 -3
- package/docs/api/player.playbackerror.md +8 -11
- package/docs/api/player.playbackerror.message.md +0 -3
- package/docs/api/player.playbackerror.origin.md +0 -3
- package/docs/api/player.playbackerror.scope.md +0 -3
- package/docs/api/player.playbackerror.ui.md +1 -3
- package/docs/api/player.playbackerrorcode.md +3 -6
- package/docs/api/player.playbackmodule.md +0 -3
- package/docs/api/player.playbackrate.md +1 -1
- package/docs/api/player.playbacktype.md +1 -4
- package/docs/api/player.player._constructor_.md +0 -3
- package/docs/api/player.player.attachto.md +0 -3
- package/docs/api/player.player.configure.md +0 -3
- package/docs/api/player.player.destroy.md +0 -3
- package/docs/api/player.player.getcurrenttime.md +0 -3
- package/docs/api/player.player.getduration.md +0 -3
- package/docs/api/player.player.getvolume.md +0 -3
- package/docs/api/player.player.isdvrenabled.md +0 -3
- package/docs/api/player.player.isdvrinuse.md +0 -3
- package/docs/api/player.player.ismuted.md +0 -3
- package/docs/api/player.player.isplaying.md +0 -3
- package/docs/api/player.player.md +25 -28
- package/docs/api/player.player.mute.md +0 -3
- package/docs/api/player.player.off.md +0 -3
- package/docs/api/player.player.on.md +0 -3
- package/docs/api/player.player.pause.md +0 -3
- package/docs/api/player.player.play.md +0 -3
- package/docs/api/player.player.registerplugin.md +0 -3
- package/docs/api/player.player.resize.md +0 -3
- package/docs/api/player.player.seek.md +0 -3
- package/docs/api/player.player.setvolume.md +0 -3
- package/docs/api/player.player.stop.md +0 -3
- package/docs/api/player.player.unmute.md +0 -3
- package/docs/api/player.player.unregisterplugin.md +14 -7
- package/docs/api/player.playercomponenttype.md +0 -3
- package/docs/api/player.playerconfig.autoplay.md +0 -3
- package/docs/api/player.playerconfig.dash.md +0 -3
- package/docs/api/player.playerconfig.debug.md +0 -3
- package/docs/api/player.playerconfig.language.md +0 -3
- package/docs/api/player.playerconfig.loop.md +0 -3
- package/docs/api/player.playerconfig.md +10 -13
- package/docs/api/player.playerconfig.mute.md +0 -3
- package/docs/api/player.playerconfig.playbacktype.md +0 -3
- package/docs/api/player.playerconfig.prioritytransport.md +0 -3
- package/docs/api/player.playerconfig.sources.md +0 -3
- package/docs/api/player.playerconfig.strings.md +0 -3
- package/docs/api/player.playerdebugsettings.md +0 -3
- package/docs/api/player.playerdebugtag.md +0 -3
- package/docs/api/player.playerevent.md +11 -14
- package/docs/api/player.playereventhandler.md +0 -3
- package/docs/api/player.playereventparams.md +0 -3
- package/docs/api/player.playermediasource.md +0 -3
- package/docs/api/player.playermediasourcedesc.md +2 -5
- package/docs/api/player.playermediasourcedesc.mimetype.md +0 -3
- package/docs/api/player.playermediasourcedesc.source.md +0 -3
- package/docs/api/player.playerplugin.md +0 -4
- package/docs/api/player.playerpluginconstructor.md +0 -3
- package/docs/api/player.poster.md +1 -1
- package/docs/api/player.qualitylevel.bitrate.md +0 -3
- package/docs/api/player.qualitylevel.height.md +0 -3
- package/docs/api/player.qualitylevel.level.md +0 -3
- package/docs/api/player.qualitylevel.md +4 -7
- package/docs/api/player.qualitylevel.width.md +0 -3
- package/docs/api/player.seektime.md +1 -1
- package/docs/api/player.share.md +1 -1
- package/docs/api/player.skiptime.md +1 -1
- package/docs/api/player.sourcecontroller.md +1 -1
- package/docs/api/player.spinnerthreebounce.md +1 -1
- package/docs/api/player.subtitles.md +1 -1
- package/docs/api/player.telemetry.md +1 -1
- package/docs/api/player.thumbnails.md +1 -1
- package/docs/api/player.timeposition.current.md +0 -3
- package/docs/api/player.timeposition.md +2 -5
- package/docs/api/player.timeposition.total.md +0 -3
- package/docs/api/player.timevalue.md +0 -3
- package/docs/api/player.translationkey.md +0 -3
- package/docs/api/player.translationsettings.md +0 -3
- package/docs/api/player.transportpreference.md +2 -7
- package/docs/api/player.volumefade.md +1 -1
- package/lib/Player.d.ts +5 -5
- package/lib/Player.js +2 -2
- package/lib/index.d.ts +18 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +18 -1
- package/lib/playback.types.d.ts +8 -7
- package/lib/playback.types.d.ts.map +1 -1
- package/lib/playback.types.js +1 -1
- package/lib/plugins/audio-selector/AudioSelector.d.ts +1 -1
- package/lib/plugins/audio-selector/AudioSelector.js +1 -1
- 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 -2
- package/lib/plugins/bottom-gear/BottomGear.d.ts +1 -1
- package/lib/plugins/bottom-gear/BottomGear.js +1 -1
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts +1 -1
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js +1 -1
- package/lib/plugins/clappr-stats/ClapprStats.d.ts +1 -1
- package/lib/plugins/clappr-stats/ClapprStats.js +1 -1
- package/lib/plugins/click-to-pause/ClickToPause.d.ts +1 -1
- package/lib/plugins/click-to-pause/ClickToPause.js +1 -1
- package/lib/plugins/clips/Clips.d.ts +1 -1
- package/lib/plugins/clips/Clips.js +1 -1
- package/lib/plugins/context-menu/ContextMenu.d.ts +2 -2
- package/lib/plugins/context-menu/ContextMenu.js +1 -1
- package/lib/plugins/dvr-controls/DvrControls.d.ts +6 -4
- package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
- package/lib/plugins/dvr-controls/DvrControls.js +28 -36
- package/lib/plugins/error-screen/ErrorScreen.d.ts +1 -18
- package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
- package/lib/plugins/error-screen/ErrorScreen.js +1 -2
- package/lib/plugins/favicon/Favicon.d.ts +30 -3
- package/lib/plugins/favicon/Favicon.d.ts.map +1 -1
- package/lib/plugins/favicon/Favicon.js +28 -35
- package/lib/plugins/google-analytics/GoogleAnalytics.d.ts +1 -1
- package/lib/plugins/google-analytics/GoogleAnalytics.js +1 -1
- package/lib/plugins/level-selector/LevelSelector.d.ts +1 -1
- package/lib/plugins/level-selector/LevelSelector.js +1 -1
- package/lib/plugins/logo/Logo.d.ts +1 -1
- package/lib/plugins/logo/Logo.js +1 -1
- package/lib/plugins/media-control/MediaControl.d.ts +8 -2
- package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
- package/lib/plugins/media-control/MediaControl.js +15 -3
- package/lib/plugins/multi-camera/MultiCamera.d.ts +1 -1
- package/lib/plugins/multi-camera/MultiCamera.js +1 -1
- package/lib/plugins/picture-in-picture/PictureInPicture.d.ts +1 -1
- package/lib/plugins/picture-in-picture/PictureInPicture.js +1 -1
- package/lib/plugins/playback-rate/PlaybackRate.d.ts +1 -1
- package/lib/plugins/playback-rate/PlaybackRate.js +1 -1
- package/lib/plugins/poster/Poster.d.ts +1 -1
- package/lib/plugins/poster/Poster.js +1 -1
- package/lib/plugins/seek-time/SeekTime.d.ts +1 -1
- package/lib/plugins/seek-time/SeekTime.js +1 -1
- package/lib/plugins/share/Share.d.ts +1 -1
- package/lib/plugins/share/Share.js +1 -1
- package/lib/plugins/skip-time/SkipTime.d.ts +1 -1
- package/lib/plugins/skip-time/SkipTime.js +1 -1
- package/lib/plugins/source-controller/SourceController.d.ts +1 -1
- package/lib/plugins/source-controller/SourceController.js +1 -1
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts +1 -1
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +1 -1
- package/lib/plugins/subtitles/Subtitles.d.ts +1 -1
- package/lib/plugins/subtitles/Subtitles.js +1 -1
- package/lib/plugins/telemetry/Telemetry.d.ts +1 -1
- package/lib/plugins/telemetry/Telemetry.js +1 -1
- package/lib/plugins/thumbnails/Thumbnails.d.ts +1 -1
- package/lib/plugins/thumbnails/Thumbnails.js +1 -1
- package/lib/plugins/volume-fade/VolumeFade.d.ts +1 -1
- package/lib/plugins/volume-fade/VolumeFade.js +1 -1
- package/lib/testUtils.d.ts +11 -2
- package/lib/testUtils.d.ts.map +1 -1
- package/lib/testUtils.js +22 -3
- package/lib/types.d.ts +20 -25
- package/lib/types.d.ts.map +1 -1
- package/lib/types.js +1 -1
- package/package.json +1 -1
- package/src/Player.ts +5 -5
- package/src/index.ts +18 -1
- package/src/playback.types.ts +8 -7
- package/src/plugins/audio-selector/AudioSelector.ts +1 -1
- package/src/plugins/big-mute-button/BigMuteButton.ts +1 -2
- package/src/plugins/bottom-gear/BottomGear.ts +1 -1
- package/src/plugins/clappr-nerd-stats/ClapprNerdStats.ts +1 -1
- package/src/plugins/clappr-stats/ClapprStats.ts +1 -1
- package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
- package/src/plugins/clips/Clips.ts +1 -1
- package/src/plugins/context-menu/ContextMenu.ts +2 -2
- package/src/plugins/dvr-controls/DvrControls.ts +33 -45
- package/src/plugins/dvr-controls/__tests__/DvrControls.test.ts +91 -0
- package/src/plugins/dvr-controls/__tests__/__snapshots__/DvrControls.test.ts.snap +43 -0
- package/src/plugins/error-screen/ErrorScreen.ts +3 -22
- package/src/plugins/favicon/Favicon.ts +38 -41
- package/src/plugins/google-analytics/GoogleAnalytics.ts +1 -1
- package/src/plugins/level-selector/LevelSelector.ts +1 -1
- package/src/plugins/logo/Logo.ts +1 -1
- package/src/plugins/media-control/MediaControl.ts +17 -3
- package/src/plugins/multi-camera/MultiCamera.ts +1 -1
- package/src/plugins/picture-in-picture/PictureInPicture.ts +1 -1
- package/src/plugins/playback-rate/PlaybackRate.ts +1 -1
- package/src/plugins/poster/Poster.ts +1 -1
- package/src/plugins/seek-time/SeekTime.ts +1 -1
- package/src/plugins/share/Share.ts +1 -1
- package/src/plugins/skip-time/SkipTime.ts +1 -1
- package/src/plugins/source-controller/SourceController.ts +1 -1
- package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +1 -1
- package/src/plugins/subtitles/Subtitles.ts +1 -1
- package/src/plugins/telemetry/Telemetry.ts +1 -1
- package/src/plugins/thumbnails/Thumbnails.ts +1 -1
- package/src/plugins/volume-fade/VolumeFade.ts +1 -1
- package/src/testUtils.ts +28 -4
- package/src/types.ts +20 -26
- package/temp/player.api.json +274 -455
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.errordesc.md +0 -28
- package/docs/api/player.favicon._constructor_.md +0 -50
- package/docs/api/player.favicon.bindevents.md +0 -18
- package/docs/api/player.favicon.name.md +0 -14
- package/docs/api/player.favicon.supportedversion.md +0 -16
- package/docs/api/player.mediatransport.md +0 -16
package/temp/player.api.json
CHANGED
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
},
|
|
163
163
|
"kind": "Package",
|
|
164
164
|
"canonicalReference": "@gcorevideo/player!",
|
|
165
|
-
"docComment": "/**\n * Video player for the Gcore streaming platform\n *\n * @remarks\n *\n * This package provides a video player for the Gcore streaming platform. It is built on top of the Clappr library and provides a framework for building custom integrations. Start with {@link Player} for more information.\n *\n * @packageDocumentation\n */\n",
|
|
165
|
+
"docComment": "/**\n * Video player for the Gcore streaming platform\n *\n * @remarks\n *\n * This package provides a video player for the Gcore streaming platform. It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations. Start with {@link Player} for more information.\n *\n * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.\n *\n * @example\n * ```ts\n * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'\n *\n * Player.registerPlugin(MediaControl)\n * Player.registerPlugin(ErrorScreen)\n *\n * const player = new Player({\n * autoPlay: true,\n * mute: true,\n * sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],\n * })\n *\n * player.attachTo(document.getElementById('container'))\n * ```\n *\n * @packageDocumentation\n */\n",
|
|
166
166
|
"name": "@gcorevideo/player",
|
|
167
167
|
"preserveMemberOrder": false,
|
|
168
168
|
"members": [
|
|
@@ -175,7 +175,7 @@
|
|
|
175
175
|
{
|
|
176
176
|
"kind": "Class",
|
|
177
177
|
"canonicalReference": "@gcorevideo/player!AudioSelector:class",
|
|
178
|
-
"docComment": "/**\n *
|
|
178
|
+
"docComment": "/**\n * `PLUGIN` that adds an audio track selector to the media control UI.\n *\n * @beta\n */\n",
|
|
179
179
|
"excerptTokens": [
|
|
180
180
|
{
|
|
181
181
|
"kind": "Content",
|
|
@@ -344,7 +344,7 @@
|
|
|
344
344
|
{
|
|
345
345
|
"kind": "Class",
|
|
346
346
|
"canonicalReference": "@gcorevideo/player!BigMuteButton:class",
|
|
347
|
-
"docComment": "/**\n *
|
|
347
|
+
"docComment": "/**\n * `PLUGIN` that displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.\n *\n * @beta\n */\n",
|
|
348
348
|
"excerptTokens": [
|
|
349
349
|
{
|
|
350
350
|
"kind": "Content",
|
|
@@ -375,7 +375,7 @@
|
|
|
375
375
|
{
|
|
376
376
|
"kind": "Class",
|
|
377
377
|
"canonicalReference": "@gcorevideo/player!BottomGear:class",
|
|
378
|
-
"docComment": "/**\n *
|
|
378
|
+
"docComment": "/**\n * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI\n *\n * @remarks\n *\n * The plugins provides a base for attaching custom settings UI in the gear menu\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * @beta\n */\n",
|
|
379
379
|
"excerptTokens": [
|
|
380
380
|
{
|
|
381
381
|
"kind": "Content",
|
|
@@ -541,7 +541,7 @@
|
|
|
541
541
|
{
|
|
542
542
|
"kind": "Class",
|
|
543
543
|
"canonicalReference": "@gcorevideo/player!ClapprNerdStats:class",
|
|
544
|
-
"docComment": "/**\n * PLUGIN that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
|
|
544
|
+
"docComment": "/**\n * `PLUGIN` that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
|
|
545
545
|
"excerptTokens": [
|
|
546
546
|
{
|
|
547
547
|
"kind": "Content",
|
|
@@ -606,7 +606,7 @@
|
|
|
606
606
|
{
|
|
607
607
|
"kind": "Class",
|
|
608
608
|
"canonicalReference": "@gcorevideo/player!ClapprStats:class",
|
|
609
|
-
"docComment": "/**\n *
|
|
609
|
+
"docComment": "/**\n * `PLUGIN` that collects useful statistics about playback performance.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * @beta\n */\n",
|
|
610
610
|
"excerptTokens": [
|
|
611
611
|
{
|
|
612
612
|
"kind": "Content",
|
|
@@ -752,7 +752,7 @@
|
|
|
752
752
|
{
|
|
753
753
|
"kind": "Class",
|
|
754
754
|
"canonicalReference": "@gcorevideo/player!ClickToPause:class",
|
|
755
|
-
"docComment": "/**\n *
|
|
755
|
+
"docComment": "/**\n * `PLUGIN` that adds a behavior of toggling the playback state on click over the container\n *\n * @beta\n */\n",
|
|
756
756
|
"excerptTokens": [
|
|
757
757
|
{
|
|
758
758
|
"kind": "Content",
|
|
@@ -783,7 +783,7 @@
|
|
|
783
783
|
{
|
|
784
784
|
"kind": "Class",
|
|
785
785
|
"canonicalReference": "@gcorevideo/player!ClipsPlugin:class",
|
|
786
|
-
"docComment": "/**\n * PLUGIN that shows text over the seekbar to indicate the current clip.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
|
|
786
|
+
"docComment": "/**\n * `PLUGIN` that shows text over the seekbar to indicate the current clip.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
|
|
787
787
|
"excerptTokens": [
|
|
788
788
|
{
|
|
789
789
|
"kind": "Content",
|
|
@@ -908,7 +908,7 @@
|
|
|
908
908
|
{
|
|
909
909
|
"kind": "TypeAlias",
|
|
910
910
|
"canonicalReference": "@gcorevideo/player!ContainerPluginConstructor:type",
|
|
911
|
-
"docComment": "/**\n * @
|
|
911
|
+
"docComment": "/**\n * @public\n */\n",
|
|
912
912
|
"excerptTokens": [
|
|
913
913
|
{
|
|
914
914
|
"kind": "Content",
|
|
@@ -916,7 +916,16 @@
|
|
|
916
916
|
},
|
|
917
917
|
{
|
|
918
918
|
"kind": "Content",
|
|
919
|
-
"text": "(
|
|
919
|
+
"text": "{\n new (container: "
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"kind": "Reference",
|
|
923
|
+
"text": "Container",
|
|
924
|
+
"canonicalReference": "@clappr/core!default:class"
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
"kind": "Content",
|
|
928
|
+
"text": "): "
|
|
920
929
|
},
|
|
921
930
|
{
|
|
922
931
|
"kind": "Reference",
|
|
@@ -925,7 +934,7 @@
|
|
|
925
934
|
},
|
|
926
935
|
{
|
|
927
936
|
"kind": "Content",
|
|
928
|
-
"text": "
|
|
937
|
+
"text": ";\n type: string;\n}"
|
|
929
938
|
},
|
|
930
939
|
{
|
|
931
940
|
"kind": "Content",
|
|
@@ -933,17 +942,17 @@
|
|
|
933
942
|
}
|
|
934
943
|
],
|
|
935
944
|
"fileUrlPath": "src/types.ts",
|
|
936
|
-
"releaseTag": "
|
|
945
|
+
"releaseTag": "Public",
|
|
937
946
|
"name": "ContainerPluginConstructor",
|
|
938
947
|
"typeTokenRange": {
|
|
939
948
|
"startIndex": 1,
|
|
940
|
-
"endIndex":
|
|
949
|
+
"endIndex": 6
|
|
941
950
|
}
|
|
942
951
|
},
|
|
943
952
|
{
|
|
944
953
|
"kind": "TypeAlias",
|
|
945
954
|
"canonicalReference": "@gcorevideo/player!ContainerSize:type",
|
|
946
|
-
"docComment": "/**\n * Dimensions of the player container DOM element.\n *\n * @
|
|
955
|
+
"docComment": "/**\n * Dimensions of the player container DOM element.\n *\n * @public\n */\n",
|
|
947
956
|
"excerptTokens": [
|
|
948
957
|
{
|
|
949
958
|
"kind": "Content",
|
|
@@ -959,7 +968,7 @@
|
|
|
959
968
|
}
|
|
960
969
|
],
|
|
961
970
|
"fileUrlPath": "src/types.ts",
|
|
962
|
-
"releaseTag": "
|
|
971
|
+
"releaseTag": "Public",
|
|
963
972
|
"name": "ContainerSize",
|
|
964
973
|
"typeTokenRange": {
|
|
965
974
|
"startIndex": 1,
|
|
@@ -969,7 +978,7 @@
|
|
|
969
978
|
{
|
|
970
979
|
"kind": "Class",
|
|
971
980
|
"canonicalReference": "@gcorevideo/player!ContextMenu:class",
|
|
972
|
-
"docComment": "/**\n *
|
|
981
|
+
"docComment": "/**\n * `PLUGIN` that displays a small context menu when clicked on the player container.\n *\n * @remarks\n *\n * Configuration options - {@link ContextMenuPluginSettings}\n *\n * @beta\n */\n",
|
|
973
982
|
"excerptTokens": [
|
|
974
983
|
{
|
|
975
984
|
"kind": "Content",
|
|
@@ -1034,7 +1043,7 @@
|
|
|
1034
1043
|
{
|
|
1035
1044
|
"kind": "Interface",
|
|
1036
1045
|
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings:interface",
|
|
1037
|
-
"docComment": "/**\n *
|
|
1046
|
+
"docComment": "/**\n * Context menu plugin settings\n *\n * @beta\n */\n",
|
|
1038
1047
|
"excerptTokens": [
|
|
1039
1048
|
{
|
|
1040
1049
|
"kind": "Content",
|
|
@@ -1133,7 +1142,7 @@
|
|
|
1133
1142
|
{
|
|
1134
1143
|
"kind": "TypeAlias",
|
|
1135
1144
|
"canonicalReference": "@gcorevideo/player!CorePluginConstructor:type",
|
|
1136
|
-
"docComment": "/**\n * @
|
|
1145
|
+
"docComment": "/**\n * @public\n */\n",
|
|
1137
1146
|
"excerptTokens": [
|
|
1138
1147
|
{
|
|
1139
1148
|
"kind": "Content",
|
|
@@ -1141,7 +1150,16 @@
|
|
|
1141
1150
|
},
|
|
1142
1151
|
{
|
|
1143
1152
|
"kind": "Content",
|
|
1144
|
-
"text": "(
|
|
1153
|
+
"text": "{\n new (core: "
|
|
1154
|
+
},
|
|
1155
|
+
{
|
|
1156
|
+
"kind": "Reference",
|
|
1157
|
+
"text": "Core",
|
|
1158
|
+
"canonicalReference": "@clappr/core!default:class"
|
|
1159
|
+
},
|
|
1160
|
+
{
|
|
1161
|
+
"kind": "Content",
|
|
1162
|
+
"text": "): "
|
|
1145
1163
|
},
|
|
1146
1164
|
{
|
|
1147
1165
|
"kind": "Reference",
|
|
@@ -1150,7 +1168,7 @@
|
|
|
1150
1168
|
},
|
|
1151
1169
|
{
|
|
1152
1170
|
"kind": "Content",
|
|
1153
|
-
"text": "
|
|
1171
|
+
"text": ";\n type: string;\n}"
|
|
1154
1172
|
},
|
|
1155
1173
|
{
|
|
1156
1174
|
"kind": "Content",
|
|
@@ -1158,17 +1176,17 @@
|
|
|
1158
1176
|
}
|
|
1159
1177
|
],
|
|
1160
1178
|
"fileUrlPath": "src/types.ts",
|
|
1161
|
-
"releaseTag": "
|
|
1179
|
+
"releaseTag": "Public",
|
|
1162
1180
|
"name": "CorePluginConstructor",
|
|
1163
1181
|
"typeTokenRange": {
|
|
1164
1182
|
"startIndex": 1,
|
|
1165
|
-
"endIndex":
|
|
1183
|
+
"endIndex": 6
|
|
1166
1184
|
}
|
|
1167
1185
|
},
|
|
1168
1186
|
{
|
|
1169
1187
|
"kind": "TypeAlias",
|
|
1170
1188
|
"canonicalReference": "@gcorevideo/player!DashSettings:type",
|
|
1171
|
-
"docComment": "/**\n * A plain JS object that must conform to the DASH.js settings schema.\n *\n * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}\n *\n * @
|
|
1189
|
+
"docComment": "/**\n * A plain JS object that must conform to the DASH.js settings schema.\n *\n * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}\n *\n * @public\n */\n",
|
|
1172
1190
|
"excerptTokens": [
|
|
1173
1191
|
{
|
|
1174
1192
|
"kind": "Content",
|
|
@@ -1189,7 +1207,7 @@
|
|
|
1189
1207
|
}
|
|
1190
1208
|
],
|
|
1191
1209
|
"fileUrlPath": "src/types.ts",
|
|
1192
|
-
"releaseTag": "
|
|
1210
|
+
"releaseTag": "Public",
|
|
1193
1211
|
"name": "DashSettings",
|
|
1194
1212
|
"typeTokenRange": {
|
|
1195
1213
|
"startIndex": 1,
|
|
@@ -1199,7 +1217,7 @@
|
|
|
1199
1217
|
{
|
|
1200
1218
|
"kind": "Class",
|
|
1201
1219
|
"canonicalReference": "@gcorevideo/player!DvrControls:class",
|
|
1202
|
-
"docComment": "/**\n *
|
|
1220
|
+
"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 * @beta\n */\n",
|
|
1203
1221
|
"excerptTokens": [
|
|
1204
1222
|
{
|
|
1205
1223
|
"kind": "Content",
|
|
@@ -1220,77 +1238,17 @@
|
|
|
1220
1238
|
"isAbstract": false,
|
|
1221
1239
|
"name": "DvrControls",
|
|
1222
1240
|
"preserveMemberOrder": false,
|
|
1223
|
-
"members": [
|
|
1224
|
-
{
|
|
1225
|
-
"kind": "Constructor",
|
|
1226
|
-
"canonicalReference": "@gcorevideo/player!DvrControls:constructor(1)",
|
|
1227
|
-
"docComment": "/**\n * Constructs a new instance of the `DvrControls` class\n */\n",
|
|
1228
|
-
"excerptTokens": [
|
|
1229
|
-
{
|
|
1230
|
-
"kind": "Content",
|
|
1231
|
-
"text": "constructor(core: "
|
|
1232
|
-
},
|
|
1233
|
-
{
|
|
1234
|
-
"kind": "Reference",
|
|
1235
|
-
"text": "Core",
|
|
1236
|
-
"canonicalReference": "@clappr/core!default:class"
|
|
1237
|
-
},
|
|
1238
|
-
{
|
|
1239
|
-
"kind": "Content",
|
|
1240
|
-
"text": ");"
|
|
1241
|
-
}
|
|
1242
|
-
],
|
|
1243
|
-
"releaseTag": "Beta",
|
|
1244
|
-
"isProtected": false,
|
|
1245
|
-
"overloadIndex": 1,
|
|
1246
|
-
"parameters": [
|
|
1247
|
-
{
|
|
1248
|
-
"parameterName": "core",
|
|
1249
|
-
"parameterTypeTokenRange": {
|
|
1250
|
-
"startIndex": 1,
|
|
1251
|
-
"endIndex": 2
|
|
1252
|
-
},
|
|
1253
|
-
"isOptional": false
|
|
1254
|
-
}
|
|
1255
|
-
]
|
|
1256
|
-
}
|
|
1257
|
-
],
|
|
1241
|
+
"members": [],
|
|
1258
1242
|
"extendsTokenRange": {
|
|
1259
1243
|
"startIndex": 1,
|
|
1260
1244
|
"endIndex": 2
|
|
1261
1245
|
},
|
|
1262
1246
|
"implementsTokenRanges": []
|
|
1263
1247
|
},
|
|
1264
|
-
{
|
|
1265
|
-
"kind": "TypeAlias",
|
|
1266
|
-
"canonicalReference": "@gcorevideo/player!ErrorDesc:type",
|
|
1267
|
-
"docComment": "/**\n * An error fired in the player and plugins code to be handled in the UI\n *\n * @beta\n */\n",
|
|
1268
|
-
"excerptTokens": [
|
|
1269
|
-
{
|
|
1270
|
-
"kind": "Content",
|
|
1271
|
-
"text": "export type ErrorDesc = "
|
|
1272
|
-
},
|
|
1273
|
-
{
|
|
1274
|
-
"kind": "Content",
|
|
1275
|
-
"text": "{\n description: string;\n level: string;\n code: string;\n origin: string;\n scope: string;\n raw?: string;\n UI?: {\n icon?: string;\n title: string;\n message: string;\n };\n}"
|
|
1276
|
-
},
|
|
1277
|
-
{
|
|
1278
|
-
"kind": "Content",
|
|
1279
|
-
"text": ";"
|
|
1280
|
-
}
|
|
1281
|
-
],
|
|
1282
|
-
"fileUrlPath": "src/plugins/error-screen/ErrorScreen.ts",
|
|
1283
|
-
"releaseTag": "Beta",
|
|
1284
|
-
"name": "ErrorDesc",
|
|
1285
|
-
"typeTokenRange": {
|
|
1286
|
-
"startIndex": 1,
|
|
1287
|
-
"endIndex": 2
|
|
1288
|
-
}
|
|
1289
|
-
},
|
|
1290
1248
|
{
|
|
1291
1249
|
"kind": "TypeAlias",
|
|
1292
1250
|
"canonicalReference": "@gcorevideo/player!ErrorLevel:type",
|
|
1293
|
-
"docComment": "/**\n * Levels of severity of errors. Non-fatal errors usually can be ignored.\n *\n * @
|
|
1251
|
+
"docComment": "/**\n * Levels of severity of errors. Non-fatal errors usually can be ignored.\n *\n * @public\n */\n",
|
|
1294
1252
|
"excerptTokens": [
|
|
1295
1253
|
{
|
|
1296
1254
|
"kind": "Content",
|
|
@@ -1306,7 +1264,7 @@
|
|
|
1306
1264
|
}
|
|
1307
1265
|
],
|
|
1308
1266
|
"fileUrlPath": "src/playback.types.ts",
|
|
1309
|
-
"releaseTag": "
|
|
1267
|
+
"releaseTag": "Public",
|
|
1310
1268
|
"name": "ErrorLevel",
|
|
1311
1269
|
"typeTokenRange": {
|
|
1312
1270
|
"startIndex": 1,
|
|
@@ -1316,7 +1274,7 @@
|
|
|
1316
1274
|
{
|
|
1317
1275
|
"kind": "Class",
|
|
1318
1276
|
"canonicalReference": "@gcorevideo/player!ErrorScreen:class",
|
|
1319
|
-
"docComment": "/**\n * PLUGIN that displays errors nicely in the overlay on top of the player.\n *\n * @beta\n */\n",
|
|
1277
|
+
"docComment": "/**\n * `PLUGIN` that displays errors nicely in the overlay on top of the player.\n *\n * @beta\n */\n",
|
|
1320
1278
|
"excerptTokens": [
|
|
1321
1279
|
{
|
|
1322
1280
|
"kind": "Content",
|
|
@@ -1373,7 +1331,7 @@
|
|
|
1373
1331
|
{
|
|
1374
1332
|
"kind": "Class",
|
|
1375
1333
|
"canonicalReference": "@gcorevideo/player!Favicon:class",
|
|
1376
|
-
"docComment": "/**\n *
|
|
1334
|
+
"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 * @beta\n */\n",
|
|
1377
1335
|
"excerptTokens": [
|
|
1378
1336
|
{
|
|
1379
1337
|
"kind": "Content",
|
|
@@ -1394,172 +1352,36 @@
|
|
|
1394
1352
|
"isAbstract": false,
|
|
1395
1353
|
"name": "Favicon",
|
|
1396
1354
|
"preserveMemberOrder": false,
|
|
1397
|
-
"members": [
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
"text": "Core",
|
|
1410
|
-
"canonicalReference": "@clappr/core!default:class"
|
|
1411
|
-
},
|
|
1412
|
-
{
|
|
1413
|
-
"kind": "Content",
|
|
1414
|
-
"text": ");"
|
|
1415
|
-
}
|
|
1416
|
-
],
|
|
1417
|
-
"releaseTag": "Beta",
|
|
1418
|
-
"isProtected": false,
|
|
1419
|
-
"overloadIndex": 1,
|
|
1420
|
-
"parameters": [
|
|
1421
|
-
{
|
|
1422
|
-
"parameterName": "core",
|
|
1423
|
-
"parameterTypeTokenRange": {
|
|
1424
|
-
"startIndex": 1,
|
|
1425
|
-
"endIndex": 2
|
|
1426
|
-
},
|
|
1427
|
-
"isOptional": false
|
|
1428
|
-
}
|
|
1429
|
-
]
|
|
1430
|
-
},
|
|
1431
|
-
{
|
|
1432
|
-
"kind": "Method",
|
|
1433
|
-
"canonicalReference": "@gcorevideo/player!Favicon#bindEvents:member(1)",
|
|
1434
|
-
"docComment": "",
|
|
1435
|
-
"excerptTokens": [
|
|
1436
|
-
{
|
|
1437
|
-
"kind": "Content",
|
|
1438
|
-
"text": "bindEvents(): "
|
|
1439
|
-
},
|
|
1440
|
-
{
|
|
1441
|
-
"kind": "Content",
|
|
1442
|
-
"text": "void"
|
|
1443
|
-
},
|
|
1444
|
-
{
|
|
1445
|
-
"kind": "Content",
|
|
1446
|
-
"text": ";"
|
|
1447
|
-
}
|
|
1448
|
-
],
|
|
1449
|
-
"isStatic": false,
|
|
1450
|
-
"returnTypeTokenRange": {
|
|
1451
|
-
"startIndex": 1,
|
|
1452
|
-
"endIndex": 2
|
|
1453
|
-
},
|
|
1454
|
-
"releaseTag": "Beta",
|
|
1455
|
-
"isProtected": false,
|
|
1456
|
-
"overloadIndex": 1,
|
|
1457
|
-
"parameters": [],
|
|
1458
|
-
"isOptional": false,
|
|
1459
|
-
"isAbstract": false,
|
|
1460
|
-
"name": "bindEvents"
|
|
1461
|
-
},
|
|
1462
|
-
{
|
|
1463
|
-
"kind": "Method",
|
|
1464
|
-
"canonicalReference": "@gcorevideo/player!Favicon#configure:member(1)",
|
|
1465
|
-
"docComment": "",
|
|
1466
|
-
"excerptTokens": [
|
|
1467
|
-
{
|
|
1468
|
-
"kind": "Content",
|
|
1469
|
-
"text": "configure(): "
|
|
1470
|
-
},
|
|
1471
|
-
{
|
|
1472
|
-
"kind": "Content",
|
|
1473
|
-
"text": "void"
|
|
1474
|
-
},
|
|
1475
|
-
{
|
|
1476
|
-
"kind": "Content",
|
|
1477
|
-
"text": ";"
|
|
1478
|
-
}
|
|
1479
|
-
],
|
|
1480
|
-
"isStatic": false,
|
|
1481
|
-
"returnTypeTokenRange": {
|
|
1482
|
-
"startIndex": 1,
|
|
1483
|
-
"endIndex": 2
|
|
1484
|
-
},
|
|
1485
|
-
"releaseTag": "Beta",
|
|
1486
|
-
"isProtected": false,
|
|
1487
|
-
"overloadIndex": 1,
|
|
1488
|
-
"parameters": [],
|
|
1489
|
-
"isOptional": false,
|
|
1490
|
-
"isAbstract": false,
|
|
1491
|
-
"name": "configure"
|
|
1492
|
-
},
|
|
1493
|
-
{
|
|
1494
|
-
"kind": "Method",
|
|
1495
|
-
"canonicalReference": "@gcorevideo/player!Favicon#destroy:member(1)",
|
|
1496
|
-
"docComment": "",
|
|
1497
|
-
"excerptTokens": [
|
|
1498
|
-
{
|
|
1499
|
-
"kind": "Content",
|
|
1500
|
-
"text": "destroy(): "
|
|
1501
|
-
},
|
|
1502
|
-
{
|
|
1503
|
-
"kind": "Content",
|
|
1504
|
-
"text": "void"
|
|
1505
|
-
},
|
|
1506
|
-
{
|
|
1507
|
-
"kind": "Content",
|
|
1508
|
-
"text": ";"
|
|
1509
|
-
}
|
|
1510
|
-
],
|
|
1511
|
-
"isStatic": false,
|
|
1512
|
-
"returnTypeTokenRange": {
|
|
1513
|
-
"startIndex": 1,
|
|
1514
|
-
"endIndex": 2
|
|
1515
|
-
},
|
|
1516
|
-
"releaseTag": "Beta",
|
|
1517
|
-
"isProtected": false,
|
|
1518
|
-
"overloadIndex": 1,
|
|
1519
|
-
"parameters": [],
|
|
1520
|
-
"isOptional": false,
|
|
1521
|
-
"isAbstract": false,
|
|
1522
|
-
"name": "destroy"
|
|
1523
|
-
},
|
|
1355
|
+
"members": [],
|
|
1356
|
+
"extendsTokenRange": {
|
|
1357
|
+
"startIndex": 1,
|
|
1358
|
+
"endIndex": 2
|
|
1359
|
+
},
|
|
1360
|
+
"implementsTokenRanges": []
|
|
1361
|
+
},
|
|
1362
|
+
{
|
|
1363
|
+
"kind": "Interface",
|
|
1364
|
+
"canonicalReference": "@gcorevideo/player!FaviconPluginSettings:interface",
|
|
1365
|
+
"docComment": "/**\n * @beta\n */\n",
|
|
1366
|
+
"excerptTokens": [
|
|
1524
1367
|
{
|
|
1525
|
-
"kind": "
|
|
1526
|
-
"
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
"kind": "Content",
|
|
1535
|
-
"text": "void"
|
|
1536
|
-
},
|
|
1537
|
-
{
|
|
1538
|
-
"kind": "Content",
|
|
1539
|
-
"text": ";"
|
|
1540
|
-
}
|
|
1541
|
-
],
|
|
1542
|
-
"isStatic": false,
|
|
1543
|
-
"returnTypeTokenRange": {
|
|
1544
|
-
"startIndex": 1,
|
|
1545
|
-
"endIndex": 2
|
|
1546
|
-
},
|
|
1547
|
-
"releaseTag": "Beta",
|
|
1548
|
-
"isProtected": false,
|
|
1549
|
-
"overloadIndex": 1,
|
|
1550
|
-
"parameters": [],
|
|
1551
|
-
"isOptional": false,
|
|
1552
|
-
"isAbstract": false,
|
|
1553
|
-
"name": "disable"
|
|
1554
|
-
},
|
|
1368
|
+
"kind": "Content",
|
|
1369
|
+
"text": "export interface FaviconPluginSettings "
|
|
1370
|
+
}
|
|
1371
|
+
],
|
|
1372
|
+
"fileUrlPath": "src/plugins/favicon/Favicon.ts",
|
|
1373
|
+
"releaseTag": "Beta",
|
|
1374
|
+
"name": "FaviconPluginSettings",
|
|
1375
|
+
"preserveMemberOrder": false,
|
|
1376
|
+
"members": [
|
|
1555
1377
|
{
|
|
1556
|
-
"kind": "
|
|
1557
|
-
"canonicalReference": "@gcorevideo/player!
|
|
1558
|
-
"docComment": "",
|
|
1378
|
+
"kind": "PropertySignature",
|
|
1379
|
+
"canonicalReference": "@gcorevideo/player!FaviconPluginSettings#faviconColor:member",
|
|
1380
|
+
"docComment": "/**\n * CSS color of the favicon.\n */\n",
|
|
1559
1381
|
"excerptTokens": [
|
|
1560
1382
|
{
|
|
1561
1383
|
"kind": "Content",
|
|
1562
|
-
"text": "
|
|
1384
|
+
"text": "faviconColor?: "
|
|
1563
1385
|
},
|
|
1564
1386
|
{
|
|
1565
1387
|
"kind": "Content",
|
|
@@ -1570,54 +1392,17 @@
|
|
|
1570
1392
|
"text": ";"
|
|
1571
1393
|
}
|
|
1572
1394
|
],
|
|
1573
|
-
"isReadonly":
|
|
1574
|
-
"isOptional":
|
|
1575
|
-
"releaseTag": "Beta",
|
|
1576
|
-
"name": "name",
|
|
1577
|
-
"propertyTypeTokenRange": {
|
|
1578
|
-
"startIndex": 1,
|
|
1579
|
-
"endIndex": 2
|
|
1580
|
-
},
|
|
1581
|
-
"isStatic": false,
|
|
1582
|
-
"isProtected": false,
|
|
1583
|
-
"isAbstract": false
|
|
1584
|
-
},
|
|
1585
|
-
{
|
|
1586
|
-
"kind": "Property",
|
|
1587
|
-
"canonicalReference": "@gcorevideo/player!Favicon#supportedVersion:member",
|
|
1588
|
-
"docComment": "",
|
|
1589
|
-
"excerptTokens": [
|
|
1590
|
-
{
|
|
1591
|
-
"kind": "Content",
|
|
1592
|
-
"text": "get supportedVersion(): "
|
|
1593
|
-
},
|
|
1594
|
-
{
|
|
1595
|
-
"kind": "Content",
|
|
1596
|
-
"text": "{\n min: string;\n }"
|
|
1597
|
-
},
|
|
1598
|
-
{
|
|
1599
|
-
"kind": "Content",
|
|
1600
|
-
"text": ";"
|
|
1601
|
-
}
|
|
1602
|
-
],
|
|
1603
|
-
"isReadonly": true,
|
|
1604
|
-
"isOptional": false,
|
|
1395
|
+
"isReadonly": false,
|
|
1396
|
+
"isOptional": true,
|
|
1605
1397
|
"releaseTag": "Beta",
|
|
1606
|
-
"name": "
|
|
1398
|
+
"name": "faviconColor",
|
|
1607
1399
|
"propertyTypeTokenRange": {
|
|
1608
1400
|
"startIndex": 1,
|
|
1609
1401
|
"endIndex": 2
|
|
1610
|
-
}
|
|
1611
|
-
"isStatic": false,
|
|
1612
|
-
"isProtected": false,
|
|
1613
|
-
"isAbstract": false
|
|
1402
|
+
}
|
|
1614
1403
|
}
|
|
1615
1404
|
],
|
|
1616
|
-
"
|
|
1617
|
-
"startIndex": 1,
|
|
1618
|
-
"endIndex": 2
|
|
1619
|
-
},
|
|
1620
|
-
"implementsTokenRanges": []
|
|
1405
|
+
"extendsTokenRanges": []
|
|
1621
1406
|
},
|
|
1622
1407
|
{
|
|
1623
1408
|
"kind": "TypeAlias",
|
|
@@ -1648,7 +1433,7 @@
|
|
|
1648
1433
|
{
|
|
1649
1434
|
"kind": "Class",
|
|
1650
1435
|
"canonicalReference": "@gcorevideo/player!GoogleAnalytics:class",
|
|
1651
|
-
"docComment": "/**\n *
|
|
1436
|
+
"docComment": "/**\n * `PLUGIN` that integrates with Google Analytics\n *\n * @beta\n */\n",
|
|
1652
1437
|
"excerptTokens": [
|
|
1653
1438
|
{
|
|
1654
1439
|
"kind": "Content",
|
|
@@ -2366,7 +2151,7 @@
|
|
|
2366
2151
|
{
|
|
2367
2152
|
"kind": "TypeAlias",
|
|
2368
2153
|
"canonicalReference": "@gcorevideo/player!LangTag:type",
|
|
2369
|
-
"docComment": "/**\n * An ISO 639-1 language code.\n *\n * @example\n *\n * `pt`\n *\n * @
|
|
2154
|
+
"docComment": "/**\n * An ISO 639-1 language code.\n *\n * @example\n *\n * `pt`\n *\n * @public\n */\n",
|
|
2370
2155
|
"excerptTokens": [
|
|
2371
2156
|
{
|
|
2372
2157
|
"kind": "Content",
|
|
@@ -2382,7 +2167,7 @@
|
|
|
2382
2167
|
}
|
|
2383
2168
|
],
|
|
2384
2169
|
"fileUrlPath": "src/types.ts",
|
|
2385
|
-
"releaseTag": "
|
|
2170
|
+
"releaseTag": "Public",
|
|
2386
2171
|
"name": "LangTag",
|
|
2387
2172
|
"typeTokenRange": {
|
|
2388
2173
|
"startIndex": 1,
|
|
@@ -2392,7 +2177,7 @@
|
|
|
2392
2177
|
{
|
|
2393
2178
|
"kind": "Class",
|
|
2394
2179
|
"canonicalReference": "@gcorevideo/player!LevelSelector:class",
|
|
2395
|
-
"docComment": "/**\n * PLUGIN that provides a UI to select the desired quality level of the playback.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.\n *\n * Configuration options - {@link LevelSelectorPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * levelSelector: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
2180
|
+
"docComment": "/**\n * `PLUGIN` that provides a UI to select the desired quality level of the playback.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.\n *\n * Configuration options - {@link LevelSelectorPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * levelSelector: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
2396
2181
|
"excerptTokens": [
|
|
2397
2182
|
{
|
|
2398
2183
|
"kind": "Content",
|
|
@@ -2531,7 +2316,7 @@
|
|
|
2531
2316
|
{
|
|
2532
2317
|
"kind": "Class",
|
|
2533
2318
|
"canonicalReference": "@gcorevideo/player!Logo:class",
|
|
2534
|
-
"docComment": "/**\n *
|
|
2319
|
+
"docComment": "/**\n * `PLUGIN` that adds custom logo to the player.\n *\n * @beta\n */\n",
|
|
2535
2320
|
"excerptTokens": [
|
|
2536
2321
|
{
|
|
2537
2322
|
"kind": "Content",
|
|
@@ -2809,7 +2594,7 @@
|
|
|
2809
2594
|
{
|
|
2810
2595
|
"kind": "Class",
|
|
2811
2596
|
"canonicalReference": "@gcorevideo/player!MediaControl:class",
|
|
2812
|
-
"docComment": "/**\n * PLUGIN that provides a foundation for developing custom media controls UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other
|
|
2597
|
+
"docComment": "/**\n * `PLUGIN` that provides a foundation for developing custom media controls UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other `PLUGIN` that depends on it.\n *\n * @example\n * ```ts\n * Player.registerPlugin(MediaControl) // <--- This must go first\n * Player.registerPlugin(LevelSelector) // a media control plugin\n * Player.registerPlugin(NerdStats) // another media control plugin\n * ```\n *\n * @beta\n */\n",
|
|
2813
2598
|
"excerptTokens": [
|
|
2814
2599
|
{
|
|
2815
2600
|
"kind": "Content",
|
|
@@ -3018,6 +2803,37 @@
|
|
|
3018
2803
|
"isAbstract": false,
|
|
3019
2804
|
"name": "enableControlButton"
|
|
3020
2805
|
},
|
|
2806
|
+
{
|
|
2807
|
+
"kind": "Method",
|
|
2808
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#getCenterPanel:member(1)",
|
|
2809
|
+
"docComment": "",
|
|
2810
|
+
"excerptTokens": [
|
|
2811
|
+
{
|
|
2812
|
+
"kind": "Content",
|
|
2813
|
+
"text": "getCenterPanel(): "
|
|
2814
|
+
},
|
|
2815
|
+
{
|
|
2816
|
+
"kind": "Content",
|
|
2817
|
+
"text": "any"
|
|
2818
|
+
},
|
|
2819
|
+
{
|
|
2820
|
+
"kind": "Content",
|
|
2821
|
+
"text": ";"
|
|
2822
|
+
}
|
|
2823
|
+
],
|
|
2824
|
+
"isStatic": false,
|
|
2825
|
+
"returnTypeTokenRange": {
|
|
2826
|
+
"startIndex": 1,
|
|
2827
|
+
"endIndex": 2
|
|
2828
|
+
},
|
|
2829
|
+
"releaseTag": "Beta",
|
|
2830
|
+
"isProtected": false,
|
|
2831
|
+
"overloadIndex": 1,
|
|
2832
|
+
"parameters": [],
|
|
2833
|
+
"isOptional": false,
|
|
2834
|
+
"isAbstract": false,
|
|
2835
|
+
"name": "getCenterPanel"
|
|
2836
|
+
},
|
|
3021
2837
|
{
|
|
3022
2838
|
"kind": "Method",
|
|
3023
2839
|
"canonicalReference": "@gcorevideo/player!MediaControl#getElement:member(1)",
|
|
@@ -3072,6 +2888,37 @@
|
|
|
3072
2888
|
"isAbstract": false,
|
|
3073
2889
|
"name": "getElement"
|
|
3074
2890
|
},
|
|
2891
|
+
{
|
|
2892
|
+
"kind": "Method",
|
|
2893
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#getLeftPanel:member(1)",
|
|
2894
|
+
"docComment": "/**\n * Get the left panel area to append custom elements to\n *\n * @returns ZeptoSelector of the left panel element\n */\n",
|
|
2895
|
+
"excerptTokens": [
|
|
2896
|
+
{
|
|
2897
|
+
"kind": "Content",
|
|
2898
|
+
"text": "getLeftPanel(): "
|
|
2899
|
+
},
|
|
2900
|
+
{
|
|
2901
|
+
"kind": "Content",
|
|
2902
|
+
"text": "any"
|
|
2903
|
+
},
|
|
2904
|
+
{
|
|
2905
|
+
"kind": "Content",
|
|
2906
|
+
"text": ";"
|
|
2907
|
+
}
|
|
2908
|
+
],
|
|
2909
|
+
"isStatic": false,
|
|
2910
|
+
"returnTypeTokenRange": {
|
|
2911
|
+
"startIndex": 1,
|
|
2912
|
+
"endIndex": 2
|
|
2913
|
+
},
|
|
2914
|
+
"releaseTag": "Beta",
|
|
2915
|
+
"isProtected": false,
|
|
2916
|
+
"overloadIndex": 1,
|
|
2917
|
+
"parameters": [],
|
|
2918
|
+
"isOptional": false,
|
|
2919
|
+
"isAbstract": false,
|
|
2920
|
+
"name": "getLeftPanel"
|
|
2921
|
+
},
|
|
3075
2922
|
{
|
|
3076
2923
|
"kind": "Method",
|
|
3077
2924
|
"canonicalReference": "@gcorevideo/player!MediaControl#getRightPanel:member(1)",
|
|
@@ -3329,36 +3176,10 @@
|
|
|
3329
3176
|
}
|
|
3330
3177
|
]
|
|
3331
3178
|
},
|
|
3332
|
-
{
|
|
3333
|
-
"kind": "TypeAlias",
|
|
3334
|
-
"canonicalReference": "@gcorevideo/player!MediaTransport:type",
|
|
3335
|
-
"docComment": "/**\n * Media delivery protocol\n *\n * @beta\n */\n",
|
|
3336
|
-
"excerptTokens": [
|
|
3337
|
-
{
|
|
3338
|
-
"kind": "Content",
|
|
3339
|
-
"text": "export type MediaTransport = "
|
|
3340
|
-
},
|
|
3341
|
-
{
|
|
3342
|
-
"kind": "Content",
|
|
3343
|
-
"text": "'dash' | 'hls'"
|
|
3344
|
-
},
|
|
3345
|
-
{
|
|
3346
|
-
"kind": "Content",
|
|
3347
|
-
"text": ";"
|
|
3348
|
-
}
|
|
3349
|
-
],
|
|
3350
|
-
"fileUrlPath": "src/types.ts",
|
|
3351
|
-
"releaseTag": "Beta",
|
|
3352
|
-
"name": "MediaTransport",
|
|
3353
|
-
"typeTokenRange": {
|
|
3354
|
-
"startIndex": 1,
|
|
3355
|
-
"endIndex": 2
|
|
3356
|
-
}
|
|
3357
|
-
},
|
|
3358
3179
|
{
|
|
3359
3180
|
"kind": "Class",
|
|
3360
3181
|
"canonicalReference": "@gcorevideo/player!MultiCamera:class",
|
|
3361
|
-
"docComment": "/**\n * PLUGIN that adds support for loading multiple streams and switching between them using the media control UI.\n *\n * @beta\n */\n",
|
|
3182
|
+
"docComment": "/**\n * `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.\n *\n * @beta\n */\n",
|
|
3362
3183
|
"excerptTokens": [
|
|
3363
3184
|
{
|
|
3364
3185
|
"kind": "Content",
|
|
@@ -3760,7 +3581,7 @@
|
|
|
3760
3581
|
{
|
|
3761
3582
|
"kind": "Class",
|
|
3762
3583
|
"canonicalReference": "@gcorevideo/player!PictureInPicture:class",
|
|
3763
|
-
"docComment": "/**\n *
|
|
3584
|
+
"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 * @beta\n */\n",
|
|
3764
3585
|
"excerptTokens": [
|
|
3765
3586
|
{
|
|
3766
3587
|
"kind": "Content",
|
|
@@ -3791,7 +3612,7 @@
|
|
|
3791
3612
|
{
|
|
3792
3613
|
"kind": "Interface",
|
|
3793
3614
|
"canonicalReference": "@gcorevideo/player!PlaybackError:interface",
|
|
3794
|
-
"docComment": "/**\n * An error occurred during the playback.\n *\n * @
|
|
3615
|
+
"docComment": "/**\n * An error occurred during the playback.\n *\n * @public\n */\n",
|
|
3795
3616
|
"excerptTokens": [
|
|
3796
3617
|
{
|
|
3797
3618
|
"kind": "Content",
|
|
@@ -3799,7 +3620,7 @@
|
|
|
3799
3620
|
}
|
|
3800
3621
|
],
|
|
3801
3622
|
"fileUrlPath": "src/playback.types.ts",
|
|
3802
|
-
"releaseTag": "
|
|
3623
|
+
"releaseTag": "Public",
|
|
3803
3624
|
"name": "PlaybackError",
|
|
3804
3625
|
"preserveMemberOrder": false,
|
|
3805
3626
|
"members": [
|
|
@@ -3824,7 +3645,7 @@
|
|
|
3824
3645
|
],
|
|
3825
3646
|
"isReadonly": false,
|
|
3826
3647
|
"isOptional": false,
|
|
3827
|
-
"releaseTag": "
|
|
3648
|
+
"releaseTag": "Public",
|
|
3828
3649
|
"name": "code",
|
|
3829
3650
|
"propertyTypeTokenRange": {
|
|
3830
3651
|
"startIndex": 1,
|
|
@@ -3851,7 +3672,7 @@
|
|
|
3851
3672
|
],
|
|
3852
3673
|
"isReadonly": false,
|
|
3853
3674
|
"isOptional": false,
|
|
3854
|
-
"releaseTag": "
|
|
3675
|
+
"releaseTag": "Public",
|
|
3855
3676
|
"name": "description",
|
|
3856
3677
|
"propertyTypeTokenRange": {
|
|
3857
3678
|
"startIndex": 1,
|
|
@@ -3879,7 +3700,7 @@
|
|
|
3879
3700
|
],
|
|
3880
3701
|
"isReadonly": false,
|
|
3881
3702
|
"isOptional": false,
|
|
3882
|
-
"releaseTag": "
|
|
3703
|
+
"releaseTag": "Public",
|
|
3883
3704
|
"name": "level",
|
|
3884
3705
|
"propertyTypeTokenRange": {
|
|
3885
3706
|
"startIndex": 1,
|
|
@@ -3906,7 +3727,7 @@
|
|
|
3906
3727
|
],
|
|
3907
3728
|
"isReadonly": false,
|
|
3908
3729
|
"isOptional": false,
|
|
3909
|
-
"releaseTag": "
|
|
3730
|
+
"releaseTag": "Public",
|
|
3910
3731
|
"name": "message",
|
|
3911
3732
|
"propertyTypeTokenRange": {
|
|
3912
3733
|
"startIndex": 1,
|
|
@@ -3933,7 +3754,7 @@
|
|
|
3933
3754
|
],
|
|
3934
3755
|
"isReadonly": false,
|
|
3935
3756
|
"isOptional": false,
|
|
3936
|
-
"releaseTag": "
|
|
3757
|
+
"releaseTag": "Public",
|
|
3937
3758
|
"name": "origin",
|
|
3938
3759
|
"propertyTypeTokenRange": {
|
|
3939
3760
|
"startIndex": 1,
|
|
@@ -3961,7 +3782,7 @@
|
|
|
3961
3782
|
],
|
|
3962
3783
|
"isReadonly": false,
|
|
3963
3784
|
"isOptional": false,
|
|
3964
|
-
"releaseTag": "
|
|
3785
|
+
"releaseTag": "Public",
|
|
3965
3786
|
"name": "scope",
|
|
3966
3787
|
"propertyTypeTokenRange": {
|
|
3967
3788
|
"startIndex": 1,
|
|
@@ -3979,7 +3800,7 @@
|
|
|
3979
3800
|
},
|
|
3980
3801
|
{
|
|
3981
3802
|
"kind": "Content",
|
|
3982
|
-
"text": "{\n title: string;\n message: string;\n }"
|
|
3803
|
+
"text": "{\n title: string;\n message: string;\n icon?: string;\n }"
|
|
3983
3804
|
},
|
|
3984
3805
|
{
|
|
3985
3806
|
"kind": "Content",
|
|
@@ -3988,7 +3809,7 @@
|
|
|
3988
3809
|
],
|
|
3989
3810
|
"isReadonly": false,
|
|
3990
3811
|
"isOptional": true,
|
|
3991
|
-
"releaseTag": "
|
|
3812
|
+
"releaseTag": "Public",
|
|
3992
3813
|
"name": "UI",
|
|
3993
3814
|
"propertyTypeTokenRange": {
|
|
3994
3815
|
"startIndex": 1,
|
|
@@ -4001,7 +3822,7 @@
|
|
|
4001
3822
|
{
|
|
4002
3823
|
"kind": "Enum",
|
|
4003
3824
|
"canonicalReference": "@gcorevideo/player!PlaybackErrorCode:enum",
|
|
4004
|
-
"docComment": "/**\n * Codes of errors occurring within the playback component.\n *\n * @
|
|
3825
|
+
"docComment": "/**\n * Codes of errors occurring within the playback component.\n *\n * @public\n */\n",
|
|
4005
3826
|
"excerptTokens": [
|
|
4006
3827
|
{
|
|
4007
3828
|
"kind": "Content",
|
|
@@ -4009,7 +3830,7 @@
|
|
|
4009
3830
|
}
|
|
4010
3831
|
],
|
|
4011
3832
|
"fileUrlPath": "src/playback.types.ts",
|
|
4012
|
-
"releaseTag": "
|
|
3833
|
+
"releaseTag": "Public",
|
|
4013
3834
|
"name": "PlaybackErrorCode",
|
|
4014
3835
|
"preserveMemberOrder": false,
|
|
4015
3836
|
"members": [
|
|
@@ -4031,7 +3852,7 @@
|
|
|
4031
3852
|
"startIndex": 1,
|
|
4032
3853
|
"endIndex": 2
|
|
4033
3854
|
},
|
|
4034
|
-
"releaseTag": "
|
|
3855
|
+
"releaseTag": "Public",
|
|
4035
3856
|
"name": "Generic"
|
|
4036
3857
|
},
|
|
4037
3858
|
{
|
|
@@ -4052,7 +3873,7 @@
|
|
|
4052
3873
|
"startIndex": 1,
|
|
4053
3874
|
"endIndex": 2
|
|
4054
3875
|
},
|
|
4055
|
-
"releaseTag": "
|
|
3876
|
+
"releaseTag": "Public",
|
|
4056
3877
|
"name": "MediaSourceAccessDenied"
|
|
4057
3878
|
},
|
|
4058
3879
|
{
|
|
@@ -4073,7 +3894,7 @@
|
|
|
4073
3894
|
"startIndex": 1,
|
|
4074
3895
|
"endIndex": 2
|
|
4075
3896
|
},
|
|
4076
|
-
"releaseTag": "
|
|
3897
|
+
"releaseTag": "Public",
|
|
4077
3898
|
"name": "MediaSourceUnavailable"
|
|
4078
3899
|
}
|
|
4079
3900
|
]
|
|
@@ -4081,7 +3902,7 @@
|
|
|
4081
3902
|
{
|
|
4082
3903
|
"kind": "TypeAlias",
|
|
4083
3904
|
"canonicalReference": "@gcorevideo/player!PlaybackModule:type",
|
|
4084
|
-
"docComment": "/**\n * Module to perform the playback.\n *\n * @
|
|
3905
|
+
"docComment": "/**\n * Module to perform the playback.\n *\n * @public\n */\n",
|
|
4085
3906
|
"excerptTokens": [
|
|
4086
3907
|
{
|
|
4087
3908
|
"kind": "Content",
|
|
@@ -4097,7 +3918,7 @@
|
|
|
4097
3918
|
}
|
|
4098
3919
|
],
|
|
4099
3920
|
"fileUrlPath": "src/Player.ts",
|
|
4100
|
-
"releaseTag": "
|
|
3921
|
+
"releaseTag": "Public",
|
|
4101
3922
|
"name": "PlaybackModule",
|
|
4102
3923
|
"typeTokenRange": {
|
|
4103
3924
|
"startIndex": 1,
|
|
@@ -4107,7 +3928,7 @@
|
|
|
4107
3928
|
{
|
|
4108
3929
|
"kind": "Class",
|
|
4109
3930
|
"canonicalReference": "@gcorevideo/player!PlaybackRate:class",
|
|
4110
|
-
"docComment": "/**\n * PLUGIN that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.\n *\n * @beta\n */\n",
|
|
3931
|
+
"docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.\n *\n * @beta\n */\n",
|
|
4111
3932
|
"excerptTokens": [
|
|
4112
3933
|
{
|
|
4113
3934
|
"kind": "Content",
|
|
@@ -4172,7 +3993,7 @@
|
|
|
4172
3993
|
{
|
|
4173
3994
|
"kind": "TypeAlias",
|
|
4174
3995
|
"canonicalReference": "@gcorevideo/player!PlaybackType:type",
|
|
4175
|
-
"docComment": "/**\n * Type of a stream
|
|
3996
|
+
"docComment": "/**\n * Type of a stream\n *\n * @public\n */\n",
|
|
4176
3997
|
"excerptTokens": [
|
|
4177
3998
|
{
|
|
4178
3999
|
"kind": "Content",
|
|
@@ -4188,7 +4009,7 @@
|
|
|
4188
4009
|
}
|
|
4189
4010
|
],
|
|
4190
4011
|
"fileUrlPath": "src/types.ts",
|
|
4191
|
-
"releaseTag": "
|
|
4012
|
+
"releaseTag": "Public",
|
|
4192
4013
|
"name": "PlaybackType",
|
|
4193
4014
|
"typeTokenRange": {
|
|
4194
4015
|
"startIndex": 1,
|
|
@@ -4198,7 +4019,7 @@
|
|
|
4198
4019
|
{
|
|
4199
4020
|
"kind": "Class",
|
|
4200
4021
|
"canonicalReference": "@gcorevideo/player!Player:class",
|
|
4201
|
-
"docComment": "/**\n *
|
|
4022
|
+
"docComment": "/**\n * `MAIN` component to use in the application code.\n *\n * @remarks\n *\n * The Player object provides very basic API to control playback. To build a sophisticated UI, use the plugins framework to tap into the Clappr core. {@link https://github.com/clappr/clappr/wiki/Architecture}\n *\n * @public\n */\n",
|
|
4202
4023
|
"excerptTokens": [
|
|
4203
4024
|
{
|
|
4204
4025
|
"kind": "Content",
|
|
@@ -4206,7 +4027,7 @@
|
|
|
4206
4027
|
}
|
|
4207
4028
|
],
|
|
4208
4029
|
"fileUrlPath": "src/Player.ts",
|
|
4209
|
-
"releaseTag": "
|
|
4030
|
+
"releaseTag": "Public",
|
|
4210
4031
|
"isAbstract": false,
|
|
4211
4032
|
"name": "Player",
|
|
4212
4033
|
"preserveMemberOrder": false,
|
|
@@ -4230,7 +4051,7 @@
|
|
|
4230
4051
|
"text": ");"
|
|
4231
4052
|
}
|
|
4232
4053
|
],
|
|
4233
|
-
"releaseTag": "
|
|
4054
|
+
"releaseTag": "Public",
|
|
4234
4055
|
"isProtected": false,
|
|
4235
4056
|
"overloadIndex": 1,
|
|
4236
4057
|
"parameters": [
|
|
@@ -4276,7 +4097,7 @@
|
|
|
4276
4097
|
"startIndex": 3,
|
|
4277
4098
|
"endIndex": 4
|
|
4278
4099
|
},
|
|
4279
|
-
"releaseTag": "
|
|
4100
|
+
"releaseTag": "Public",
|
|
4280
4101
|
"isProtected": false,
|
|
4281
4102
|
"overloadIndex": 1,
|
|
4282
4103
|
"parameters": [
|
|
@@ -4338,7 +4159,7 @@
|
|
|
4338
4159
|
"startIndex": 6,
|
|
4339
4160
|
"endIndex": 7
|
|
4340
4161
|
},
|
|
4341
|
-
"releaseTag": "
|
|
4162
|
+
"releaseTag": "Public",
|
|
4342
4163
|
"isProtected": false,
|
|
4343
4164
|
"overloadIndex": 1,
|
|
4344
4165
|
"parameters": [
|
|
@@ -4378,7 +4199,7 @@
|
|
|
4378
4199
|
"startIndex": 1,
|
|
4379
4200
|
"endIndex": 2
|
|
4380
4201
|
},
|
|
4381
|
-
"releaseTag": "
|
|
4202
|
+
"releaseTag": "Public",
|
|
4382
4203
|
"isProtected": false,
|
|
4383
4204
|
"overloadIndex": 1,
|
|
4384
4205
|
"parameters": [],
|
|
@@ -4409,7 +4230,7 @@
|
|
|
4409
4230
|
"startIndex": 1,
|
|
4410
4231
|
"endIndex": 2
|
|
4411
4232
|
},
|
|
4412
|
-
"releaseTag": "
|
|
4233
|
+
"releaseTag": "Public",
|
|
4413
4234
|
"isProtected": false,
|
|
4414
4235
|
"overloadIndex": 1,
|
|
4415
4236
|
"parameters": [],
|
|
@@ -4440,7 +4261,7 @@
|
|
|
4440
4261
|
"startIndex": 1,
|
|
4441
4262
|
"endIndex": 2
|
|
4442
4263
|
},
|
|
4443
|
-
"releaseTag": "
|
|
4264
|
+
"releaseTag": "Public",
|
|
4444
4265
|
"isProtected": false,
|
|
4445
4266
|
"overloadIndex": 1,
|
|
4446
4267
|
"parameters": [],
|
|
@@ -4471,7 +4292,7 @@
|
|
|
4471
4292
|
"startIndex": 1,
|
|
4472
4293
|
"endIndex": 2
|
|
4473
4294
|
},
|
|
4474
|
-
"releaseTag": "
|
|
4295
|
+
"releaseTag": "Public",
|
|
4475
4296
|
"isProtected": false,
|
|
4476
4297
|
"overloadIndex": 1,
|
|
4477
4298
|
"parameters": [],
|
|
@@ -4502,7 +4323,7 @@
|
|
|
4502
4323
|
"startIndex": 1,
|
|
4503
4324
|
"endIndex": 2
|
|
4504
4325
|
},
|
|
4505
|
-
"releaseTag": "
|
|
4326
|
+
"releaseTag": "Public",
|
|
4506
4327
|
"isProtected": false,
|
|
4507
4328
|
"overloadIndex": 1,
|
|
4508
4329
|
"parameters": [],
|
|
@@ -4533,7 +4354,7 @@
|
|
|
4533
4354
|
"startIndex": 1,
|
|
4534
4355
|
"endIndex": 2
|
|
4535
4356
|
},
|
|
4536
|
-
"releaseTag": "
|
|
4357
|
+
"releaseTag": "Public",
|
|
4537
4358
|
"isProtected": false,
|
|
4538
4359
|
"overloadIndex": 1,
|
|
4539
4360
|
"parameters": [],
|
|
@@ -4564,7 +4385,7 @@
|
|
|
4564
4385
|
"startIndex": 1,
|
|
4565
4386
|
"endIndex": 2
|
|
4566
4387
|
},
|
|
4567
|
-
"releaseTag": "
|
|
4388
|
+
"releaseTag": "Public",
|
|
4568
4389
|
"isProtected": false,
|
|
4569
4390
|
"overloadIndex": 1,
|
|
4570
4391
|
"parameters": [],
|
|
@@ -4595,7 +4416,7 @@
|
|
|
4595
4416
|
"startIndex": 1,
|
|
4596
4417
|
"endIndex": 2
|
|
4597
4418
|
},
|
|
4598
|
-
"releaseTag": "
|
|
4419
|
+
"releaseTag": "Public",
|
|
4599
4420
|
"isProtected": false,
|
|
4600
4421
|
"overloadIndex": 1,
|
|
4601
4422
|
"parameters": [],
|
|
@@ -4626,7 +4447,7 @@
|
|
|
4626
4447
|
"startIndex": 1,
|
|
4627
4448
|
"endIndex": 2
|
|
4628
4449
|
},
|
|
4629
|
-
"releaseTag": "
|
|
4450
|
+
"releaseTag": "Public",
|
|
4630
4451
|
"isProtected": false,
|
|
4631
4452
|
"overloadIndex": 1,
|
|
4632
4453
|
"parameters": [],
|
|
@@ -4700,7 +4521,7 @@
|
|
|
4700
4521
|
"startIndex": 8,
|
|
4701
4522
|
"endIndex": 9
|
|
4702
4523
|
},
|
|
4703
|
-
"releaseTag": "
|
|
4524
|
+
"releaseTag": "Public",
|
|
4704
4525
|
"isProtected": false,
|
|
4705
4526
|
"overloadIndex": 1,
|
|
4706
4527
|
"parameters": [
|
|
@@ -4791,7 +4612,7 @@
|
|
|
4791
4612
|
"startIndex": 8,
|
|
4792
4613
|
"endIndex": 9
|
|
4793
4614
|
},
|
|
4794
|
-
"releaseTag": "
|
|
4615
|
+
"releaseTag": "Public",
|
|
4795
4616
|
"isProtected": false,
|
|
4796
4617
|
"overloadIndex": 1,
|
|
4797
4618
|
"parameters": [
|
|
@@ -4839,7 +4660,7 @@
|
|
|
4839
4660
|
"startIndex": 1,
|
|
4840
4661
|
"endIndex": 2
|
|
4841
4662
|
},
|
|
4842
|
-
"releaseTag": "
|
|
4663
|
+
"releaseTag": "Public",
|
|
4843
4664
|
"isProtected": false,
|
|
4844
4665
|
"overloadIndex": 1,
|
|
4845
4666
|
"parameters": [],
|
|
@@ -4870,7 +4691,7 @@
|
|
|
4870
4691
|
"startIndex": 1,
|
|
4871
4692
|
"endIndex": 2
|
|
4872
4693
|
},
|
|
4873
|
-
"releaseTag": "
|
|
4694
|
+
"releaseTag": "Public",
|
|
4874
4695
|
"isProtected": false,
|
|
4875
4696
|
"overloadIndex": 1,
|
|
4876
4697
|
"parameters": [],
|
|
@@ -4910,7 +4731,7 @@
|
|
|
4910
4731
|
"startIndex": 3,
|
|
4911
4732
|
"endIndex": 4
|
|
4912
4733
|
},
|
|
4913
|
-
"releaseTag": "
|
|
4734
|
+
"releaseTag": "Public",
|
|
4914
4735
|
"isProtected": false,
|
|
4915
4736
|
"overloadIndex": 1,
|
|
4916
4737
|
"parameters": [
|
|
@@ -4959,7 +4780,7 @@
|
|
|
4959
4780
|
"startIndex": 3,
|
|
4960
4781
|
"endIndex": 4
|
|
4961
4782
|
},
|
|
4962
|
-
"releaseTag": "
|
|
4783
|
+
"releaseTag": "Public",
|
|
4963
4784
|
"isProtected": false,
|
|
4964
4785
|
"overloadIndex": 1,
|
|
4965
4786
|
"parameters": [
|
|
@@ -5007,7 +4828,7 @@
|
|
|
5007
4828
|
"startIndex": 3,
|
|
5008
4829
|
"endIndex": 4
|
|
5009
4830
|
},
|
|
5010
|
-
"releaseTag": "
|
|
4831
|
+
"releaseTag": "Public",
|
|
5011
4832
|
"isProtected": false,
|
|
5012
4833
|
"overloadIndex": 1,
|
|
5013
4834
|
"parameters": [
|
|
@@ -5055,7 +4876,7 @@
|
|
|
5055
4876
|
"startIndex": 3,
|
|
5056
4877
|
"endIndex": 4
|
|
5057
4878
|
},
|
|
5058
|
-
"releaseTag": "
|
|
4879
|
+
"releaseTag": "Public",
|
|
5059
4880
|
"isProtected": false,
|
|
5060
4881
|
"overloadIndex": 1,
|
|
5061
4882
|
"parameters": [
|
|
@@ -5095,7 +4916,7 @@
|
|
|
5095
4916
|
"startIndex": 1,
|
|
5096
4917
|
"endIndex": 2
|
|
5097
4918
|
},
|
|
5098
|
-
"releaseTag": "
|
|
4919
|
+
"releaseTag": "Public",
|
|
5099
4920
|
"isProtected": false,
|
|
5100
4921
|
"overloadIndex": 1,
|
|
5101
4922
|
"parameters": [],
|
|
@@ -5126,7 +4947,7 @@
|
|
|
5126
4947
|
"startIndex": 1,
|
|
5127
4948
|
"endIndex": 2
|
|
5128
4949
|
},
|
|
5129
|
-
"releaseTag": "
|
|
4950
|
+
"releaseTag": "Public",
|
|
5130
4951
|
"isProtected": false,
|
|
5131
4952
|
"overloadIndex": 1,
|
|
5132
4953
|
"parameters": [],
|
|
@@ -5137,16 +4958,15 @@
|
|
|
5137
4958
|
{
|
|
5138
4959
|
"kind": "Method",
|
|
5139
4960
|
"canonicalReference": "@gcorevideo/player!Player.unregisterPlugin:member(1)",
|
|
5140
|
-
"docComment": "/**\n * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.\n *\n * @
|
|
4961
|
+
"docComment": "/**\n * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.\n *\n * @remarks\n *\n * It can be also used to unregister a built-in default plugin.\n *\n * Currently, the plugins that are always registered are:\n *\n * - {@link https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/strings/strings.js | 'strings'}, which supports internationalization of the player UI\n *\n * - {@link https://github.com/clappr/clappr-core/blob/3126c3a38a6eee9d5aba3918b194e6380fa1178c/src/plugins/sources/sources.js | 'sources'}, which lets to specify multiple media sources and selects the first suitable playback module\n *\n * @param name - name of the plugin\n */\n",
|
|
5141
4962
|
"excerptTokens": [
|
|
5142
4963
|
{
|
|
5143
4964
|
"kind": "Content",
|
|
5144
|
-
"text": "static unregisterPlugin(
|
|
4965
|
+
"text": "static unregisterPlugin(name: "
|
|
5145
4966
|
},
|
|
5146
4967
|
{
|
|
5147
|
-
"kind": "
|
|
5148
|
-
"text": "
|
|
5149
|
-
"canonicalReference": "@gcorevideo/player!PlayerPluginConstructor:type"
|
|
4968
|
+
"kind": "Content",
|
|
4969
|
+
"text": "string"
|
|
5150
4970
|
},
|
|
5151
4971
|
{
|
|
5152
4972
|
"kind": "Content",
|
|
@@ -5166,12 +4986,12 @@
|
|
|
5166
4986
|
"startIndex": 3,
|
|
5167
4987
|
"endIndex": 4
|
|
5168
4988
|
},
|
|
5169
|
-
"releaseTag": "
|
|
4989
|
+
"releaseTag": "Public",
|
|
5170
4990
|
"isProtected": false,
|
|
5171
4991
|
"overloadIndex": 1,
|
|
5172
4992
|
"parameters": [
|
|
5173
4993
|
{
|
|
5174
|
-
"parameterName": "
|
|
4994
|
+
"parameterName": "name",
|
|
5175
4995
|
"parameterTypeTokenRange": {
|
|
5176
4996
|
"startIndex": 1,
|
|
5177
4997
|
"endIndex": 2
|
|
@@ -5189,7 +5009,7 @@
|
|
|
5189
5009
|
{
|
|
5190
5010
|
"kind": "TypeAlias",
|
|
5191
5011
|
"canonicalReference": "@gcorevideo/player!PlayerComponentType:type",
|
|
5192
|
-
"docComment": "/**\n * Subsystems of a player component.\n *\n * @
|
|
5012
|
+
"docComment": "/**\n * Subsystems of a player component.\n *\n * @public\n */\n",
|
|
5193
5013
|
"excerptTokens": [
|
|
5194
5014
|
{
|
|
5195
5015
|
"kind": "Content",
|
|
@@ -5205,7 +5025,7 @@
|
|
|
5205
5025
|
}
|
|
5206
5026
|
],
|
|
5207
5027
|
"fileUrlPath": "src/playback.types.ts",
|
|
5208
|
-
"releaseTag": "
|
|
5028
|
+
"releaseTag": "Public",
|
|
5209
5029
|
"name": "PlayerComponentType",
|
|
5210
5030
|
"typeTokenRange": {
|
|
5211
5031
|
"startIndex": 1,
|
|
@@ -5215,7 +5035,7 @@
|
|
|
5215
5035
|
{
|
|
5216
5036
|
"kind": "Interface",
|
|
5217
5037
|
"canonicalReference": "@gcorevideo/player!PlayerConfig:interface",
|
|
5218
|
-
"docComment": "/**\n * Configuration options for the player\n *\n * @remarks\n *\n * You can specify multiple sources, each in two forms: just a plain URL or a full object with `source` and `mimeType` fields {@link PlayerMediaSource}. The player will pick the first viable media source according to the source availability, and either the transport preference or standard transport selection order.\n *\n * `priorityTransport` is used to specify the preferred transport protocol when multiple sources are available. It will first try to use the transport specified if it's supported (by a playback engine) and the source is available. Otherwise it will try the other transports in the regular order (dash, hls, mpegts).\n *\n * The `autoPlay` option should be used together with the {@link PlayerConfig.mute | mute} to avoid issues with the browsers' autoplay policies.\n *\n * Note that the `playbackType` is specified explicitly in the examle below, but a playback engine might be able to detect the type of the stream automatically.\n *\n * A plugin options can be specified in the configuration object under a unique key, typically corresponding to the plugin name. The plugin object will have access to the internal normalized configuration object that contains all the custom options. in the examle below, the `poster` field is the `Poster` plugin configuration options.\n *\n * @example\n * ```ts\n * {\n * autoPlay: true,\n * mute: true,\n * playbackType: 'live',\n * priorityTransport: 'dash',\n * sources: [{\n * source: 'https://example.com/myownair66.mpd',\n * mimeType: 'application/dash+xml',\n * }, {\n * source: 'https://example.com/myownair66.m3u8',\n * mimeType: 'application/x-mpegURL',\n * }],\n * poster: {\n * url: settings.poster,\n * },\n * }\n * ```\n *\n * @
|
|
5038
|
+
"docComment": "/**\n * Configuration options for the player\n *\n * @remarks\n *\n * You can specify multiple sources, each in two forms: just a plain URL or a full object with `source` and `mimeType` fields {@link PlayerMediaSource}. The player will pick the first viable media source according to the source availability, and either the transport preference or standard transport selection order.\n *\n * `priorityTransport` is used to specify the preferred transport protocol when multiple sources are available. It will first try to use the transport specified if it's supported (by a playback engine) and the source is available. Otherwise it will try the other transports in the regular order (dash, hls, mpegts).\n *\n * The `autoPlay` option should be used together with the {@link PlayerConfig.mute | mute} to avoid issues with the browsers' autoplay policies.\n *\n * Note that the `playbackType` is specified explicitly in the examle below, but a playback engine might be able to detect the type of the stream automatically.\n *\n * A plugin options can be specified in the configuration object under a unique key, typically corresponding to the plugin name. The plugin object will have access to the internal normalized configuration object that contains all the custom options. in the examle below, the `poster` field is the `Poster` plugin configuration options.\n *\n * @example\n * ```ts\n * {\n * autoPlay: true,\n * mute: true,\n * playbackType: 'live',\n * priorityTransport: 'dash',\n * sources: [{\n * source: 'https://example.com/myownair66.mpd',\n * mimeType: 'application/dash+xml',\n * }, {\n * source: 'https://example.com/myownair66.m3u8',\n * mimeType: 'application/x-mpegURL',\n * }],\n * poster: {\n * url: settings.poster,\n * },\n * }\n * ```\n *\n * @public\n */\n",
|
|
5219
5039
|
"excerptTokens": [
|
|
5220
5040
|
{
|
|
5221
5041
|
"kind": "Content",
|
|
@@ -5236,7 +5056,7 @@
|
|
|
5236
5056
|
}
|
|
5237
5057
|
],
|
|
5238
5058
|
"fileUrlPath": "src/types.ts",
|
|
5239
|
-
"releaseTag": "
|
|
5059
|
+
"releaseTag": "Public",
|
|
5240
5060
|
"name": "PlayerConfig",
|
|
5241
5061
|
"preserveMemberOrder": false,
|
|
5242
5062
|
"members": [
|
|
@@ -5260,7 +5080,7 @@
|
|
|
5260
5080
|
],
|
|
5261
5081
|
"isReadonly": false,
|
|
5262
5082
|
"isOptional": true,
|
|
5263
|
-
"releaseTag": "
|
|
5083
|
+
"releaseTag": "Public",
|
|
5264
5084
|
"name": "autoPlay",
|
|
5265
5085
|
"propertyTypeTokenRange": {
|
|
5266
5086
|
"startIndex": 1,
|
|
@@ -5288,7 +5108,7 @@
|
|
|
5288
5108
|
],
|
|
5289
5109
|
"isReadonly": false,
|
|
5290
5110
|
"isOptional": true,
|
|
5291
|
-
"releaseTag": "
|
|
5111
|
+
"releaseTag": "Public",
|
|
5292
5112
|
"name": "dash",
|
|
5293
5113
|
"propertyTypeTokenRange": {
|
|
5294
5114
|
"startIndex": 1,
|
|
@@ -5316,7 +5136,7 @@
|
|
|
5316
5136
|
],
|
|
5317
5137
|
"isReadonly": false,
|
|
5318
5138
|
"isOptional": true,
|
|
5319
|
-
"releaseTag": "
|
|
5139
|
+
"releaseTag": "Public",
|
|
5320
5140
|
"name": "debug",
|
|
5321
5141
|
"propertyTypeTokenRange": {
|
|
5322
5142
|
"startIndex": 1,
|
|
@@ -5343,7 +5163,7 @@
|
|
|
5343
5163
|
],
|
|
5344
5164
|
"isReadonly": false,
|
|
5345
5165
|
"isOptional": true,
|
|
5346
|
-
"releaseTag": "
|
|
5166
|
+
"releaseTag": "Public",
|
|
5347
5167
|
"name": "language",
|
|
5348
5168
|
"propertyTypeTokenRange": {
|
|
5349
5169
|
"startIndex": 1,
|
|
@@ -5370,7 +5190,7 @@
|
|
|
5370
5190
|
],
|
|
5371
5191
|
"isReadonly": false,
|
|
5372
5192
|
"isOptional": true,
|
|
5373
|
-
"releaseTag": "
|
|
5193
|
+
"releaseTag": "Public",
|
|
5374
5194
|
"name": "loop",
|
|
5375
5195
|
"propertyTypeTokenRange": {
|
|
5376
5196
|
"startIndex": 1,
|
|
@@ -5397,7 +5217,7 @@
|
|
|
5397
5217
|
],
|
|
5398
5218
|
"isReadonly": false,
|
|
5399
5219
|
"isOptional": true,
|
|
5400
|
-
"releaseTag": "
|
|
5220
|
+
"releaseTag": "Public",
|
|
5401
5221
|
"name": "mute",
|
|
5402
5222
|
"propertyTypeTokenRange": {
|
|
5403
5223
|
"startIndex": 1,
|
|
@@ -5425,7 +5245,7 @@
|
|
|
5425
5245
|
],
|
|
5426
5246
|
"isReadonly": false,
|
|
5427
5247
|
"isOptional": true,
|
|
5428
|
-
"releaseTag": "
|
|
5248
|
+
"releaseTag": "Public",
|
|
5429
5249
|
"name": "playbackType",
|
|
5430
5250
|
"propertyTypeTokenRange": {
|
|
5431
5251
|
"startIndex": 1,
|
|
@@ -5453,7 +5273,7 @@
|
|
|
5453
5273
|
],
|
|
5454
5274
|
"isReadonly": false,
|
|
5455
5275
|
"isOptional": true,
|
|
5456
|
-
"releaseTag": "
|
|
5276
|
+
"releaseTag": "Public",
|
|
5457
5277
|
"name": "priorityTransport",
|
|
5458
5278
|
"propertyTypeTokenRange": {
|
|
5459
5279
|
"startIndex": 1,
|
|
@@ -5485,7 +5305,7 @@
|
|
|
5485
5305
|
],
|
|
5486
5306
|
"isReadonly": false,
|
|
5487
5307
|
"isOptional": false,
|
|
5488
|
-
"releaseTag": "
|
|
5308
|
+
"releaseTag": "Public",
|
|
5489
5309
|
"name": "sources",
|
|
5490
5310
|
"propertyTypeTokenRange": {
|
|
5491
5311
|
"startIndex": 1,
|
|
@@ -5513,7 +5333,7 @@
|
|
|
5513
5333
|
],
|
|
5514
5334
|
"isReadonly": false,
|
|
5515
5335
|
"isOptional": true,
|
|
5516
|
-
"releaseTag": "
|
|
5336
|
+
"releaseTag": "Public",
|
|
5517
5337
|
"name": "strings",
|
|
5518
5338
|
"propertyTypeTokenRange": {
|
|
5519
5339
|
"startIndex": 1,
|
|
@@ -5531,7 +5351,7 @@
|
|
|
5531
5351
|
{
|
|
5532
5352
|
"kind": "TypeAlias",
|
|
5533
5353
|
"canonicalReference": "@gcorevideo/player!PlayerDebugSettings:type",
|
|
5534
|
-
"docComment": "/**\n * @remarks\n *\n * `true` is equivalent to `'all'`, `false` is equivalent to `'none'`\n *\n * @
|
|
5354
|
+
"docComment": "/**\n * @remarks\n *\n * `true` is equivalent to `'all'`, `false` is equivalent to `'none'`\n *\n * @public\n */\n",
|
|
5535
5355
|
"excerptTokens": [
|
|
5536
5356
|
{
|
|
5537
5357
|
"kind": "Content",
|
|
@@ -5552,7 +5372,7 @@
|
|
|
5552
5372
|
}
|
|
5553
5373
|
],
|
|
5554
5374
|
"fileUrlPath": "src/types.ts",
|
|
5555
|
-
"releaseTag": "
|
|
5375
|
+
"releaseTag": "Public",
|
|
5556
5376
|
"name": "PlayerDebugSettings",
|
|
5557
5377
|
"typeTokenRange": {
|
|
5558
5378
|
"startIndex": 1,
|
|
@@ -5562,7 +5382,7 @@
|
|
|
5562
5382
|
{
|
|
5563
5383
|
"kind": "TypeAlias",
|
|
5564
5384
|
"canonicalReference": "@gcorevideo/player!PlayerDebugTag:type",
|
|
5565
|
-
"docComment": "/**\n * Debug output category selector\n *\n * @
|
|
5385
|
+
"docComment": "/**\n * Debug output category selector\n *\n * @public\n */\n",
|
|
5566
5386
|
"excerptTokens": [
|
|
5567
5387
|
{
|
|
5568
5388
|
"kind": "Content",
|
|
@@ -5578,7 +5398,7 @@
|
|
|
5578
5398
|
}
|
|
5579
5399
|
],
|
|
5580
5400
|
"fileUrlPath": "src/types.ts",
|
|
5581
|
-
"releaseTag": "
|
|
5401
|
+
"releaseTag": "Public",
|
|
5582
5402
|
"name": "PlayerDebugTag",
|
|
5583
5403
|
"typeTokenRange": {
|
|
5584
5404
|
"startIndex": 1,
|
|
@@ -5588,7 +5408,7 @@
|
|
|
5588
5408
|
{
|
|
5589
5409
|
"kind": "Enum",
|
|
5590
5410
|
"canonicalReference": "@gcorevideo/player!PlayerEvent:enum",
|
|
5591
|
-
"docComment": "/**\n * A top-level event on the player object\n *\n * @
|
|
5411
|
+
"docComment": "/**\n * A top-level event on the player object\n *\n * @public\n */\n",
|
|
5592
5412
|
"excerptTokens": [
|
|
5593
5413
|
{
|
|
5594
5414
|
"kind": "Content",
|
|
@@ -5596,7 +5416,7 @@
|
|
|
5596
5416
|
}
|
|
5597
5417
|
],
|
|
5598
5418
|
"fileUrlPath": "src/types.ts",
|
|
5599
|
-
"releaseTag": "
|
|
5419
|
+
"releaseTag": "Public",
|
|
5600
5420
|
"name": "PlayerEvent",
|
|
5601
5421
|
"preserveMemberOrder": false,
|
|
5602
5422
|
"members": [
|
|
@@ -5618,7 +5438,7 @@
|
|
|
5618
5438
|
"startIndex": 1,
|
|
5619
5439
|
"endIndex": 2
|
|
5620
5440
|
},
|
|
5621
|
-
"releaseTag": "
|
|
5441
|
+
"releaseTag": "Public",
|
|
5622
5442
|
"name": "Ended"
|
|
5623
5443
|
},
|
|
5624
5444
|
{
|
|
@@ -5639,7 +5459,7 @@
|
|
|
5639
5459
|
"startIndex": 1,
|
|
5640
5460
|
"endIndex": 2
|
|
5641
5461
|
},
|
|
5642
|
-
"releaseTag": "
|
|
5462
|
+
"releaseTag": "Public",
|
|
5643
5463
|
"name": "Error"
|
|
5644
5464
|
},
|
|
5645
5465
|
{
|
|
@@ -5660,7 +5480,7 @@
|
|
|
5660
5480
|
"startIndex": 1,
|
|
5661
5481
|
"endIndex": 2
|
|
5662
5482
|
},
|
|
5663
|
-
"releaseTag": "
|
|
5483
|
+
"releaseTag": "Public",
|
|
5664
5484
|
"name": "Fullscreen"
|
|
5665
5485
|
},
|
|
5666
5486
|
{
|
|
@@ -5681,7 +5501,7 @@
|
|
|
5681
5501
|
"startIndex": 1,
|
|
5682
5502
|
"endIndex": 2
|
|
5683
5503
|
},
|
|
5684
|
-
"releaseTag": "
|
|
5504
|
+
"releaseTag": "Public",
|
|
5685
5505
|
"name": "Pause"
|
|
5686
5506
|
},
|
|
5687
5507
|
{
|
|
@@ -5702,7 +5522,7 @@
|
|
|
5702
5522
|
"startIndex": 1,
|
|
5703
5523
|
"endIndex": 2
|
|
5704
5524
|
},
|
|
5705
|
-
"releaseTag": "
|
|
5525
|
+
"releaseTag": "Public",
|
|
5706
5526
|
"name": "Play"
|
|
5707
5527
|
},
|
|
5708
5528
|
{
|
|
@@ -5723,7 +5543,7 @@
|
|
|
5723
5543
|
"startIndex": 1,
|
|
5724
5544
|
"endIndex": 2
|
|
5725
5545
|
},
|
|
5726
|
-
"releaseTag": "
|
|
5546
|
+
"releaseTag": "Public",
|
|
5727
5547
|
"name": "Ready"
|
|
5728
5548
|
},
|
|
5729
5549
|
{
|
|
@@ -5744,7 +5564,7 @@
|
|
|
5744
5564
|
"startIndex": 1,
|
|
5745
5565
|
"endIndex": 2
|
|
5746
5566
|
},
|
|
5747
|
-
"releaseTag": "
|
|
5567
|
+
"releaseTag": "Public",
|
|
5748
5568
|
"name": "Resize"
|
|
5749
5569
|
},
|
|
5750
5570
|
{
|
|
@@ -5765,7 +5585,7 @@
|
|
|
5765
5585
|
"startIndex": 1,
|
|
5766
5586
|
"endIndex": 2
|
|
5767
5587
|
},
|
|
5768
|
-
"releaseTag": "
|
|
5588
|
+
"releaseTag": "Public",
|
|
5769
5589
|
"name": "Seek"
|
|
5770
5590
|
},
|
|
5771
5591
|
{
|
|
@@ -5786,7 +5606,7 @@
|
|
|
5786
5606
|
"startIndex": 1,
|
|
5787
5607
|
"endIndex": 2
|
|
5788
5608
|
},
|
|
5789
|
-
"releaseTag": "
|
|
5609
|
+
"releaseTag": "Public",
|
|
5790
5610
|
"name": "Stop"
|
|
5791
5611
|
},
|
|
5792
5612
|
{
|
|
@@ -5807,7 +5627,7 @@
|
|
|
5807
5627
|
"startIndex": 1,
|
|
5808
5628
|
"endIndex": 2
|
|
5809
5629
|
},
|
|
5810
|
-
"releaseTag": "
|
|
5630
|
+
"releaseTag": "Public",
|
|
5811
5631
|
"name": "TimeUpdate"
|
|
5812
5632
|
},
|
|
5813
5633
|
{
|
|
@@ -5828,7 +5648,7 @@
|
|
|
5828
5648
|
"startIndex": 1,
|
|
5829
5649
|
"endIndex": 2
|
|
5830
5650
|
},
|
|
5831
|
-
"releaseTag": "
|
|
5651
|
+
"releaseTag": "Public",
|
|
5832
5652
|
"name": "VolumeUpdate"
|
|
5833
5653
|
}
|
|
5834
5654
|
]
|
|
@@ -5836,7 +5656,7 @@
|
|
|
5836
5656
|
{
|
|
5837
5657
|
"kind": "TypeAlias",
|
|
5838
5658
|
"canonicalReference": "@gcorevideo/player!PlayerEventHandler:type",
|
|
5839
|
-
"docComment": "/**\n * Type of a listener callback function for a player event. See the description of the event parameters in {@link PlayerEvent}.\n *\n * @
|
|
5659
|
+
"docComment": "/**\n * Type of a listener callback function for a player event. See the description of the event parameters in {@link PlayerEvent}.\n *\n * @public\n */\n",
|
|
5840
5660
|
"excerptTokens": [
|
|
5841
5661
|
{
|
|
5842
5662
|
"kind": "Content",
|
|
@@ -5870,7 +5690,7 @@
|
|
|
5870
5690
|
}
|
|
5871
5691
|
],
|
|
5872
5692
|
"fileUrlPath": "src/Player.ts",
|
|
5873
|
-
"releaseTag": "
|
|
5693
|
+
"releaseTag": "Public",
|
|
5874
5694
|
"name": "PlayerEventHandler",
|
|
5875
5695
|
"typeParameters": [
|
|
5876
5696
|
{
|
|
@@ -5893,7 +5713,7 @@
|
|
|
5893
5713
|
{
|
|
5894
5714
|
"kind": "TypeAlias",
|
|
5895
5715
|
"canonicalReference": "@gcorevideo/player!PlayerEventParams:type",
|
|
5896
|
-
"docComment": "/**\n * @
|
|
5716
|
+
"docComment": "/**\n * @public\n */\n",
|
|
5897
5717
|
"excerptTokens": [
|
|
5898
5718
|
{
|
|
5899
5719
|
"kind": "Content",
|
|
@@ -5990,7 +5810,7 @@
|
|
|
5990
5810
|
}
|
|
5991
5811
|
],
|
|
5992
5812
|
"fileUrlPath": "src/Player.ts",
|
|
5993
|
-
"releaseTag": "
|
|
5813
|
+
"releaseTag": "Public",
|
|
5994
5814
|
"name": "PlayerEventParams",
|
|
5995
5815
|
"typeParameters": [
|
|
5996
5816
|
{
|
|
@@ -6013,7 +5833,7 @@
|
|
|
6013
5833
|
{
|
|
6014
5834
|
"kind": "TypeAlias",
|
|
6015
5835
|
"canonicalReference": "@gcorevideo/player!PlayerMediaSource:type",
|
|
6016
|
-
"docComment": "/**\n * A media source to fetch the media data from\n *\n * @
|
|
5836
|
+
"docComment": "/**\n * A media source to fetch the media data from\n *\n * @public\n */\n",
|
|
6017
5837
|
"excerptTokens": [
|
|
6018
5838
|
{
|
|
6019
5839
|
"kind": "Content",
|
|
@@ -6034,7 +5854,7 @@
|
|
|
6034
5854
|
}
|
|
6035
5855
|
],
|
|
6036
5856
|
"fileUrlPath": "src/types.ts",
|
|
6037
|
-
"releaseTag": "
|
|
5857
|
+
"releaseTag": "Public",
|
|
6038
5858
|
"name": "PlayerMediaSource",
|
|
6039
5859
|
"typeTokenRange": {
|
|
6040
5860
|
"startIndex": 1,
|
|
@@ -6044,7 +5864,7 @@
|
|
|
6044
5864
|
{
|
|
6045
5865
|
"kind": "Interface",
|
|
6046
5866
|
"canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc:interface",
|
|
6047
|
-
"docComment": "/**\n * Describes a media source with its MIME type and URL.\n *\n * @remarks\n *\n * When the MIME type is provided, it helps the player determine the appropriate playback engine. If omitted, the player will attempt to detect the type from the source URL extension.\n *\n * @
|
|
5867
|
+
"docComment": "/**\n * Describes a media source with its MIME type and URL.\n *\n * @remarks\n *\n * When the MIME type is provided, it helps the player determine the appropriate playback engine. If omitted, the player will attempt to detect the type from the source URL extension.\n *\n * @public\n */\n",
|
|
6048
5868
|
"excerptTokens": [
|
|
6049
5869
|
{
|
|
6050
5870
|
"kind": "Content",
|
|
@@ -6052,7 +5872,7 @@
|
|
|
6052
5872
|
}
|
|
6053
5873
|
],
|
|
6054
5874
|
"fileUrlPath": "src/types.ts",
|
|
6055
|
-
"releaseTag": "
|
|
5875
|
+
"releaseTag": "Public",
|
|
6056
5876
|
"name": "PlayerMediaSourceDesc",
|
|
6057
5877
|
"preserveMemberOrder": false,
|
|
6058
5878
|
"members": [
|
|
@@ -6076,7 +5896,7 @@
|
|
|
6076
5896
|
],
|
|
6077
5897
|
"isReadonly": false,
|
|
6078
5898
|
"isOptional": true,
|
|
6079
|
-
"releaseTag": "
|
|
5899
|
+
"releaseTag": "Public",
|
|
6080
5900
|
"name": "mimeType",
|
|
6081
5901
|
"propertyTypeTokenRange": {
|
|
6082
5902
|
"startIndex": 1,
|
|
@@ -6103,7 +5923,7 @@
|
|
|
6103
5923
|
],
|
|
6104
5924
|
"isReadonly": false,
|
|
6105
5925
|
"isOptional": false,
|
|
6106
|
-
"releaseTag": "
|
|
5926
|
+
"releaseTag": "Public",
|
|
6107
5927
|
"name": "source",
|
|
6108
5928
|
"propertyTypeTokenRange": {
|
|
6109
5929
|
"startIndex": 1,
|
|
@@ -6116,7 +5936,7 @@
|
|
|
6116
5936
|
{
|
|
6117
5937
|
"kind": "TypeAlias",
|
|
6118
5938
|
"canonicalReference": "@gcorevideo/player!PlayerPlugin:type",
|
|
6119
|
-
"docComment": "/**\n * @see\n *\n * {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}\n *\n * @
|
|
5939
|
+
"docComment": "/**\n * @see\n *\n * {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}\n *\n * @public\n */\n",
|
|
6120
5940
|
"excerptTokens": [
|
|
6121
5941
|
{
|
|
6122
5942
|
"kind": "Content",
|
|
@@ -6124,7 +5944,7 @@
|
|
|
6124
5944
|
},
|
|
6125
5945
|
{
|
|
6126
5946
|
"kind": "Content",
|
|
6127
|
-
"text": "{\n
|
|
5947
|
+
"text": "{\n name: string;\n}"
|
|
6128
5948
|
},
|
|
6129
5949
|
{
|
|
6130
5950
|
"kind": "Content",
|
|
@@ -6132,7 +5952,7 @@
|
|
|
6132
5952
|
}
|
|
6133
5953
|
],
|
|
6134
5954
|
"fileUrlPath": "src/types.ts",
|
|
6135
|
-
"releaseTag": "
|
|
5955
|
+
"releaseTag": "Public",
|
|
6136
5956
|
"name": "PlayerPlugin",
|
|
6137
5957
|
"typeTokenRange": {
|
|
6138
5958
|
"startIndex": 1,
|
|
@@ -6142,7 +5962,7 @@
|
|
|
6142
5962
|
{
|
|
6143
5963
|
"kind": "TypeAlias",
|
|
6144
5964
|
"canonicalReference": "@gcorevideo/player!PlayerPluginConstructor:type",
|
|
6145
|
-
"docComment": "/**\n * @
|
|
5965
|
+
"docComment": "/**\n * @public\n */\n",
|
|
6146
5966
|
"excerptTokens": [
|
|
6147
5967
|
{
|
|
6148
5968
|
"kind": "Content",
|
|
@@ -6168,7 +5988,7 @@
|
|
|
6168
5988
|
}
|
|
6169
5989
|
],
|
|
6170
5990
|
"fileUrlPath": "src/types.ts",
|
|
6171
|
-
"releaseTag": "
|
|
5991
|
+
"releaseTag": "Public",
|
|
6172
5992
|
"name": "PlayerPluginConstructor",
|
|
6173
5993
|
"typeTokenRange": {
|
|
6174
5994
|
"startIndex": 1,
|
|
@@ -6178,7 +5998,7 @@
|
|
|
6178
5998
|
{
|
|
6179
5999
|
"kind": "Class",
|
|
6180
6000
|
"canonicalReference": "@gcorevideo/player!Poster:class",
|
|
6181
|
-
"docComment": "/**\n *
|
|
6001
|
+
"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, media control UI is disabled.\n *\n * Configuration options:\n *\n * - `poster.custom` - custom CSS background\n *\n * - `poster.showForNoOp` - whether to show the poster when the playback is not started\n *\n * - `poster.url` - the URL of the poster image\n *\n * - `poster.showOnVideoEnd` - whether to show the poster when the playback is ended\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 * @beta\n */\n",
|
|
6182
6002
|
"excerptTokens": [
|
|
6183
6003
|
{
|
|
6184
6004
|
"kind": "Content",
|
|
@@ -6272,7 +6092,7 @@
|
|
|
6272
6092
|
{
|
|
6273
6093
|
"kind": "Interface",
|
|
6274
6094
|
"canonicalReference": "@gcorevideo/player!QualityLevel:interface",
|
|
6275
|
-
"docComment": "/**\n * A level of quality within a media source.\n *\n * @
|
|
6095
|
+
"docComment": "/**\n * A level of quality within a media source.\n *\n * @public\n */\n",
|
|
6276
6096
|
"excerptTokens": [
|
|
6277
6097
|
{
|
|
6278
6098
|
"kind": "Content",
|
|
@@ -6280,7 +6100,7 @@
|
|
|
6280
6100
|
}
|
|
6281
6101
|
],
|
|
6282
6102
|
"fileUrlPath": "src/playback.types.ts",
|
|
6283
|
-
"releaseTag": "
|
|
6103
|
+
"releaseTag": "Public",
|
|
6284
6104
|
"name": "QualityLevel",
|
|
6285
6105
|
"preserveMemberOrder": false,
|
|
6286
6106
|
"members": [
|
|
@@ -6304,7 +6124,7 @@
|
|
|
6304
6124
|
],
|
|
6305
6125
|
"isReadonly": false,
|
|
6306
6126
|
"isOptional": false,
|
|
6307
|
-
"releaseTag": "
|
|
6127
|
+
"releaseTag": "Public",
|
|
6308
6128
|
"name": "bitrate",
|
|
6309
6129
|
"propertyTypeTokenRange": {
|
|
6310
6130
|
"startIndex": 1,
|
|
@@ -6331,7 +6151,7 @@
|
|
|
6331
6151
|
],
|
|
6332
6152
|
"isReadonly": false,
|
|
6333
6153
|
"isOptional": false,
|
|
6334
|
-
"releaseTag": "
|
|
6154
|
+
"releaseTag": "Public",
|
|
6335
6155
|
"name": "height",
|
|
6336
6156
|
"propertyTypeTokenRange": {
|
|
6337
6157
|
"startIndex": 1,
|
|
@@ -6358,7 +6178,7 @@
|
|
|
6358
6178
|
],
|
|
6359
6179
|
"isReadonly": false,
|
|
6360
6180
|
"isOptional": false,
|
|
6361
|
-
"releaseTag": "
|
|
6181
|
+
"releaseTag": "Public",
|
|
6362
6182
|
"name": "level",
|
|
6363
6183
|
"propertyTypeTokenRange": {
|
|
6364
6184
|
"startIndex": 1,
|
|
@@ -6385,7 +6205,7 @@
|
|
|
6385
6205
|
],
|
|
6386
6206
|
"isReadonly": false,
|
|
6387
6207
|
"isOptional": false,
|
|
6388
|
-
"releaseTag": "
|
|
6208
|
+
"releaseTag": "Public",
|
|
6389
6209
|
"name": "width",
|
|
6390
6210
|
"propertyTypeTokenRange": {
|
|
6391
6211
|
"startIndex": 1,
|
|
@@ -6398,7 +6218,7 @@
|
|
|
6398
6218
|
{
|
|
6399
6219
|
"kind": "Class",
|
|
6400
6220
|
"canonicalReference": "@gcorevideo/player!SeekTime:class",
|
|
6401
|
-
"docComment": "/**\n *
|
|
6221
|
+
"docComment": "/**\n * `PLUGIN` that adds a seek time indicator to the media control UI.\n *\n * @beta\n */\n",
|
|
6402
6222
|
"excerptTokens": [
|
|
6403
6223
|
{
|
|
6404
6224
|
"kind": "Content",
|
|
@@ -6825,7 +6645,7 @@
|
|
|
6825
6645
|
{
|
|
6826
6646
|
"kind": "Class",
|
|
6827
6647
|
"canonicalReference": "@gcorevideo/player!Share:class",
|
|
6828
|
-
"docComment": "/**\n * PLUGIN that adds a share button to the media control UI.\n *\n * @beta\n */\n",
|
|
6648
|
+
"docComment": "/**\n * `PLUGIN` that adds a share button to the media control UI.\n *\n * @beta\n */\n",
|
|
6829
6649
|
"excerptTokens": [
|
|
6830
6650
|
{
|
|
6831
6651
|
"kind": "Content",
|
|
@@ -7410,7 +7230,7 @@
|
|
|
7410
7230
|
{
|
|
7411
7231
|
"kind": "Class",
|
|
7412
7232
|
"canonicalReference": "@gcorevideo/player!SkipTime:class",
|
|
7413
|
-
"docComment": "/**\n * PLUGIN that adds skip controls to the media control UI.\n *\n * @beta\n */\n",
|
|
7233
|
+
"docComment": "/**\n * `PLUGIN` that adds skip controls to the media control UI.\n *\n * @beta\n */\n",
|
|
7414
7234
|
"excerptTokens": [
|
|
7415
7235
|
{
|
|
7416
7236
|
"kind": "Content",
|
|
@@ -7839,7 +7659,7 @@
|
|
|
7839
7659
|
{
|
|
7840
7660
|
"kind": "Class",
|
|
7841
7661
|
"canonicalReference": "@gcorevideo/player!SourceController:class",
|
|
7842
|
-
"docComment": "/**\n *
|
|
7662
|
+
"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.\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 * @beta\n */\n",
|
|
7843
7663
|
"excerptTokens": [
|
|
7844
7664
|
{
|
|
7845
7665
|
"kind": "Content",
|
|
@@ -7942,7 +7762,7 @@
|
|
|
7942
7762
|
{
|
|
7943
7763
|
"kind": "Class",
|
|
7944
7764
|
"canonicalReference": "@gcorevideo/player!SpinnerThreeBounce:class",
|
|
7945
|
-
"docComment": "/**\n * PLUGIN that shows a pending operation indicator when playback is buffering or in a similar state\n *\n * @remarks\n *\n * Events emitted- {@link SpinnerEvents} Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to implement custom pending/progress indication scenarios.\n *\n * @beta\n */\n",
|
|
7765
|
+
"docComment": "/**\n * `PLUGIN` that shows a pending operation indicator when playback is buffering or in a similar state\n *\n * @remarks\n *\n * Events emitted- {@link SpinnerEvents} Other plugins can use {@link SpinnerThreeBounce.show | show} and {@link SpinnerThreeBounce.hide | hide} methods to implement custom pending/progress indication scenarios.\n *\n * @beta\n */\n",
|
|
7946
7766
|
"excerptTokens": [
|
|
7947
7767
|
{
|
|
7948
7768
|
"kind": "Content",
|
|
@@ -8259,7 +8079,7 @@
|
|
|
8259
8079
|
{
|
|
8260
8080
|
"kind": "Class",
|
|
8261
8081
|
"canonicalReference": "@gcorevideo/player!Subtitles:class",
|
|
8262
|
-
"docComment": "/**\n *
|
|
8082
|
+
"docComment": "/**\n * `PLUGIN` that provides a UI to select the subtitles when available.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options:\n *\n * - subtitles.language - The language of the subtitles to select by default.\n *\n * @example\n * ```ts\n * import { Subtitles } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Subtitles)\n *\n * new Player({\n * ...\n * subtitles: {\n * language: 'en',\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
8263
8083
|
"excerptTokens": [
|
|
8264
8084
|
{
|
|
8265
8085
|
"kind": "Content",
|
|
@@ -8353,7 +8173,7 @@
|
|
|
8353
8173
|
{
|
|
8354
8174
|
"kind": "Class",
|
|
8355
8175
|
"canonicalReference": "@gcorevideo/player!Telemetry:class",
|
|
8356
|
-
"docComment": "/**\n * PLUGIN that collects and reports the performance statistics.\n *\n * @remarks\n *\n * This plugin is experimental and its API is likely to change.\n *\n * Configuration options {@link TelemetryPluginSettings}\n *\n * @example\n * ```ts\n * import { Statistics } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Statistics)\n *\n * const player = new Player({\n * statistics: {\n * send: (data) => {\n * fetch('/stats', {\n * method: 'POST',\n * body: JSON.stringify(data),\n * headers: { 'content-type': 'application/json' },\n * })\n * },\n * },\n * ...\n * })\n * ```\n *\n * @beta\n */\n",
|
|
8176
|
+
"docComment": "/**\n * `PLUGIN` that collects and reports the performance statistics.\n *\n * @remarks\n *\n * This plugin is experimental and its API is likely to change.\n *\n * Configuration options {@link TelemetryPluginSettings}\n *\n * @example\n * ```ts\n * import { Statistics } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Statistics)\n *\n * const player = new Player({\n * statistics: {\n * send: (data) => {\n * fetch('/stats', {\n * method: 'POST',\n * body: JSON.stringify(data),\n * headers: { 'content-type': 'application/json' },\n * })\n * },\n * },\n * ...\n * })\n * ```\n *\n * @beta\n */\n",
|
|
8357
8177
|
"excerptTokens": [
|
|
8358
8178
|
{
|
|
8359
8179
|
"kind": "Content",
|
|
@@ -8754,7 +8574,7 @@
|
|
|
8754
8574
|
{
|
|
8755
8575
|
"kind": "Class",
|
|
8756
8576
|
"canonicalReference": "@gcorevideo/player!Thumbnails:class",
|
|
8757
|
-
"docComment": "/**\n *
|
|
8577
|
+
"docComment": "/**\n * `PLUGIN` that displays the thumbnails of the video when available.\n *\n * @example\n * ```ts\n * import { Thumbnails } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Thumbnails)\n *\n * new Player({\n * thumbnails: {\n * backdropHeight: 200,\n * backdropMinOpacity: 0.9,\n * backdropMaxOpacity: 0.99,\n * spotlightHeight: 100,\n * vtt: '1\\n00:00:00,000 --> 00:00:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56\\n\\n2\\n00:00:10,000 --> 00:00:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56\\n\\n3\\n00:00:20,000 --> 00:00:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,0,100,56\\n\\n4\\n00:00:30,000 --> 00:00:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,0,100,56\\n\\n5\\n00:00:40,000 --> 00:00:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,0,100,56\\n\\n6\\n00:00:50,000 --> 00:01:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,0,100,56\\n\\n7\\n00:01:00,000 --> 00:01:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,0,100,56\\n\\n8\\n00:01:10,000 --> 00:01:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,56,100,56\\n\\n9\\n00:01:20,000 --> 00:01:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,56,100,56\\n\\n10\\n00:01:30,000 --> 00:01:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,56,100,56\\n\\n11\\n00:01:40,000 --> 00:01:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,56,100,56\\n\\n12\\n00:01:50,000 --> 00:02:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,56,100,56\\n\\n13\\n00:02:00,000 --> 00:02:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,56,100,56\\n\\n14\\n00:02:10,000 --> 00:02:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,56,100,56\\n\\n15\\n00:02:20,000 --> 00:02:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,112,100,56\\n\\n16\\n00:02:30,000 --> 00:02:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,112,100,56\\n\\n17\\n00:02:40,000 --> 00:02:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,112,100,56\\n\\n18\\n00:02:50,000 --> 00:03:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,112,100,56\\n\\n19\\n00:03:00,000 --> 00:03:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,112,100,56\\n\\n20\\n00:03:10,000 --> 00:03:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,112,100,56\\n\\n21\\n00:03:20,000 --> 00:03:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,112,100,56\\n\\n22\\n00:03:30,000 --> 00:03:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,168,100,56\\n\\n23\\n00:03:40,000 --> 00:03:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,168,100,56\\n\\n24\\n00:03:50,000 --> 00:04:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,168,100,56\\n\\n25\\n00:04:00,000 --> 00:04:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,168,100,56\\n\\n26\\n00:04:10,000 --> 00:04:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,168,100,56\\n\\n27\\n00:04:20,000 --> 00:04:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,168,100,56\\n\\n28\\n00:04:30,000 --> 00:04:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,168,100,56\\n\\n29\\n00:04:40,000 --> 00:04:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,224,100,56\\n\\n30\\n00:04:50,000 --> 00:05:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,224,100,56\\n\\n31\\n00:05:00,000 --> 00:05:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,224,100,56\\n\\n32\\n00:05:10,000 --> 00:05:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,224,100,56\\n\\n33\\n00:05:20,000 --> 00:05:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,224,100,56\\n\\n34\\n00:05:30,000 --> 00:05:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,224,100,56\\n\\n35\\n00:05:40,000 --> 00:05:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,224,100,56\\n\\n36\\n00:05:50,000 --> 00:06:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,280,100,56\\n\\n37\\n00:06:00,000 --> 00:06:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,280,100,56\\n\\n38\\n00:06:10,000 --> 00:06:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,280,100,56\\n\\n39\\n00:06:20,000 --> 00:06:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,280,100,56\\n\\n40\\n00:06:30,000 --> 00:06:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,280,100,56\\n\\n41\\n00:06:40,000 --> 00:06:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,280,100,56\\n\\n42\\n00:06:50,000 --> 00:07:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,280,100,56\\n\\n43\\n00:07:00,000 --> 00:07:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,336,100,56\\n\\n44\\n00:07:10,000 --> 00:07:20,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,336,100,56\\n\\n45\\n00:07:20,000 --> 00:07:30,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=200,336,100,56\\n\\n46\\n00:07:30,000 --> 00:07:40,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=300,336,100,56\\n\\n47\\n00:07:40,000 --> 00:07:50,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=400,336,100,56\\n\\n48\\n00:07:50,000 --> 00:08:00,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=500,336,100,56\\n\\n49\\n00:08:00,000 --> 00:08:10,000\\n3dk4NsRt6vWsffEr_sprite.jpg#xywh=600,336,100,56\\n',\n * sprite:\n * 'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
8758
8578
|
"excerptTokens": [
|
|
8759
8579
|
{
|
|
8760
8580
|
"kind": "Content",
|
|
@@ -8811,7 +8631,7 @@
|
|
|
8811
8631
|
{
|
|
8812
8632
|
"kind": "Interface",
|
|
8813
8633
|
"canonicalReference": "@gcorevideo/player!TimePosition:interface",
|
|
8814
|
-
"docComment": "/**\n * Current playback time and total duration of the media.\n *\n * @
|
|
8634
|
+
"docComment": "/**\n * Current playback time and total duration of the media.\n *\n * @public\n */\n",
|
|
8815
8635
|
"excerptTokens": [
|
|
8816
8636
|
{
|
|
8817
8637
|
"kind": "Content",
|
|
@@ -8819,7 +8639,7 @@
|
|
|
8819
8639
|
}
|
|
8820
8640
|
],
|
|
8821
8641
|
"fileUrlPath": "src/playback.types.ts",
|
|
8822
|
-
"releaseTag": "
|
|
8642
|
+
"releaseTag": "Public",
|
|
8823
8643
|
"name": "TimePosition",
|
|
8824
8644
|
"preserveMemberOrder": false,
|
|
8825
8645
|
"members": [
|
|
@@ -8844,7 +8664,7 @@
|
|
|
8844
8664
|
],
|
|
8845
8665
|
"isReadonly": false,
|
|
8846
8666
|
"isOptional": false,
|
|
8847
|
-
"releaseTag": "
|
|
8667
|
+
"releaseTag": "Public",
|
|
8848
8668
|
"name": "current",
|
|
8849
8669
|
"propertyTypeTokenRange": {
|
|
8850
8670
|
"startIndex": 1,
|
|
@@ -8872,7 +8692,7 @@
|
|
|
8872
8692
|
],
|
|
8873
8693
|
"isReadonly": false,
|
|
8874
8694
|
"isOptional": false,
|
|
8875
|
-
"releaseTag": "
|
|
8695
|
+
"releaseTag": "Public",
|
|
8876
8696
|
"name": "total",
|
|
8877
8697
|
"propertyTypeTokenRange": {
|
|
8878
8698
|
"startIndex": 1,
|
|
@@ -8947,7 +8767,7 @@
|
|
|
8947
8767
|
{
|
|
8948
8768
|
"kind": "TypeAlias",
|
|
8949
8769
|
"canonicalReference": "@gcorevideo/player!TimeValue:type",
|
|
8950
|
-
"docComment": "/**\n * Playback time in seconds since the beginning of the stream (or a segment for the live streams)\n *\n * @
|
|
8770
|
+
"docComment": "/**\n * Playback time in seconds since the beginning of the stream (or a segment for the live streams)\n *\n * @public\n */\n",
|
|
8951
8771
|
"excerptTokens": [
|
|
8952
8772
|
{
|
|
8953
8773
|
"kind": "Content",
|
|
@@ -8963,7 +8783,7 @@
|
|
|
8963
8783
|
}
|
|
8964
8784
|
],
|
|
8965
8785
|
"fileUrlPath": "src/playback.types.ts",
|
|
8966
|
-
"releaseTag": "
|
|
8786
|
+
"releaseTag": "Public",
|
|
8967
8787
|
"name": "TimeValue",
|
|
8968
8788
|
"typeTokenRange": {
|
|
8969
8789
|
"startIndex": 1,
|
|
@@ -8973,7 +8793,7 @@
|
|
|
8973
8793
|
{
|
|
8974
8794
|
"kind": "TypeAlias",
|
|
8975
8795
|
"canonicalReference": "@gcorevideo/player!TranslationKey:type",
|
|
8976
|
-
"docComment": "/**\n * @
|
|
8796
|
+
"docComment": "/**\n * @public\n */\n",
|
|
8977
8797
|
"excerptTokens": [
|
|
8978
8798
|
{
|
|
8979
8799
|
"kind": "Content",
|
|
@@ -8989,7 +8809,7 @@
|
|
|
8989
8809
|
}
|
|
8990
8810
|
],
|
|
8991
8811
|
"fileUrlPath": "src/types.ts",
|
|
8992
|
-
"releaseTag": "
|
|
8812
|
+
"releaseTag": "Public",
|
|
8993
8813
|
"name": "TranslationKey",
|
|
8994
8814
|
"typeTokenRange": {
|
|
8995
8815
|
"startIndex": 1,
|
|
@@ -8999,7 +8819,7 @@
|
|
|
8999
8819
|
{
|
|
9000
8820
|
"kind": "TypeAlias",
|
|
9001
8821
|
"canonicalReference": "@gcorevideo/player!TranslationSettings:type",
|
|
9002
|
-
"docComment": "/**\n * Localization strings for the player UI.\n *\n * @remarks\n *\n * The keys are language codes, and the values are objects with keys being the translation keys and values being the translations.\n *\n * This dictionary is used to localize the player UI, including the error messages and is shared across all the player components (including the plugins).\n *\n * @example\n * ```\n * {\n * en: {\n * play: 'Play',\n * ...\n * },\n * es: {\n * play: 'Reproducir',\n * ...\n * },\n * ...\n * }\n * ```\n *\n * @
|
|
8822
|
+
"docComment": "/**\n * Localization strings for the player UI.\n *\n * @remarks\n *\n * The keys are language codes, and the values are objects with keys being the translation keys and values being the translations.\n *\n * This dictionary is used to localize the player UI, including the error messages and is shared across all the player components (including the plugins).\n *\n * @example\n * ```\n * {\n * en: {\n * play: 'Play',\n * ...\n * },\n * es: {\n * play: 'Reproducir',\n * ...\n * },\n * ...\n * }\n * ```\n *\n * @public\n */\n",
|
|
9003
8823
|
"excerptTokens": [
|
|
9004
8824
|
{
|
|
9005
8825
|
"kind": "Content",
|
|
@@ -9056,7 +8876,7 @@
|
|
|
9056
8876
|
}
|
|
9057
8877
|
],
|
|
9058
8878
|
"fileUrlPath": "src/types.ts",
|
|
9059
|
-
"releaseTag": "
|
|
8879
|
+
"releaseTag": "Public",
|
|
9060
8880
|
"name": "TranslationSettings",
|
|
9061
8881
|
"typeTokenRange": {
|
|
9062
8882
|
"startIndex": 1,
|
|
@@ -9066,16 +8886,15 @@
|
|
|
9066
8886
|
{
|
|
9067
8887
|
"kind": "TypeAlias",
|
|
9068
8888
|
"canonicalReference": "@gcorevideo/player!TransportPreference:type",
|
|
9069
|
-
"docComment": "/**\n * Preferred media delivery protocol\n *\n * @
|
|
8889
|
+
"docComment": "/**\n * Preferred streaming media delivery protocol\n *\n * @public\n */\n",
|
|
9070
8890
|
"excerptTokens": [
|
|
9071
8891
|
{
|
|
9072
8892
|
"kind": "Content",
|
|
9073
8893
|
"text": "export type TransportPreference = "
|
|
9074
8894
|
},
|
|
9075
8895
|
{
|
|
9076
|
-
"kind": "
|
|
9077
|
-
"text": "
|
|
9078
|
-
"canonicalReference": "@gcorevideo/player!MediaTransport:type"
|
|
8896
|
+
"kind": "Content",
|
|
8897
|
+
"text": "'dash' | 'hls'"
|
|
9079
8898
|
},
|
|
9080
8899
|
{
|
|
9081
8900
|
"kind": "Content",
|
|
@@ -9083,7 +8902,7 @@
|
|
|
9083
8902
|
}
|
|
9084
8903
|
],
|
|
9085
8904
|
"fileUrlPath": "src/types.ts",
|
|
9086
|
-
"releaseTag": "
|
|
8905
|
+
"releaseTag": "Public",
|
|
9087
8906
|
"name": "TransportPreference",
|
|
9088
8907
|
"typeTokenRange": {
|
|
9089
8908
|
"startIndex": 1,
|
|
@@ -9121,7 +8940,7 @@
|
|
|
9121
8940
|
{
|
|
9122
8941
|
"kind": "Class",
|
|
9123
8942
|
"canonicalReference": "@gcorevideo/player!VolumeFade:class",
|
|
9124
|
-
"docComment": "/**\n *
|
|
8943
|
+
"docComment": "/**\n * `PLUGIN` that applies fade effect to the player's volume change.\n *\n * @beta\n */\n",
|
|
9125
8944
|
"excerptTokens": [
|
|
9126
8945
|
{
|
|
9127
8946
|
"kind": "Content",
|