@gcorevideo/player 2.20.8 → 2.20.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/dvr-controls/dvr_controls.scss +0 -2
- package/dist/core.js +22 -17
- package/dist/index.css +1343 -1346
- package/dist/index.js +119 -109
- package/dist/player.d.ts +238 -179
- package/dist/plugins/index.css +461 -464
- package/dist/plugins/index.js +97 -93
- package/docs/api/player.audioselector.md +1 -1
- package/docs/api/player.bigmutebutton.md +1 -1
- package/docs/api/player.bottomgear.md +15 -1
- package/docs/api/player.bottomgear.refresh.md +20 -0
- package/docs/api/player.clapprnerdstats.md +1 -1
- package/docs/api/player.clapprstats.exportmetrics.md +1 -1
- package/docs/api/player.clapprstats.md +1 -15
- package/docs/api/player.clapprstats.setupdatemetrics.md +2 -0
- package/docs/api/player.clicktopause.md +1 -1
- package/docs/api/player.clipsplugin.md +1 -1
- package/docs/api/player.clipspluginsettings.md +5 -2
- package/docs/api/player.clipspluginsettings.text.md +3 -0
- package/docs/api/player.containerpluginconstructor.md +17 -0
- package/docs/api/player.containersize.md +0 -3
- package/docs/api/player.contextmenu.md +1 -1
- package/docs/api/player.corepluginconstructor.md +17 -0
- 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 -220
- package/docs/api/{player.errorscreen.render.md → player.errorscreenpluginsettings.md} +7 -7
- package/docs/api/player.favicon.md +1 -1
- package/docs/api/player.googleanalytics.md +1 -1
- package/docs/api/player.langtag.md +0 -3
- package/docs/api/player.levelselector.md +3 -9
- package/docs/api/{player.errorscreen.bindevents.md → player.levelselectorpluginsettings.labels.md} +11 -5
- package/docs/api/player.levelselectorpluginsettings.md +79 -0
- package/docs/api/{player.errorscreen.unbindevents.md → player.levelselectorpluginsettings.restrictresolution.md} +5 -7
- package/docs/api/player.logo.md +1 -1
- package/docs/api/player.md +131 -65
- package/docs/api/{player.errorscreen.container.md → player.mediacontrol.currentseekpos.md} +3 -3
- package/docs/api/player.mediacontrol.disable.md +1 -1
- package/docs/api/player.mediacontrol.md +24 -3
- package/docs/api/{player.gearevents.md → player.mediacontrolevents.md} +4 -4
- package/docs/api/player.multicamera.md +1 -29
- 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 +25 -9
- 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 +17 -0
- package/docs/api/player.playbackerrorcode.md +6 -9
- package/docs/api/player.playbackmodule.md +0 -3
- package/docs/api/{player.dvrcontrols._constructor_.md → player.playbackrate._constructor_.md} +3 -3
- package/docs/api/player.playbackrate.md +35 -2
- 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 +2 -5
- 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 +14 -0
- 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.attributes.md +3 -0
- package/docs/api/player.share.bindevents.md +3 -0
- package/docs/api/player.share.canshowshare.md +3 -0
- package/docs/api/player.share.events.md +3 -0
- package/docs/api/player.share.hideshare.md +3 -0
- package/docs/api/player.share.initializeicons.md +3 -0
- package/docs/api/player.share.md +40 -1
- package/docs/api/player.share.name.md +3 -0
- package/docs/api/player.share.onshareembedclick.md +3 -0
- package/docs/api/player.share.onsharefb.md +3 -0
- package/docs/api/player.share.onsharehide.md +3 -0
- package/docs/api/player.share.onsharelinkclick.md +3 -0
- package/docs/api/player.share.onshareshow.md +3 -0
- package/docs/api/player.share.onsharetw.md +3 -0
- package/docs/api/player.share.render.md +3 -0
- package/docs/api/player.share.showshare.md +3 -0
- package/docs/api/player.share.supportedversion.md +3 -0
- package/docs/api/player.share.template.md +3 -0
- package/docs/api/player.share.unbindevents.md +3 -0
- package/docs/api/player.skiptime.attributes.md +3 -0
- package/docs/api/player.skiptime.bindevents.md +3 -0
- package/docs/api/player.skiptime.container.md +3 -0
- package/docs/api/player.skiptime.events.md +3 -0
- package/docs/api/player.skiptime.handlerewindclicks.md +3 -0
- package/docs/api/player.skiptime.md +30 -1
- package/docs/api/player.skiptime.name.md +3 -0
- package/docs/api/player.skiptime.render.md +3 -0
- package/docs/api/player.skiptime.setback.md +3 -0
- package/docs/api/player.skiptime.setforward.md +3 -0
- package/docs/api/player.skiptime.setmidclick.md +3 -0
- package/docs/api/player.skiptime.supportedversion.md +3 -0
- package/docs/api/player.skiptime.template.md +3 -0
- package/docs/api/player.skiptime.togglefullscreen.md +3 -0
- package/docs/api/player.sourcecontroller.md +1 -1
- package/docs/api/player.spinnerevents.md +4 -1
- package/docs/api/player.spinnerthreebounce.hide.md +1 -1
- package/docs/api/player.spinnerthreebounce.md +7 -5
- package/docs/api/player.spinnerthreebounce.show.md +40 -2
- package/docs/api/player.subtitles.md +1 -1
- package/docs/api/player.telemetry.md +1 -1
- package/docs/api/player.telemetrypluginsettings.md +1 -1
- package/docs/api/{player.errorscreen.hide.md → player.telemetrysendfn.md} +6 -6
- 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 +18 -9
- package/lib/Player.d.ts.map +1 -1
- package/lib/Player.js +19 -14
- package/lib/index.core.d.ts +0 -1
- package/lib/index.core.d.ts.map +1 -1
- package/lib/index.core.js +0 -1
- package/lib/index.d.ts +18 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +18 -1
- package/lib/index.plugins.d.ts +0 -1
- package/lib/index.plugins.d.ts.map +1 -1
- package/lib/index.plugins.js +0 -1
- package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
- package/lib/playback/hls-playback/HlsPlayback.js +1 -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 +2 -2
- package/lib/plugins/bottom-gear/BottomGear.d.ts.map +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-nerd-stats/speedtest/Speedtest.d.ts.map +1 -1
- package/lib/plugins/clappr-nerd-stats/speedtest/Speedtest.js +8 -8
- package/lib/plugins/clappr-stats/ClapprStats.d.ts +4 -5
- package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
- package/lib/plugins/clappr-stats/ClapprStats.js +4 -3
- 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 +3 -2
- package/lib/plugins/clips/Clips.d.ts.map +1 -1
- package/lib/plugins/clips/Clips.js +1 -1
- package/lib/plugins/context-menu/ContextMenu.d.ts +1 -1
- package/lib/plugins/context-menu/ContextMenu.d.ts.map +1 -1
- package/lib/plugins/context-menu/ContextMenu.js +1 -1
- package/lib/plugins/dvr-controls/DvrControls.d.ts +7 -4
- package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
- package/lib/plugins/dvr-controls/DvrControls.js +29 -36
- package/lib/plugins/error-screen/ErrorScreen.d.ts +8 -14
- package/lib/plugins/error-screen/ErrorScreen.d.ts.map +1 -1
- package/lib/plugins/error-screen/ErrorScreen.js +1 -1
- package/lib/plugins/favicon/Favicon.d.ts +1 -1
- package/lib/plugins/favicon/Favicon.js +1 -1
- package/lib/plugins/google-analytics/GoogleAnalytics.d.ts +1 -1
- package/lib/plugins/google-analytics/GoogleAnalytics.js +1 -1
- package/lib/plugins/index.d.ts +0 -1
- package/lib/plugins/index.d.ts.map +1 -1
- package/lib/plugins/index.js +0 -1
- package/lib/plugins/kibo/index.d.ts +0 -3
- package/lib/plugins/kibo/index.d.ts.map +1 -1
- package/lib/plugins/kibo/index.js +0 -3
- package/lib/plugins/level-selector/LevelSelector.d.ts +6 -4
- package/lib/plugins/level-selector/LevelSelector.d.ts.map +1 -1
- package/lib/plugins/level-selector/LevelSelector.js +2 -4
- 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 +11 -5
- package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
- package/lib/plugins/media-control/MediaControl.js +17 -5
- package/lib/plugins/multi-camera/MultiCamera.d.ts +3 -11
- package/lib/plugins/multi-camera/MultiCamera.d.ts.map +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 +3 -3
- 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 +2 -1
- package/lib/plugins/share/Share.d.ts.map +1 -1
- package/lib/plugins/share/Share.js +2 -1
- package/lib/plugins/skip-time/SkipTime.d.ts +2 -1
- package/lib/plugins/skip-time/SkipTime.d.ts.map +1 -1
- package/lib/plugins/skip-time/SkipTime.js +2 -1
- package/lib/plugins/source-controller/SourceController.d.ts +1 -1
- package/lib/plugins/source-controller/SourceController.js +4 -4
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts +6 -3
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.d.ts.map +1 -1
- package/lib/plugins/spinner-three-bounce/SpinnerThreeBounce.js +6 -3
- package/lib/plugins/subtitles/Subtitles.d.ts +1 -1
- package/lib/plugins/subtitles/Subtitles.js +1 -1
- package/lib/plugins/telemetry/Telemetry.d.ts +2 -3
- package/lib/plugins/telemetry/Telemetry.d.ts.map +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/vast-ads/VastAds.d.ts.map +1 -1
- package/lib/plugins/vast-ads/VastAds.js +3 -3
- package/lib/plugins/vast-ads/roll.d.ts +1 -1
- package/lib/plugins/vast-ads/roll.d.ts.map +1 -1
- package/lib/plugins/vast-ads/rollmanager.d.ts +1 -1
- package/lib/plugins/vast-ads/rollmanager.d.ts.map +1 -1
- package/lib/plugins/vast-ads/rollmanager.js +2 -2
- 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 +38 -27
- package/lib/types.d.ts.map +1 -1
- package/lib/types.js +1 -1
- package/lib/utils/types.d.ts +0 -6
- package/lib/utils/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/Player.ts +23 -21
- package/src/index.core.ts +0 -1
- package/src/index.plugins.ts +0 -1
- package/src/index.ts +18 -1
- package/src/playback/hls-playback/HlsPlayback.ts +7 -11
- package/src/playback.types.ts +8 -7
- package/src/plugins/audio-selector/AudioSelector.ts +2 -2
- package/src/plugins/big-mute-button/BigMuteButton.ts +2 -3
- package/src/plugins/bottom-gear/BottomGear.ts +2 -2
- package/src/plugins/clappr-nerd-stats/ClapprNerdStats.ts +2 -2
- package/src/plugins/clappr-nerd-stats/speedtest/Speedtest.ts +184 -187
- package/src/plugins/clappr-stats/ClapprStats.ts +5 -4
- package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
- package/src/plugins/clips/Clips.ts +4 -3
- package/src/plugins/context-menu/ContextMenu.ts +1 -3
- package/src/plugins/dvr-controls/DvrControls.ts +34 -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 +10 -17
- package/src/plugins/favicon/Favicon.ts +2 -2
- package/src/plugins/google-analytics/GoogleAnalytics.ts +1 -1
- package/src/plugins/index.ts +0 -1
- package/src/plugins/kibo/index.ts +0 -3
- package/src/plugins/level-selector/LevelSelector.ts +7 -5
- package/src/plugins/logo/Logo.ts +2 -2
- package/src/plugins/media-control/MediaControl.ts +20 -6
- package/src/plugins/multi-camera/MultiCamera.ts +4 -4
- package/src/plugins/picture-in-picture/PictureInPicture.ts +1 -1
- package/src/plugins/playback-rate/PlaybackRate.ts +2 -2
- package/src/plugins/poster/Poster.ts +4 -4
- package/src/plugins/seek-time/SeekTime.ts +2 -2
- package/src/plugins/share/Share.ts +2 -1
- package/src/plugins/skip-time/SkipTime.ts +2 -1
- package/src/plugins/source-controller/SourceController.ts +4 -4
- package/src/plugins/source-controller/__tests__/SourceController.test.ts +2 -2
- package/src/plugins/spinner-three-bounce/SpinnerThreeBounce.ts +6 -3
- package/src/plugins/subtitles/Subtitles.ts +2 -2
- package/src/plugins/telemetry/Telemetry.ts +2 -2
- package/src/plugins/thumbnails/Thumbnails.ts +2 -2
- package/src/plugins/vast-ads/VastAds.ts +5 -4
- package/src/plugins/vast-ads/roll.ts +2 -1
- package/src/plugins/vast-ads/rollmanager.ts +3 -3
- package/src/plugins/volume-fade/VolumeFade.ts +1 -1
- package/src/testUtils.ts +28 -4
- package/src/types.ts +41 -28
- package/src/utils/types.ts +0 -8
- package/temp/player.api.json +680 -786
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.clapprstats.onbitrate.md +0 -52
- package/docs/api/player.errorscreen.attributes.md +0 -17
- package/docs/api/player.errorscreen.name.md +0 -14
- package/docs/api/player.errorscreen.show.md +0 -54
- package/docs/api/player.errorscreen.supportedversion.md +0 -16
- package/docs/api/player.errorscreen.template.md +0 -14
- package/docs/api/player.mediatransport.md +0 -16
- package/docs/api/player.multicamera.getcameraslist.md +0 -18
- package/docs/api/player.multicamera.getcurrentcamera.md +0 -18
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
## PlayerEvent enum
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
A top-level event on the player object
|
|
11
8
|
|
|
12
9
|
**Signature:**
|
|
@@ -45,7 +42,7 @@ Ended
|
|
|
45
42
|
|
|
46
43
|
</td><td>
|
|
47
44
|
|
|
48
|
-
|
|
45
|
+
Playback has reached the end of the media.
|
|
49
46
|
|
|
50
47
|
|
|
51
48
|
</td></tr>
|
|
@@ -61,7 +58,7 @@ Error
|
|
|
61
58
|
|
|
62
59
|
</td><td>
|
|
63
60
|
|
|
64
|
-
|
|
61
|
+
An error occurred. Parameters: [PlaybackError](./player.playbackerror.md)
|
|
65
62
|
|
|
66
63
|
|
|
67
64
|
</td></tr>
|
|
@@ -77,7 +74,7 @@ Fullscreen
|
|
|
77
74
|
|
|
78
75
|
</td><td>
|
|
79
76
|
|
|
80
|
-
|
|
77
|
+
The player has switched to or from the fullscreen mode. Parameters:`boolean` isFullscreen
|
|
81
78
|
|
|
82
79
|
|
|
83
80
|
</td></tr>
|
|
@@ -93,7 +90,7 @@ Pause
|
|
|
93
90
|
|
|
94
91
|
</td><td>
|
|
95
92
|
|
|
96
|
-
|
|
93
|
+
Playback has been paused.
|
|
97
94
|
|
|
98
95
|
|
|
99
96
|
</td></tr>
|
|
@@ -109,7 +106,7 @@ Play
|
|
|
109
106
|
|
|
110
107
|
</td><td>
|
|
111
108
|
|
|
112
|
-
|
|
109
|
+
Playback has started.
|
|
113
110
|
|
|
114
111
|
|
|
115
112
|
</td></tr>
|
|
@@ -125,7 +122,7 @@ Ready
|
|
|
125
122
|
|
|
126
123
|
</td><td>
|
|
127
124
|
|
|
128
|
-
|
|
125
|
+
The player is ready to use.
|
|
129
126
|
|
|
130
127
|
|
|
131
128
|
</td></tr>
|
|
@@ -141,7 +138,7 @@ Resize
|
|
|
141
138
|
|
|
142
139
|
</td><td>
|
|
143
140
|
|
|
144
|
-
|
|
141
|
+
The player's container has been resized. Parameters: [ContainerSize](./player.containersize.md)
|
|
145
142
|
|
|
146
143
|
|
|
147
144
|
</td></tr>
|
|
@@ -157,7 +154,7 @@ Seek
|
|
|
157
154
|
|
|
158
155
|
</td><td>
|
|
159
156
|
|
|
160
|
-
|
|
157
|
+
The player is seeking to a new position.
|
|
161
158
|
|
|
162
159
|
|
|
163
160
|
</td></tr>
|
|
@@ -173,7 +170,7 @@ Stop
|
|
|
173
170
|
|
|
174
171
|
</td><td>
|
|
175
172
|
|
|
176
|
-
|
|
173
|
+
Playback has been stopped.
|
|
177
174
|
|
|
178
175
|
|
|
179
176
|
</td></tr>
|
|
@@ -189,7 +186,7 @@ TimeUpdate
|
|
|
189
186
|
|
|
190
187
|
</td><td>
|
|
191
188
|
|
|
192
|
-
|
|
189
|
+
The current playback time has changed. Parameters: [TimePosition](./player.timeposition.md)
|
|
193
190
|
|
|
194
191
|
|
|
195
192
|
</td></tr>
|
|
@@ -205,7 +202,7 @@ VolumeUpdate
|
|
|
205
202
|
|
|
206
203
|
</td><td>
|
|
207
204
|
|
|
208
|
-
|
|
205
|
+
The volume has changed. Parameters: `number` volume in the range 0..1
|
|
209
206
|
|
|
210
207
|
|
|
211
208
|
</td></tr>
|
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
## PlayerEventHandler type
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
|
|
11
8
|
|
|
12
9
|
**Signature:**
|
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
## PlayerMediaSourceDesc interface
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
Describes a media source with its MIME type and URL.
|
|
11
8
|
|
|
12
9
|
**Signature:**
|
|
@@ -57,7 +54,7 @@ string
|
|
|
57
54
|
|
|
58
55
|
</td><td>
|
|
59
56
|
|
|
60
|
-
|
|
57
|
+
_(Optional)_ The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
|
|
61
58
|
|
|
62
59
|
|
|
63
60
|
</td></tr>
|
|
@@ -76,7 +73,7 @@ string
|
|
|
76
73
|
|
|
77
74
|
</td><td>
|
|
78
75
|
|
|
79
|
-
|
|
76
|
+
URL of the media source
|
|
80
77
|
|
|
81
78
|
|
|
82
79
|
</td></tr>
|
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
## PlayerMediaSourceDesc.mimeType property
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
|
|
11
8
|
|
|
12
9
|
**Signature:**
|
|
@@ -4,14 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
## PlayerPlugin type
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
**Signature:**
|
|
11
8
|
|
|
12
9
|
```typescript
|
|
13
10
|
export type PlayerPlugin = {
|
|
14
|
-
new (...args: any[]): unknown;
|
|
15
11
|
name: string;
|
|
16
12
|
};
|
|
17
13
|
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@gcorevideo/player](./player.md) > [PlayerPluginConstructor](./player.playerpluginconstructor.md)
|
|
4
|
+
|
|
5
|
+
## PlayerPluginConstructor type
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor;
|
|
12
|
+
```
|
|
13
|
+
**References:** [CorePluginConstructor](./player.corepluginconstructor.md)<!-- -->, [ContainerPluginConstructor](./player.containerpluginconstructor.md)
|
|
14
|
+
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
8
|
>
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
`PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped
|
|
11
11
|
|
|
12
12
|
**Signature:**
|
|
13
13
|
|
|
@@ -4,9 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
## QualityLevel interface
|
|
6
6
|
|
|
7
|
-
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
7
|
A level of quality within a media source.
|
|
11
8
|
|
|
12
9
|
**Signature:**
|
|
@@ -53,7 +50,7 @@ number
|
|
|
53
50
|
|
|
54
51
|
</td><td>
|
|
55
52
|
|
|
56
|
-
|
|
53
|
+
Bitrate of the video, bps.
|
|
57
54
|
|
|
58
55
|
|
|
59
56
|
</td></tr>
|
|
@@ -72,7 +69,7 @@ number
|
|
|
72
69
|
|
|
73
70
|
</td><td>
|
|
74
71
|
|
|
75
|
-
|
|
72
|
+
Height of the video, pixels.
|
|
76
73
|
|
|
77
74
|
|
|
78
75
|
</td></tr>
|
|
@@ -91,7 +88,7 @@ number
|
|
|
91
88
|
|
|
92
89
|
</td><td>
|
|
93
90
|
|
|
94
|
-
|
|
91
|
+
Zero-based index of the quality level.
|
|
95
92
|
|
|
96
93
|
|
|
97
94
|
</td></tr>
|
|
@@ -110,7 +107,7 @@ number
|
|
|
110
107
|
|
|
111
108
|
</td><td>
|
|
112
109
|
|
|
113
|
-
|
|
110
|
+
Width of the video, pixels.
|
|
114
111
|
|
|
115
112
|
|
|
116
113
|
</td></tr>
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
8
|
>
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
`PLUGIN` that adds a seek time indicator to the media control UI.
|
|
11
11
|
|
|
12
12
|
**Signature:**
|
|
13
13
|
|
package/docs/api/player.share.md
CHANGED
|
@@ -4,7 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
## Share class
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
|
8
|
+
>
|
|
9
|
+
|
|
10
|
+
`PLUGIN` that adds a share button to the media control UI.
|
|
8
11
|
|
|
9
12
|
**Signature:**
|
|
10
13
|
|
|
@@ -53,6 +56,8 @@ Description
|
|
|
53
56
|
|
|
54
57
|
</td><td>
|
|
55
58
|
|
|
59
|
+
**_(BETA)_**
|
|
60
|
+
|
|
56
61
|
|
|
57
62
|
</td></tr>
|
|
58
63
|
<tr><td>
|
|
@@ -72,6 +77,8 @@ Description
|
|
|
72
77
|
|
|
73
78
|
</td><td>
|
|
74
79
|
|
|
80
|
+
**_(BETA)_**
|
|
81
|
+
|
|
75
82
|
|
|
76
83
|
</td></tr>
|
|
77
84
|
<tr><td>
|
|
@@ -91,6 +98,8 @@ string
|
|
|
91
98
|
|
|
92
99
|
</td><td>
|
|
93
100
|
|
|
101
|
+
**_(BETA)_**
|
|
102
|
+
|
|
94
103
|
|
|
95
104
|
</td></tr>
|
|
96
105
|
<tr><td>
|
|
@@ -110,6 +119,8 @@ string
|
|
|
110
119
|
|
|
111
120
|
</td><td>
|
|
112
121
|
|
|
122
|
+
**_(BETA)_**
|
|
123
|
+
|
|
113
124
|
|
|
114
125
|
</td></tr>
|
|
115
126
|
<tr><td>
|
|
@@ -129,6 +140,8 @@ any
|
|
|
129
140
|
|
|
130
141
|
</td><td>
|
|
131
142
|
|
|
143
|
+
**_(BETA)_**
|
|
144
|
+
|
|
132
145
|
|
|
133
146
|
</td></tr>
|
|
134
147
|
</tbody></table>
|
|
@@ -161,6 +174,8 @@ Description
|
|
|
161
174
|
|
|
162
175
|
</td><td>
|
|
163
176
|
|
|
177
|
+
**_(BETA)_**
|
|
178
|
+
|
|
164
179
|
|
|
165
180
|
</td></tr>
|
|
166
181
|
<tr><td>
|
|
@@ -173,6 +188,8 @@ Description
|
|
|
173
188
|
|
|
174
189
|
</td><td>
|
|
175
190
|
|
|
191
|
+
**_(BETA)_**
|
|
192
|
+
|
|
176
193
|
|
|
177
194
|
</td></tr>
|
|
178
195
|
<tr><td>
|
|
@@ -185,6 +202,8 @@ Description
|
|
|
185
202
|
|
|
186
203
|
</td><td>
|
|
187
204
|
|
|
205
|
+
**_(BETA)_**
|
|
206
|
+
|
|
188
207
|
|
|
189
208
|
</td></tr>
|
|
190
209
|
<tr><td>
|
|
@@ -197,6 +216,8 @@ Description
|
|
|
197
216
|
|
|
198
217
|
</td><td>
|
|
199
218
|
|
|
219
|
+
**_(BETA)_**
|
|
220
|
+
|
|
200
221
|
|
|
201
222
|
</td></tr>
|
|
202
223
|
<tr><td>
|
|
@@ -209,6 +230,8 @@ Description
|
|
|
209
230
|
|
|
210
231
|
</td><td>
|
|
211
232
|
|
|
233
|
+
**_(BETA)_**
|
|
234
|
+
|
|
212
235
|
|
|
213
236
|
</td></tr>
|
|
214
237
|
<tr><td>
|
|
@@ -221,6 +244,8 @@ Description
|
|
|
221
244
|
|
|
222
245
|
</td><td>
|
|
223
246
|
|
|
247
|
+
**_(BETA)_**
|
|
248
|
+
|
|
224
249
|
|
|
225
250
|
</td></tr>
|
|
226
251
|
<tr><td>
|
|
@@ -233,6 +258,8 @@ Description
|
|
|
233
258
|
|
|
234
259
|
</td><td>
|
|
235
260
|
|
|
261
|
+
**_(BETA)_**
|
|
262
|
+
|
|
236
263
|
|
|
237
264
|
</td></tr>
|
|
238
265
|
<tr><td>
|
|
@@ -245,6 +272,8 @@ Description
|
|
|
245
272
|
|
|
246
273
|
</td><td>
|
|
247
274
|
|
|
275
|
+
**_(BETA)_**
|
|
276
|
+
|
|
248
277
|
|
|
249
278
|
</td></tr>
|
|
250
279
|
<tr><td>
|
|
@@ -257,6 +286,8 @@ Description
|
|
|
257
286
|
|
|
258
287
|
</td><td>
|
|
259
288
|
|
|
289
|
+
**_(BETA)_**
|
|
290
|
+
|
|
260
291
|
|
|
261
292
|
</td></tr>
|
|
262
293
|
<tr><td>
|
|
@@ -269,6 +300,8 @@ Description
|
|
|
269
300
|
|
|
270
301
|
</td><td>
|
|
271
302
|
|
|
303
|
+
**_(BETA)_**
|
|
304
|
+
|
|
272
305
|
|
|
273
306
|
</td></tr>
|
|
274
307
|
<tr><td>
|
|
@@ -281,6 +314,8 @@ Description
|
|
|
281
314
|
|
|
282
315
|
</td><td>
|
|
283
316
|
|
|
317
|
+
**_(BETA)_**
|
|
318
|
+
|
|
284
319
|
|
|
285
320
|
</td></tr>
|
|
286
321
|
<tr><td>
|
|
@@ -293,6 +328,8 @@ Description
|
|
|
293
328
|
|
|
294
329
|
</td><td>
|
|
295
330
|
|
|
331
|
+
**_(BETA)_**
|
|
332
|
+
|
|
296
333
|
|
|
297
334
|
</td></tr>
|
|
298
335
|
<tr><td>
|
|
@@ -305,6 +342,8 @@ Description
|
|
|
305
342
|
|
|
306
343
|
</td><td>
|
|
307
344
|
|
|
345
|
+
**_(BETA)_**
|
|
346
|
+
|
|
308
347
|
|
|
309
348
|
</td></tr>
|
|
310
349
|
</tbody></table>
|