@gcorevideo/player 2.22.14 → 2.22.16
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/clips/clips.ejs +1 -0
- package/assets/clips/clips.scss +23 -3
- package/assets/context-menu/context_menu.ejs +14 -6
- package/assets/context-menu/context_menu.scss +18 -4
- package/assets/level-selector/list.ejs +9 -3
- package/assets/media-control/media-control.ejs +1 -9
- package/assets/media-control/media-control.scss +0 -25
- package/assets/media-control/width370.scss +4 -4
- package/dist/core.js +5 -23
- package/dist/index.css +424 -412
- package/dist/index.js +294 -286
- package/dist/player.d.ts +211 -144
- package/dist/plugins/index.css +1513 -1501
- package/dist/plugins/index.js +224 -227
- package/docs/api/{player.audioselector.md → player.audiotracks.md} +3 -3
- package/docs/api/player.contextmenu.md +2 -0
- package/docs/api/player.contextmenupluginsettings.md +2 -40
- package/docs/api/{player.contextmenupluginsettings.label.md → player.contextmenupluginsettings.options.md} +3 -3
- package/docs/api/player.md +78 -23
- package/docs/api/player.mediacontrol.md +8 -14
- package/docs/api/player.mediacontrolelement.md +4 -2
- package/docs/api/{player.contextmenupluginsettings.preventshowcontextmenu.md → player.mediacontrollayerelement.md} +5 -3
- package/docs/api/player.mediacontrolleftelement.md +16 -0
- package/docs/api/player.mediacontrolrightelement.md +16 -0
- package/docs/api/player.mediacontrolsettings.md +23 -0
- package/docs/api/{player.contextmenupluginsettings.url.md → player.menuoption.md} +10 -3
- package/docs/api/player.playbackrate.md +1 -1
- package/docs/api/player.playerconfig.md +1 -1
- package/docs/api/player.playerconfig.playbacktype.md +1 -1
- package/docs/api/{player.levelselector.events.md → player.qualitylevels.events.md} +2 -2
- package/docs/api/{player.levelselector.md → player.qualitylevels.md} +6 -6
- package/docs/api/{player.levelselectorpluginsettings.labels.md → player.qualitylevelspluginsettings.labels.md} +2 -2
- package/docs/api/{player.levelselectorpluginsettings.md → player.qualitylevelspluginsettings.md} +6 -6
- package/docs/api/{player.levelselectorpluginsettings.restrictresolution.md → player.qualitylevelspluginsettings.restrictresolution.md} +2 -2
- package/lib/Player.d.ts.map +1 -1
- package/lib/Player.js +4 -1
- package/lib/playback/hls-playback/HlsPlayback.d.ts.map +1 -1
- package/lib/playback/hls-playback/HlsPlayback.js +0 -21
- package/lib/plugins/click-to-pause/ClickToPause.js +1 -1
- package/lib/plugins/clips/Clips.d.ts +21 -16
- package/lib/plugins/clips/Clips.d.ts.map +1 -1
- package/lib/plugins/clips/Clips.js +96 -98
- package/lib/plugins/clips/types.d.ts +19 -0
- package/lib/plugins/clips/types.d.ts.map +1 -0
- package/lib/plugins/clips/types.js +1 -0
- package/lib/plugins/clips/utils.d.ts +4 -0
- package/lib/plugins/clips/utils.d.ts.map +1 -0
- package/lib/plugins/clips/utils.js +36 -0
- package/lib/plugins/context-menu/ContextMenu.d.ts +33 -12
- package/lib/plugins/context-menu/ContextMenu.d.ts.map +1 -1
- package/lib/plugins/context-menu/ContextMenu.js +40 -37
- package/lib/plugins/media-control/MediaControl.d.ts +4 -7
- package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
- package/lib/plugins/media-control/MediaControl.js +19 -31
- package/lib/plugins/utils.d.ts +9 -1
- package/lib/plugins/utils.d.ts.map +1 -1
- package/lib/plugins/utils.js +9 -10
- package/lib/plugins/vast-ads/loaderxml.js +2 -2
- package/lib/testUtils.d.ts.map +1 -1
- package/lib/testUtils.js +2 -5
- package/package.json +1 -1
- package/src/Player.ts +4 -3
- package/src/playback/hls-playback/HlsPlayback.ts +0 -22
- package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
- package/src/plugins/clips/Clips.ts +116 -135
- package/src/plugins/clips/__tests__/Clips.test.ts +72 -0
- package/src/plugins/clips/__tests__/__snapshots__/Clips.test.ts.snap +14 -0
- package/src/plugins/clips/types.ts +22 -0
- package/src/plugins/clips/utils.ts +54 -0
- package/src/plugins/context-menu/ContextMenu.ts +72 -56
- package/src/plugins/level-selector/__tests__/__snapshots__/QualityLevels.test.ts.snap +18 -18
- package/src/plugins/media-control/MediaControl.ts +31 -58
- package/src/plugins/media-control/__tests__/MediaControl.test.ts +66 -30
- package/src/plugins/media-control/__tests__/__snapshots__/MediaControl.test.ts.snap +7 -35
- package/src/plugins/utils.ts +9 -7
- package/src/plugins/vast-ads/loaderxml.ts +2 -2
- package/src/testUtils.ts +2 -5
- package/temp/player.api.json +332 -262
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.mediacontrol.handlecustomarea.md +0 -52
package/temp/player.api.json
CHANGED
|
@@ -174,12 +174,12 @@
|
|
|
174
174
|
"members": [
|
|
175
175
|
{
|
|
176
176
|
"kind": "Class",
|
|
177
|
-
"canonicalReference": "@gcorevideo/player!
|
|
177
|
+
"canonicalReference": "@gcorevideo/player!AudioTracks:class",
|
|
178
178
|
"docComment": "/**\n * `PLUGIN` that makes possible to switch audio tracks via the media control UI.\n *\n * @remarks\n *\n * The plugin is activated when there are multiple audio tracks available. The plugin adds a button showing the current audio track and a dropdown to switch to another audio track. Depends on:\n *\n * - {@link MediaControl}\n *\n * @beta\n */\n",
|
|
179
179
|
"excerptTokens": [
|
|
180
180
|
{
|
|
181
181
|
"kind": "Content",
|
|
182
|
-
"text": "export declare class
|
|
182
|
+
"text": "export declare class AudioTracks extends "
|
|
183
183
|
},
|
|
184
184
|
{
|
|
185
185
|
"kind": "Reference",
|
|
@@ -194,7 +194,7 @@
|
|
|
194
194
|
"fileUrlPath": "src/plugins/audio-selector/AudioSelector.ts",
|
|
195
195
|
"releaseTag": "Beta",
|
|
196
196
|
"isAbstract": false,
|
|
197
|
-
"name": "
|
|
197
|
+
"name": "AudioTracks",
|
|
198
198
|
"preserveMemberOrder": false,
|
|
199
199
|
"members": [],
|
|
200
200
|
"extendsTokenRange": {
|
|
@@ -923,7 +923,7 @@
|
|
|
923
923
|
{
|
|
924
924
|
"kind": "Class",
|
|
925
925
|
"canonicalReference": "@gcorevideo/player!ContextMenu:class",
|
|
926
|
-
"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",
|
|
926
|
+
"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 * Should not be used together with {@link ClickToPause} plugin\n *\n * @beta\n */\n",
|
|
927
927
|
"excerptTokens": [
|
|
928
928
|
{
|
|
929
929
|
"kind": "Content",
|
|
@@ -1002,70 +1002,21 @@
|
|
|
1002
1002
|
"members": [
|
|
1003
1003
|
{
|
|
1004
1004
|
"kind": "PropertySignature",
|
|
1005
|
-
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#
|
|
1005
|
+
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#options:member",
|
|
1006
1006
|
"docComment": "",
|
|
1007
1007
|
"excerptTokens": [
|
|
1008
1008
|
{
|
|
1009
1009
|
"kind": "Content",
|
|
1010
|
-
"text": "
|
|
1010
|
+
"text": "options?: "
|
|
1011
1011
|
},
|
|
1012
1012
|
{
|
|
1013
|
-
"kind": "
|
|
1014
|
-
"text": "
|
|
1015
|
-
|
|
1016
|
-
{
|
|
1017
|
-
"kind": "Content",
|
|
1018
|
-
"text": ";"
|
|
1019
|
-
}
|
|
1020
|
-
],
|
|
1021
|
-
"isReadonly": false,
|
|
1022
|
-
"isOptional": true,
|
|
1023
|
-
"releaseTag": "Beta",
|
|
1024
|
-
"name": "label",
|
|
1025
|
-
"propertyTypeTokenRange": {
|
|
1026
|
-
"startIndex": 1,
|
|
1027
|
-
"endIndex": 2
|
|
1028
|
-
}
|
|
1029
|
-
},
|
|
1030
|
-
{
|
|
1031
|
-
"kind": "PropertySignature",
|
|
1032
|
-
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#preventShowContextMenu:member",
|
|
1033
|
-
"docComment": "",
|
|
1034
|
-
"excerptTokens": [
|
|
1035
|
-
{
|
|
1036
|
-
"kind": "Content",
|
|
1037
|
-
"text": "preventShowContextMenu?: "
|
|
1038
|
-
},
|
|
1039
|
-
{
|
|
1040
|
-
"kind": "Content",
|
|
1041
|
-
"text": "boolean"
|
|
1042
|
-
},
|
|
1043
|
-
{
|
|
1044
|
-
"kind": "Content",
|
|
1045
|
-
"text": ";"
|
|
1046
|
-
}
|
|
1047
|
-
],
|
|
1048
|
-
"isReadonly": false,
|
|
1049
|
-
"isOptional": true,
|
|
1050
|
-
"releaseTag": "Beta",
|
|
1051
|
-
"name": "preventShowContextMenu",
|
|
1052
|
-
"propertyTypeTokenRange": {
|
|
1053
|
-
"startIndex": 1,
|
|
1054
|
-
"endIndex": 2
|
|
1055
|
-
}
|
|
1056
|
-
},
|
|
1057
|
-
{
|
|
1058
|
-
"kind": "PropertySignature",
|
|
1059
|
-
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#url:member",
|
|
1060
|
-
"docComment": "",
|
|
1061
|
-
"excerptTokens": [
|
|
1062
|
-
{
|
|
1063
|
-
"kind": "Content",
|
|
1064
|
-
"text": "url?: "
|
|
1013
|
+
"kind": "Reference",
|
|
1014
|
+
"text": "MenuOption",
|
|
1015
|
+
"canonicalReference": "@gcorevideo/player!MenuOption:type"
|
|
1065
1016
|
},
|
|
1066
1017
|
{
|
|
1067
1018
|
"kind": "Content",
|
|
1068
|
-
"text": "
|
|
1019
|
+
"text": "[]"
|
|
1069
1020
|
},
|
|
1070
1021
|
{
|
|
1071
1022
|
"kind": "Content",
|
|
@@ -1075,10 +1026,10 @@
|
|
|
1075
1026
|
"isReadonly": false,
|
|
1076
1027
|
"isOptional": true,
|
|
1077
1028
|
"releaseTag": "Beta",
|
|
1078
|
-
"name": "
|
|
1029
|
+
"name": "options",
|
|
1079
1030
|
"propertyTypeTokenRange": {
|
|
1080
1031
|
"startIndex": 1,
|
|
1081
|
-
"endIndex":
|
|
1032
|
+
"endIndex": 3
|
|
1082
1033
|
}
|
|
1083
1034
|
}
|
|
1084
1035
|
],
|
|
@@ -2157,145 +2108,6 @@
|
|
|
2157
2108
|
"endIndex": 2
|
|
2158
2109
|
}
|
|
2159
2110
|
},
|
|
2160
|
-
{
|
|
2161
|
-
"kind": "Class",
|
|
2162
|
-
"canonicalReference": "@gcorevideo/player!LevelSelector:class",
|
|
2163
|
-
"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",
|
|
2164
|
-
"excerptTokens": [
|
|
2165
|
-
{
|
|
2166
|
-
"kind": "Content",
|
|
2167
|
-
"text": "export declare class LevelSelector extends "
|
|
2168
|
-
},
|
|
2169
|
-
{
|
|
2170
|
-
"kind": "Reference",
|
|
2171
|
-
"text": "UICorePlugin",
|
|
2172
|
-
"canonicalReference": "@gcorevideo/player!~UICorePlugin"
|
|
2173
|
-
},
|
|
2174
|
-
{
|
|
2175
|
-
"kind": "Content",
|
|
2176
|
-
"text": " "
|
|
2177
|
-
}
|
|
2178
|
-
],
|
|
2179
|
-
"fileUrlPath": "src/plugins/level-selector/LevelSelector.ts",
|
|
2180
|
-
"releaseTag": "Beta",
|
|
2181
|
-
"isAbstract": false,
|
|
2182
|
-
"name": "LevelSelector",
|
|
2183
|
-
"preserveMemberOrder": false,
|
|
2184
|
-
"members": [
|
|
2185
|
-
{
|
|
2186
|
-
"kind": "Property",
|
|
2187
|
-
"canonicalReference": "@gcorevideo/player!LevelSelector#events:member",
|
|
2188
|
-
"docComment": "",
|
|
2189
|
-
"excerptTokens": [
|
|
2190
|
-
{
|
|
2191
|
-
"kind": "Content",
|
|
2192
|
-
"text": "get events(): "
|
|
2193
|
-
},
|
|
2194
|
-
{
|
|
2195
|
-
"kind": "Content",
|
|
2196
|
-
"text": "{\n 'click .gear-sub-menu_btn': string;\n 'click .go-back': string;\n }"
|
|
2197
|
-
},
|
|
2198
|
-
{
|
|
2199
|
-
"kind": "Content",
|
|
2200
|
-
"text": ";"
|
|
2201
|
-
}
|
|
2202
|
-
],
|
|
2203
|
-
"isReadonly": true,
|
|
2204
|
-
"isOptional": false,
|
|
2205
|
-
"releaseTag": "Beta",
|
|
2206
|
-
"name": "events",
|
|
2207
|
-
"propertyTypeTokenRange": {
|
|
2208
|
-
"startIndex": 1,
|
|
2209
|
-
"endIndex": 2
|
|
2210
|
-
},
|
|
2211
|
-
"isStatic": false,
|
|
2212
|
-
"isProtected": false,
|
|
2213
|
-
"isAbstract": false
|
|
2214
|
-
}
|
|
2215
|
-
],
|
|
2216
|
-
"extendsTokenRange": {
|
|
2217
|
-
"startIndex": 1,
|
|
2218
|
-
"endIndex": 2
|
|
2219
|
-
},
|
|
2220
|
-
"implementsTokenRanges": []
|
|
2221
|
-
},
|
|
2222
|
-
{
|
|
2223
|
-
"kind": "Interface",
|
|
2224
|
-
"canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings:interface",
|
|
2225
|
-
"docComment": "/**\n * Configuration options for the {@link LevelSelector | level selector} plugin.\n *\n * @beta\n */\n",
|
|
2226
|
-
"excerptTokens": [
|
|
2227
|
-
{
|
|
2228
|
-
"kind": "Content",
|
|
2229
|
-
"text": "export interface LevelSelectorPluginSettings "
|
|
2230
|
-
}
|
|
2231
|
-
],
|
|
2232
|
-
"fileUrlPath": "src/plugins/level-selector/LevelSelector.ts",
|
|
2233
|
-
"releaseTag": "Beta",
|
|
2234
|
-
"name": "LevelSelectorPluginSettings",
|
|
2235
|
-
"preserveMemberOrder": false,
|
|
2236
|
-
"members": [
|
|
2237
|
-
{
|
|
2238
|
-
"kind": "PropertySignature",
|
|
2239
|
-
"canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings#labels:member",
|
|
2240
|
-
"docComment": "/**\n * The labels to show in the level selector.\n *\n * @example\n * ```ts\n * { 360: 'SD', 720: 'HD' }\n * ```\n *\n */\n",
|
|
2241
|
-
"excerptTokens": [
|
|
2242
|
-
{
|
|
2243
|
-
"kind": "Content",
|
|
2244
|
-
"text": "labels?: "
|
|
2245
|
-
},
|
|
2246
|
-
{
|
|
2247
|
-
"kind": "Reference",
|
|
2248
|
-
"text": "Record",
|
|
2249
|
-
"canonicalReference": "!Record:type"
|
|
2250
|
-
},
|
|
2251
|
-
{
|
|
2252
|
-
"kind": "Content",
|
|
2253
|
-
"text": "<number, string>"
|
|
2254
|
-
},
|
|
2255
|
-
{
|
|
2256
|
-
"kind": "Content",
|
|
2257
|
-
"text": ";"
|
|
2258
|
-
}
|
|
2259
|
-
],
|
|
2260
|
-
"isReadonly": false,
|
|
2261
|
-
"isOptional": true,
|
|
2262
|
-
"releaseTag": "Beta",
|
|
2263
|
-
"name": "labels",
|
|
2264
|
-
"propertyTypeTokenRange": {
|
|
2265
|
-
"startIndex": 1,
|
|
2266
|
-
"endIndex": 3
|
|
2267
|
-
}
|
|
2268
|
-
},
|
|
2269
|
-
{
|
|
2270
|
-
"kind": "PropertySignature",
|
|
2271
|
-
"canonicalReference": "@gcorevideo/player!LevelSelectorPluginSettings#restrictResolution:member",
|
|
2272
|
-
"docComment": "/**\n * The maximum resolution to allow in the level selector.\n */\n",
|
|
2273
|
-
"excerptTokens": [
|
|
2274
|
-
{
|
|
2275
|
-
"kind": "Content",
|
|
2276
|
-
"text": "restrictResolution?: "
|
|
2277
|
-
},
|
|
2278
|
-
{
|
|
2279
|
-
"kind": "Content",
|
|
2280
|
-
"text": "number"
|
|
2281
|
-
},
|
|
2282
|
-
{
|
|
2283
|
-
"kind": "Content",
|
|
2284
|
-
"text": ";"
|
|
2285
|
-
}
|
|
2286
|
-
],
|
|
2287
|
-
"isReadonly": false,
|
|
2288
|
-
"isOptional": true,
|
|
2289
|
-
"releaseTag": "Beta",
|
|
2290
|
-
"name": "restrictResolution",
|
|
2291
|
-
"propertyTypeTokenRange": {
|
|
2292
|
-
"startIndex": 1,
|
|
2293
|
-
"endIndex": 2
|
|
2294
|
-
}
|
|
2295
|
-
}
|
|
2296
|
-
],
|
|
2297
|
-
"extendsTokenRanges": []
|
|
2298
|
-
},
|
|
2299
2111
|
{
|
|
2300
2112
|
"kind": "Class",
|
|
2301
2113
|
"canonicalReference": "@gcorevideo/player!Logo:class",
|
|
@@ -2577,7 +2389,7 @@
|
|
|
2577
2389
|
{
|
|
2578
2390
|
"kind": "Class",
|
|
2579
2391
|
"canonicalReference": "@gcorevideo/player!MediaControl:class",
|
|
2580
|
-
"docComment": "/**\n * `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI.\n *\n * @beta\n */\n",
|
|
2392
|
+
"docComment": "/**\n * `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI.\n *\n * Configuration options:\n *\n * - `mediaControl`: {@link MediaControlSettings} - specifies the allowed media control elements in each area\n *\n * - `persistConfig`: boolean - `common` option, makes the plugin persist the media control settings\n *\n * - `chromeless`: boolean\n *\n * @beta\n */\n",
|
|
2581
2393
|
"excerptTokens": [
|
|
2582
2394
|
{
|
|
2583
2395
|
"kind": "Content",
|
|
@@ -2840,63 +2652,6 @@
|
|
|
2840
2652
|
"isAbstract": false,
|
|
2841
2653
|
"name": "getElement"
|
|
2842
2654
|
},
|
|
2843
|
-
{
|
|
2844
|
-
"kind": "Method",
|
|
2845
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#handleCustomArea:member(1)",
|
|
2846
|
-
"docComment": "",
|
|
2847
|
-
"excerptTokens": [
|
|
2848
|
-
{
|
|
2849
|
-
"kind": "Content",
|
|
2850
|
-
"text": "handleCustomArea(handler: "
|
|
2851
|
-
},
|
|
2852
|
-
{
|
|
2853
|
-
"kind": "Content",
|
|
2854
|
-
"text": "(name: string, content: "
|
|
2855
|
-
},
|
|
2856
|
-
{
|
|
2857
|
-
"kind": "Reference",
|
|
2858
|
-
"text": "HTMLElement",
|
|
2859
|
-
"canonicalReference": "!HTMLElement:interface"
|
|
2860
|
-
},
|
|
2861
|
-
{
|
|
2862
|
-
"kind": "Content",
|
|
2863
|
-
"text": ") => void"
|
|
2864
|
-
},
|
|
2865
|
-
{
|
|
2866
|
-
"kind": "Content",
|
|
2867
|
-
"text": "): "
|
|
2868
|
-
},
|
|
2869
|
-
{
|
|
2870
|
-
"kind": "Content",
|
|
2871
|
-
"text": "void"
|
|
2872
|
-
},
|
|
2873
|
-
{
|
|
2874
|
-
"kind": "Content",
|
|
2875
|
-
"text": ";"
|
|
2876
|
-
}
|
|
2877
|
-
],
|
|
2878
|
-
"isStatic": false,
|
|
2879
|
-
"returnTypeTokenRange": {
|
|
2880
|
-
"startIndex": 5,
|
|
2881
|
-
"endIndex": 6
|
|
2882
|
-
},
|
|
2883
|
-
"releaseTag": "Beta",
|
|
2884
|
-
"isProtected": false,
|
|
2885
|
-
"overloadIndex": 1,
|
|
2886
|
-
"parameters": [
|
|
2887
|
-
{
|
|
2888
|
-
"parameterName": "handler",
|
|
2889
|
-
"parameterTypeTokenRange": {
|
|
2890
|
-
"startIndex": 1,
|
|
2891
|
-
"endIndex": 4
|
|
2892
|
-
},
|
|
2893
|
-
"isOptional": false
|
|
2894
|
-
}
|
|
2895
|
-
],
|
|
2896
|
-
"isOptional": false,
|
|
2897
|
-
"isAbstract": false,
|
|
2898
|
-
"name": "handleCustomArea"
|
|
2899
|
-
},
|
|
2900
2655
|
{
|
|
2901
2656
|
"kind": "Property",
|
|
2902
2657
|
"canonicalReference": "@gcorevideo/player!MediaControl#muted:member",
|
|
@@ -3193,15 +2948,34 @@
|
|
|
3193
2948
|
{
|
|
3194
2949
|
"kind": "TypeAlias",
|
|
3195
2950
|
"canonicalReference": "@gcorevideo/player!MediaControlElement:type",
|
|
3196
|
-
"docComment": "/**\n *
|
|
2951
|
+
"docComment": "/**\n * Built-in media control elements.\n *\n * @beta\n */\n",
|
|
3197
2952
|
"excerptTokens": [
|
|
3198
2953
|
{
|
|
3199
2954
|
"kind": "Content",
|
|
3200
2955
|
"text": "export type MediaControlElement = "
|
|
3201
2956
|
},
|
|
2957
|
+
{
|
|
2958
|
+
"kind": "Reference",
|
|
2959
|
+
"text": "MediaControlLeftElement",
|
|
2960
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
|
|
2961
|
+
},
|
|
3202
2962
|
{
|
|
3203
2963
|
"kind": "Content",
|
|
3204
|
-
"text": "
|
|
2964
|
+
"text": " | "
|
|
2965
|
+
},
|
|
2966
|
+
{
|
|
2967
|
+
"kind": "Reference",
|
|
2968
|
+
"text": "MediaControlLayerElement",
|
|
2969
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
|
|
2970
|
+
},
|
|
2971
|
+
{
|
|
2972
|
+
"kind": "Content",
|
|
2973
|
+
"text": " | "
|
|
2974
|
+
},
|
|
2975
|
+
{
|
|
2976
|
+
"kind": "Reference",
|
|
2977
|
+
"text": "MediaControlRightElement",
|
|
2978
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
|
|
3205
2979
|
},
|
|
3206
2980
|
{
|
|
3207
2981
|
"kind": "Content",
|
|
@@ -3211,6 +2985,163 @@
|
|
|
3211
2985
|
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3212
2986
|
"releaseTag": "Beta",
|
|
3213
2987
|
"name": "MediaControlElement",
|
|
2988
|
+
"typeTokenRange": {
|
|
2989
|
+
"startIndex": 1,
|
|
2990
|
+
"endIndex": 6
|
|
2991
|
+
}
|
|
2992
|
+
},
|
|
2993
|
+
{
|
|
2994
|
+
"kind": "TypeAlias",
|
|
2995
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type",
|
|
2996
|
+
"docComment": "/**\n * Media control elements that appear in main layer, spanning the entire width of the player.\n *\n * @beta\n */\n",
|
|
2997
|
+
"excerptTokens": [
|
|
2998
|
+
{
|
|
2999
|
+
"kind": "Content",
|
|
3000
|
+
"text": "export type MediaControlLayerElement = "
|
|
3001
|
+
},
|
|
3002
|
+
{
|
|
3003
|
+
"kind": "Content",
|
|
3004
|
+
"text": "'seekbar' | 'seekBarContainer'"
|
|
3005
|
+
},
|
|
3006
|
+
{
|
|
3007
|
+
"kind": "Content",
|
|
3008
|
+
"text": ";"
|
|
3009
|
+
}
|
|
3010
|
+
],
|
|
3011
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3012
|
+
"releaseTag": "Beta",
|
|
3013
|
+
"name": "MediaControlLayerElement",
|
|
3014
|
+
"typeTokenRange": {
|
|
3015
|
+
"startIndex": 1,
|
|
3016
|
+
"endIndex": 2
|
|
3017
|
+
}
|
|
3018
|
+
},
|
|
3019
|
+
{
|
|
3020
|
+
"kind": "TypeAlias",
|
|
3021
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type",
|
|
3022
|
+
"docComment": "/**\n * Media control elements that appear in the left area.\n *\n * @beta\n */\n",
|
|
3023
|
+
"excerptTokens": [
|
|
3024
|
+
{
|
|
3025
|
+
"kind": "Content",
|
|
3026
|
+
"text": "export type MediaControlLeftElement = "
|
|
3027
|
+
},
|
|
3028
|
+
{
|
|
3029
|
+
"kind": "Content",
|
|
3030
|
+
"text": "'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume'"
|
|
3031
|
+
},
|
|
3032
|
+
{
|
|
3033
|
+
"kind": "Content",
|
|
3034
|
+
"text": ";"
|
|
3035
|
+
}
|
|
3036
|
+
],
|
|
3037
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3038
|
+
"releaseTag": "Beta",
|
|
3039
|
+
"name": "MediaControlLeftElement",
|
|
3040
|
+
"typeTokenRange": {
|
|
3041
|
+
"startIndex": 1,
|
|
3042
|
+
"endIndex": 2
|
|
3043
|
+
}
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
"kind": "TypeAlias",
|
|
3047
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type",
|
|
3048
|
+
"docComment": "/**\n * Media control elements that appear in the right area.\n *\n * @beta\n */\n",
|
|
3049
|
+
"excerptTokens": [
|
|
3050
|
+
{
|
|
3051
|
+
"kind": "Content",
|
|
3052
|
+
"text": "export type MediaControlRightElement = "
|
|
3053
|
+
},
|
|
3054
|
+
{
|
|
3055
|
+
"kind": "Content",
|
|
3056
|
+
"text": "'audiotracks' | 'cc' | 'fullscreen' | 'hd-indicator' | 'gear' | 'multicamera' | 'pip' | 'vr'"
|
|
3057
|
+
},
|
|
3058
|
+
{
|
|
3059
|
+
"kind": "Content",
|
|
3060
|
+
"text": ";"
|
|
3061
|
+
}
|
|
3062
|
+
],
|
|
3063
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3064
|
+
"releaseTag": "Beta",
|
|
3065
|
+
"name": "MediaControlRightElement",
|
|
3066
|
+
"typeTokenRange": {
|
|
3067
|
+
"startIndex": 1,
|
|
3068
|
+
"endIndex": 2
|
|
3069
|
+
}
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"kind": "TypeAlias",
|
|
3073
|
+
"canonicalReference": "@gcorevideo/player!MediaControlSettings:type",
|
|
3074
|
+
"docComment": "/**\n * Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.\n *\n * @beta\n */\n",
|
|
3075
|
+
"excerptTokens": [
|
|
3076
|
+
{
|
|
3077
|
+
"kind": "Content",
|
|
3078
|
+
"text": "export type MediaControlSettings = "
|
|
3079
|
+
},
|
|
3080
|
+
{
|
|
3081
|
+
"kind": "Content",
|
|
3082
|
+
"text": "{\n left: "
|
|
3083
|
+
},
|
|
3084
|
+
{
|
|
3085
|
+
"kind": "Reference",
|
|
3086
|
+
"text": "MediaControlLeftElement",
|
|
3087
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
|
|
3088
|
+
},
|
|
3089
|
+
{
|
|
3090
|
+
"kind": "Content",
|
|
3091
|
+
"text": "[];\n right: "
|
|
3092
|
+
},
|
|
3093
|
+
{
|
|
3094
|
+
"kind": "Reference",
|
|
3095
|
+
"text": "MediaControlRightElement",
|
|
3096
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
|
|
3097
|
+
},
|
|
3098
|
+
{
|
|
3099
|
+
"kind": "Content",
|
|
3100
|
+
"text": "[];\n default: "
|
|
3101
|
+
},
|
|
3102
|
+
{
|
|
3103
|
+
"kind": "Reference",
|
|
3104
|
+
"text": "MediaControlLayerElement",
|
|
3105
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
|
|
3106
|
+
},
|
|
3107
|
+
{
|
|
3108
|
+
"kind": "Content",
|
|
3109
|
+
"text": "[];\n seekEnabled: boolean;\n}"
|
|
3110
|
+
},
|
|
3111
|
+
{
|
|
3112
|
+
"kind": "Content",
|
|
3113
|
+
"text": ";"
|
|
3114
|
+
}
|
|
3115
|
+
],
|
|
3116
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3117
|
+
"releaseTag": "Beta",
|
|
3118
|
+
"name": "MediaControlSettings",
|
|
3119
|
+
"typeTokenRange": {
|
|
3120
|
+
"startIndex": 1,
|
|
3121
|
+
"endIndex": 8
|
|
3122
|
+
}
|
|
3123
|
+
},
|
|
3124
|
+
{
|
|
3125
|
+
"kind": "TypeAlias",
|
|
3126
|
+
"canonicalReference": "@gcorevideo/player!MenuOption:type",
|
|
3127
|
+
"docComment": "/**\n * @beta\n */\n",
|
|
3128
|
+
"excerptTokens": [
|
|
3129
|
+
{
|
|
3130
|
+
"kind": "Content",
|
|
3131
|
+
"text": "export type MenuOption = "
|
|
3132
|
+
},
|
|
3133
|
+
{
|
|
3134
|
+
"kind": "Content",
|
|
3135
|
+
"text": "{\n label?: string;\n labelKey?: string;\n name: string;\n handler?: () => void;\n icon?: string;\n}"
|
|
3136
|
+
},
|
|
3137
|
+
{
|
|
3138
|
+
"kind": "Content",
|
|
3139
|
+
"text": ";"
|
|
3140
|
+
}
|
|
3141
|
+
],
|
|
3142
|
+
"fileUrlPath": "src/plugins/context-menu/ContextMenu.ts",
|
|
3143
|
+
"releaseTag": "Beta",
|
|
3144
|
+
"name": "MenuOption",
|
|
3214
3145
|
"typeTokenRange": {
|
|
3215
3146
|
"startIndex": 1,
|
|
3216
3147
|
"endIndex": 2
|
|
@@ -3999,7 +3930,7 @@
|
|
|
3999
3930
|
{
|
|
4000
3931
|
"kind": "Class",
|
|
4001
3932
|
"canonicalReference": "@gcorevideo/player!PlaybackRate:class",
|
|
4002
|
-
"docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR-enabled live streams.\n *\n * Plugin settings - {@link PlaybackRateSettings}\n *\n * @example\n * ```ts\n * import { Player, PlaybackRateSettings } from '@gcorevideo/player'\n * Player.registerPlugin(PlaybackRate)\n * const player = new Player({\n * playbackRate: {\n * options: [\n * { value: 0.5, label: '0.5x' },\n * { value: 1, label: '1x' },\n * ],\n * defaultValue: 1,\n * }
|
|
3933
|
+
"docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * It renders an option in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR-enabled live streams.\n *\n * Plugin settings - {@link PlaybackRateSettings}\n *\n * @example\n * ```ts\n * import { Player, PlaybackRateSettings } from '@gcorevideo/player'\n * Player.registerPlugin(PlaybackRate)\n * const player = new Player({\n * playbackRate: {\n * options: [\n * { value: 0.5, label: '0.5x' },\n * { value: 1, label: '1x' },\n * ],\n * defaultValue: 1,\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
4003
3934
|
"excerptTokens": [
|
|
4004
3935
|
{
|
|
4005
3936
|
"kind": "Content",
|
|
@@ -5359,7 +5290,7 @@
|
|
|
5359
5290
|
{
|
|
5360
5291
|
"kind": "PropertySignature",
|
|
5361
5292
|
"canonicalReference": "@gcorevideo/player!PlayerConfig#playbackType:member",
|
|
5362
|
-
"docComment": "/**\n *
|
|
5293
|
+
"docComment": "/**\n * Stream type. @remark Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.\n */\n",
|
|
5363
5294
|
"excerptTokens": [
|
|
5364
5295
|
{
|
|
5365
5296
|
"kind": "Content",
|
|
@@ -6347,6 +6278,145 @@
|
|
|
6347
6278
|
],
|
|
6348
6279
|
"extendsTokenRanges": []
|
|
6349
6280
|
},
|
|
6281
|
+
{
|
|
6282
|
+
"kind": "Class",
|
|
6283
|
+
"canonicalReference": "@gcorevideo/player!QualityLevels:class",
|
|
6284
|
+
"docComment": "/**\n * `PLUGIN` that provides a UI to select the desired quality level of the playback.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * - {@link BottomGear}\n *\n * The plugin is rendered as an item in the gear menu, which, when clicked, shows a list of quality levels to choose from.\n *\n * Configuration options - {@link QualityLevelsPluginSettings}\n *\n * @example\n * ```ts\n * new Player({\n * qualityLevels: {\n * restrictResolution: 360,\n * labels: { 360: 'SD', 720: 'HD' },\n * },\n * })\n * ```\n *\n * @beta\n */\n",
|
|
6285
|
+
"excerptTokens": [
|
|
6286
|
+
{
|
|
6287
|
+
"kind": "Content",
|
|
6288
|
+
"text": "export declare class QualityLevels extends "
|
|
6289
|
+
},
|
|
6290
|
+
{
|
|
6291
|
+
"kind": "Reference",
|
|
6292
|
+
"text": "UICorePlugin",
|
|
6293
|
+
"canonicalReference": "@gcorevideo/player!~UICorePlugin"
|
|
6294
|
+
},
|
|
6295
|
+
{
|
|
6296
|
+
"kind": "Content",
|
|
6297
|
+
"text": " "
|
|
6298
|
+
}
|
|
6299
|
+
],
|
|
6300
|
+
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
6301
|
+
"releaseTag": "Beta",
|
|
6302
|
+
"isAbstract": false,
|
|
6303
|
+
"name": "QualityLevels",
|
|
6304
|
+
"preserveMemberOrder": false,
|
|
6305
|
+
"members": [
|
|
6306
|
+
{
|
|
6307
|
+
"kind": "Property",
|
|
6308
|
+
"canonicalReference": "@gcorevideo/player!QualityLevels#events:member",
|
|
6309
|
+
"docComment": "",
|
|
6310
|
+
"excerptTokens": [
|
|
6311
|
+
{
|
|
6312
|
+
"kind": "Content",
|
|
6313
|
+
"text": "get events(): "
|
|
6314
|
+
},
|
|
6315
|
+
{
|
|
6316
|
+
"kind": "Content",
|
|
6317
|
+
"text": "{\n 'click .gear-sub-menu_btn': string;\n 'click .go-back': string;\n }"
|
|
6318
|
+
},
|
|
6319
|
+
{
|
|
6320
|
+
"kind": "Content",
|
|
6321
|
+
"text": ";"
|
|
6322
|
+
}
|
|
6323
|
+
],
|
|
6324
|
+
"isReadonly": true,
|
|
6325
|
+
"isOptional": false,
|
|
6326
|
+
"releaseTag": "Beta",
|
|
6327
|
+
"name": "events",
|
|
6328
|
+
"propertyTypeTokenRange": {
|
|
6329
|
+
"startIndex": 1,
|
|
6330
|
+
"endIndex": 2
|
|
6331
|
+
},
|
|
6332
|
+
"isStatic": false,
|
|
6333
|
+
"isProtected": false,
|
|
6334
|
+
"isAbstract": false
|
|
6335
|
+
}
|
|
6336
|
+
],
|
|
6337
|
+
"extendsTokenRange": {
|
|
6338
|
+
"startIndex": 1,
|
|
6339
|
+
"endIndex": 2
|
|
6340
|
+
},
|
|
6341
|
+
"implementsTokenRanges": []
|
|
6342
|
+
},
|
|
6343
|
+
{
|
|
6344
|
+
"kind": "Interface",
|
|
6345
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings:interface",
|
|
6346
|
+
"docComment": "/**\n * Configuration options for the {@link QualityLevels} plugin.\n *\n * @beta\n */\n",
|
|
6347
|
+
"excerptTokens": [
|
|
6348
|
+
{
|
|
6349
|
+
"kind": "Content",
|
|
6350
|
+
"text": "export interface QualityLevelsPluginSettings "
|
|
6351
|
+
}
|
|
6352
|
+
],
|
|
6353
|
+
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
6354
|
+
"releaseTag": "Beta",
|
|
6355
|
+
"name": "QualityLevelsPluginSettings",
|
|
6356
|
+
"preserveMemberOrder": false,
|
|
6357
|
+
"members": [
|
|
6358
|
+
{
|
|
6359
|
+
"kind": "PropertySignature",
|
|
6360
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings#labels:member",
|
|
6361
|
+
"docComment": "/**\n * The labels to show in the level selector.\n *\n * @example\n * ```ts\n * { 360: 'SD', 720: 'HD' }\n * ```\n *\n */\n",
|
|
6362
|
+
"excerptTokens": [
|
|
6363
|
+
{
|
|
6364
|
+
"kind": "Content",
|
|
6365
|
+
"text": "labels?: "
|
|
6366
|
+
},
|
|
6367
|
+
{
|
|
6368
|
+
"kind": "Reference",
|
|
6369
|
+
"text": "Record",
|
|
6370
|
+
"canonicalReference": "!Record:type"
|
|
6371
|
+
},
|
|
6372
|
+
{
|
|
6373
|
+
"kind": "Content",
|
|
6374
|
+
"text": "<number, string>"
|
|
6375
|
+
},
|
|
6376
|
+
{
|
|
6377
|
+
"kind": "Content",
|
|
6378
|
+
"text": ";"
|
|
6379
|
+
}
|
|
6380
|
+
],
|
|
6381
|
+
"isReadonly": false,
|
|
6382
|
+
"isOptional": true,
|
|
6383
|
+
"releaseTag": "Beta",
|
|
6384
|
+
"name": "labels",
|
|
6385
|
+
"propertyTypeTokenRange": {
|
|
6386
|
+
"startIndex": 1,
|
|
6387
|
+
"endIndex": 3
|
|
6388
|
+
}
|
|
6389
|
+
},
|
|
6390
|
+
{
|
|
6391
|
+
"kind": "PropertySignature",
|
|
6392
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings#restrictResolution:member",
|
|
6393
|
+
"docComment": "/**\n * The maximum resolution to allow in the level selector.\n */\n",
|
|
6394
|
+
"excerptTokens": [
|
|
6395
|
+
{
|
|
6396
|
+
"kind": "Content",
|
|
6397
|
+
"text": "restrictResolution?: "
|
|
6398
|
+
},
|
|
6399
|
+
{
|
|
6400
|
+
"kind": "Content",
|
|
6401
|
+
"text": "number"
|
|
6402
|
+
},
|
|
6403
|
+
{
|
|
6404
|
+
"kind": "Content",
|
|
6405
|
+
"text": ";"
|
|
6406
|
+
}
|
|
6407
|
+
],
|
|
6408
|
+
"isReadonly": false,
|
|
6409
|
+
"isOptional": true,
|
|
6410
|
+
"releaseTag": "Beta",
|
|
6411
|
+
"name": "restrictResolution",
|
|
6412
|
+
"propertyTypeTokenRange": {
|
|
6413
|
+
"startIndex": 1,
|
|
6414
|
+
"endIndex": 2
|
|
6415
|
+
}
|
|
6416
|
+
}
|
|
6417
|
+
],
|
|
6418
|
+
"extendsTokenRanges": []
|
|
6419
|
+
},
|
|
6350
6420
|
{
|
|
6351
6421
|
"kind": "Class",
|
|
6352
6422
|
"canonicalReference": "@gcorevideo/player!SeekTime:class",
|