@gcorevideo/player 2.22.15 → 2.22.17
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/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 +6 -8
- package/dist/index.css +855 -855
- package/dist/index.js +609 -664
- package/dist/player.d.ts +426 -302
- package/dist/plugins/index.css +551 -551
- package/dist/plugins/index.js +648 -703
- package/docs/api/{player.audioselector.md → player.audiotracks.md} +3 -3
- package/docs/api/player.clapprstats.exportmetrics.md +1 -1
- package/docs/api/player.clapprstats.md +5 -15
- package/docs/api/player.clapprstatssettings.md +13 -0
- package/docs/api/{player.contextmenupluginsettings.preventshowcontextmenu.md → player.clips.destroy.md} +7 -3
- package/docs/api/{player.contextmenupluginsettings.label.md → player.clips.disable.md} +7 -3
- package/docs/api/player.clips.enable.md +18 -0
- package/docs/api/player.clips.md +170 -0
- package/docs/api/player.clips.render.md +18 -0
- package/docs/api/player.clips.supportedversion.md +16 -0
- package/docs/api/player.clips.version.md +14 -0
- package/docs/api/player.clipspluginsettings.md +2 -2
- package/docs/api/player.clipspluginsettings.text.md +1 -1
- package/docs/api/player.contextmenu.md +2 -0
- package/docs/api/player.contextmenupluginsettings.md +2 -40
- package/docs/api/{player.contextmenupluginsettings.url.md → player.contextmenupluginsettings.options.md} +3 -3
- package/docs/api/player.md +101 -37
- package/docs/api/player.mediacontrol.md +9 -15
- package/docs/api/{player.mediacontrol.getelement.md → player.mediacontrol.mount.md} +20 -7
- package/docs/api/player.mediacontrolelement.md +4 -2
- package/docs/api/player.mediacontrollayerelement.md +16 -0
- 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.menuoption.md +21 -0
- package/docs/api/{player.clapprnerdstats._constructor_.md → player.nerdstats._constructor_.md} +3 -3
- package/docs/api/{player.clapprnerdstats.md → player.nerdstats.md} +5 -5
- 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.qualitylevel.height.md +1 -1
- package/docs/api/player.qualitylevel.level.md +1 -1
- package/docs/api/player.qualitylevel.md +4 -4
- package/docs/api/player.qualitylevel.width.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/docs/api/player.timeposition.current.md +1 -1
- package/docs/api/player.timeposition.md +2 -2
- package/docs/api/player.timeposition.total.md +1 -1
- package/docs/api/player.timeprogress.md +6 -4
- package/docs/api/player.timevalue.md +1 -1
- package/lib/index.plugins.d.ts +2 -1
- package/lib/index.plugins.d.ts.map +1 -1
- package/lib/index.plugins.js +2 -1
- package/lib/playback/dash-playback/DashPlayback.d.ts.map +1 -1
- package/lib/playback/dash-playback/DashPlayback.js +5 -7
- package/lib/playback.types.d.ts +22 -9
- package/lib/playback.types.d.ts.map +1 -1
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts +4 -0
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts.map +1 -1
- package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js +20 -23
- package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts +83 -0
- package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts.map +1 -0
- package/lib/plugins/clappr-nerd-stats/NerdStats.js +339 -0
- package/lib/plugins/clappr-stats/ClapprStats.d.ts +27 -32
- package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
- package/lib/plugins/clappr-stats/ClapprStats.js +94 -202
- package/lib/plugins/clappr-stats/types.d.ts +65 -24
- package/lib/plugins/clappr-stats/types.d.ts.map +1 -1
- package/lib/plugins/clappr-stats/types.js +37 -2
- package/lib/plugins/clappr-stats/utils.d.ts.map +1 -1
- package/lib/plugins/clappr-stats/utils.js +1 -2
- 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/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 +2 -1
- package/lib/testUtils.d.ts.map +1 -1
- package/lib/testUtils.js +5 -7
- package/package.json +1 -1
- package/src/index.plugins.ts +2 -1
- package/src/playback/dash-playback/DashPlayback.ts +5 -8
- package/src/playback.types.ts +23 -8
- package/src/plugins/clappr-nerd-stats/{ClapprNerdStats.ts → NerdStats.ts} +25 -30
- package/src/plugins/clappr-stats/ClapprStats.ts +242 -306
- package/src/plugins/clappr-stats/__tests__/ClapprStats.test.ts +133 -0
- package/src/plugins/clappr-stats/types.ts +72 -25
- package/src/plugins/clappr-stats/utils.ts +1 -2
- 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/error-screen/__tests__/ErrorScreen.test.ts +3 -4
- 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__/__snapshots__/MediaControl.test.ts.snap +7 -35
- package/src/plugins/subtitles/__tests__/ClosedCaptions.test.ts +1 -0
- package/src/plugins/utils.ts +9 -7
- package/src/plugins/vast-ads/loaderxml.ts +2 -2
- package/src/testUtils.ts +5 -7
- package/temp/player.api.json +693 -471
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/api/player.clapprstats.setupdatemetrics.md +0 -56
- package/docs/api/player.clipsplugin.gettext.md +0 -58
- package/docs/api/player.clipsplugin.md +0 -59
- 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": {
|
|
@@ -363,75 +363,10 @@
|
|
|
363
363
|
},
|
|
364
364
|
"implementsTokenRanges": []
|
|
365
365
|
},
|
|
366
|
-
{
|
|
367
|
-
"kind": "Class",
|
|
368
|
-
"canonicalReference": "@gcorevideo/player!ClapprNerdStats:class",
|
|
369
|
-
"docComment": "/**\n * `PLUGIN` that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
|
|
370
|
-
"excerptTokens": [
|
|
371
|
-
{
|
|
372
|
-
"kind": "Content",
|
|
373
|
-
"text": "export declare class ClapprNerdStats extends "
|
|
374
|
-
},
|
|
375
|
-
{
|
|
376
|
-
"kind": "Reference",
|
|
377
|
-
"text": "UICorePlugin",
|
|
378
|
-
"canonicalReference": "@gcorevideo/player!~UICorePlugin"
|
|
379
|
-
},
|
|
380
|
-
{
|
|
381
|
-
"kind": "Content",
|
|
382
|
-
"text": " "
|
|
383
|
-
}
|
|
384
|
-
],
|
|
385
|
-
"fileUrlPath": "src/plugins/clappr-nerd-stats/ClapprNerdStats.ts",
|
|
386
|
-
"releaseTag": "Beta",
|
|
387
|
-
"isAbstract": false,
|
|
388
|
-
"name": "ClapprNerdStats",
|
|
389
|
-
"preserveMemberOrder": false,
|
|
390
|
-
"members": [
|
|
391
|
-
{
|
|
392
|
-
"kind": "Constructor",
|
|
393
|
-
"canonicalReference": "@gcorevideo/player!ClapprNerdStats:constructor(1)",
|
|
394
|
-
"docComment": "/**\n * Constructs a new instance of the `ClapprNerdStats` class\n */\n",
|
|
395
|
-
"excerptTokens": [
|
|
396
|
-
{
|
|
397
|
-
"kind": "Content",
|
|
398
|
-
"text": "constructor(core: "
|
|
399
|
-
},
|
|
400
|
-
{
|
|
401
|
-
"kind": "Reference",
|
|
402
|
-
"text": "Core",
|
|
403
|
-
"canonicalReference": "@clappr/core!default:class"
|
|
404
|
-
},
|
|
405
|
-
{
|
|
406
|
-
"kind": "Content",
|
|
407
|
-
"text": ");"
|
|
408
|
-
}
|
|
409
|
-
],
|
|
410
|
-
"releaseTag": "Beta",
|
|
411
|
-
"isProtected": false,
|
|
412
|
-
"overloadIndex": 1,
|
|
413
|
-
"parameters": [
|
|
414
|
-
{
|
|
415
|
-
"parameterName": "core",
|
|
416
|
-
"parameterTypeTokenRange": {
|
|
417
|
-
"startIndex": 1,
|
|
418
|
-
"endIndex": 2
|
|
419
|
-
},
|
|
420
|
-
"isOptional": false
|
|
421
|
-
}
|
|
422
|
-
]
|
|
423
|
-
}
|
|
424
|
-
],
|
|
425
|
-
"extendsTokenRange": {
|
|
426
|
-
"startIndex": 1,
|
|
427
|
-
"endIndex": 2
|
|
428
|
-
},
|
|
429
|
-
"implementsTokenRanges": []
|
|
430
|
-
},
|
|
431
366
|
{
|
|
432
367
|
"kind": "Class",
|
|
433
368
|
"canonicalReference": "@gcorevideo/player!ClapprStats:class",
|
|
434
|
-
"docComment": "/**\n * `PLUGIN` that
|
|
369
|
+
"docComment": "/**\n * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @beta\n */\n",
|
|
435
370
|
"excerptTokens": [
|
|
436
371
|
{
|
|
437
372
|
"kind": "Content",
|
|
@@ -489,7 +424,7 @@
|
|
|
489
424
|
{
|
|
490
425
|
"kind": "Method",
|
|
491
426
|
"canonicalReference": "@gcorevideo/player!ClapprStats#exportMetrics:member(1)",
|
|
492
|
-
"docComment": "/**\n * Returns the collected metrics.\n *\n * @returns
|
|
427
|
+
"docComment": "/**\n * Returns the collected metrics.\n *\n * @returns Measurements collected so far\n */\n",
|
|
493
428
|
"excerptTokens": [
|
|
494
429
|
{
|
|
495
430
|
"kind": "Content",
|
|
@@ -517,55 +452,6 @@
|
|
|
517
452
|
"isOptional": false,
|
|
518
453
|
"isAbstract": false,
|
|
519
454
|
"name": "exportMetrics"
|
|
520
|
-
},
|
|
521
|
-
{
|
|
522
|
-
"kind": "Method",
|
|
523
|
-
"canonicalReference": "@gcorevideo/player!ClapprStats#setUpdateMetrics:member(1)",
|
|
524
|
-
"docComment": "/**\n * Registers a callback to receive the metrics.\n *\n * @param updateMetricsFn - The callback to receive the metrics\n */\n",
|
|
525
|
-
"excerptTokens": [
|
|
526
|
-
{
|
|
527
|
-
"kind": "Content",
|
|
528
|
-
"text": "setUpdateMetrics(updateMetricsFn: "
|
|
529
|
-
},
|
|
530
|
-
{
|
|
531
|
-
"kind": "Reference",
|
|
532
|
-
"text": "MetricsUpdateFn",
|
|
533
|
-
"canonicalReference": "@gcorevideo/player!~MetricsUpdateFn:type"
|
|
534
|
-
},
|
|
535
|
-
{
|
|
536
|
-
"kind": "Content",
|
|
537
|
-
"text": "): "
|
|
538
|
-
},
|
|
539
|
-
{
|
|
540
|
-
"kind": "Content",
|
|
541
|
-
"text": "void"
|
|
542
|
-
},
|
|
543
|
-
{
|
|
544
|
-
"kind": "Content",
|
|
545
|
-
"text": ";"
|
|
546
|
-
}
|
|
547
|
-
],
|
|
548
|
-
"isStatic": false,
|
|
549
|
-
"returnTypeTokenRange": {
|
|
550
|
-
"startIndex": 3,
|
|
551
|
-
"endIndex": 4
|
|
552
|
-
},
|
|
553
|
-
"releaseTag": "Beta",
|
|
554
|
-
"isProtected": false,
|
|
555
|
-
"overloadIndex": 1,
|
|
556
|
-
"parameters": [
|
|
557
|
-
{
|
|
558
|
-
"parameterName": "updateMetricsFn",
|
|
559
|
-
"parameterTypeTokenRange": {
|
|
560
|
-
"startIndex": 1,
|
|
561
|
-
"endIndex": 2
|
|
562
|
-
},
|
|
563
|
-
"isOptional": false
|
|
564
|
-
}
|
|
565
|
-
],
|
|
566
|
-
"isOptional": false,
|
|
567
|
-
"isAbstract": false,
|
|
568
|
-
"name": "setUpdateMetrics"
|
|
569
455
|
}
|
|
570
456
|
],
|
|
571
457
|
"extendsTokenRange": {
|
|
@@ -574,6 +460,32 @@
|
|
|
574
460
|
},
|
|
575
461
|
"implementsTokenRanges": []
|
|
576
462
|
},
|
|
463
|
+
{
|
|
464
|
+
"kind": "TypeAlias",
|
|
465
|
+
"canonicalReference": "@gcorevideo/player!ClapprStatsSettings:type",
|
|
466
|
+
"docComment": "",
|
|
467
|
+
"excerptTokens": [
|
|
468
|
+
{
|
|
469
|
+
"kind": "Content",
|
|
470
|
+
"text": "export type ClapprStatsSettings = "
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"kind": "Content",
|
|
474
|
+
"text": "{\n runEach?: number;\n}"
|
|
475
|
+
},
|
|
476
|
+
{
|
|
477
|
+
"kind": "Content",
|
|
478
|
+
"text": ";"
|
|
479
|
+
}
|
|
480
|
+
],
|
|
481
|
+
"fileUrlPath": "src/plugins/clappr-stats/ClapprStats.ts",
|
|
482
|
+
"releaseTag": "Public",
|
|
483
|
+
"name": "ClapprStatsSettings",
|
|
484
|
+
"typeTokenRange": {
|
|
485
|
+
"startIndex": 1,
|
|
486
|
+
"endIndex": 2
|
|
487
|
+
}
|
|
488
|
+
},
|
|
577
489
|
{
|
|
578
490
|
"kind": "Class",
|
|
579
491
|
"canonicalReference": "@gcorevideo/player!ClickToPause:class",
|
|
@@ -607,12 +519,12 @@
|
|
|
607
519
|
},
|
|
608
520
|
{
|
|
609
521
|
"kind": "Class",
|
|
610
|
-
"canonicalReference": "@gcorevideo/player!
|
|
611
|
-
"docComment": "/**\n * `PLUGIN` that
|
|
522
|
+
"canonicalReference": "@gcorevideo/player!Clips:class",
|
|
523
|
+
"docComment": "/**\n * `PLUGIN` that allows marking up the timeline of the video\n *\n * @remarks\n *\n * The plugin decorates the seekbar with notches to indicate the clips of the video and displays current clip text in the left panel\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
|
|
612
524
|
"excerptTokens": [
|
|
613
525
|
{
|
|
614
526
|
"kind": "Content",
|
|
615
|
-
"text": "export declare class
|
|
527
|
+
"text": "export declare class Clips extends "
|
|
616
528
|
},
|
|
617
529
|
{
|
|
618
530
|
"kind": "Reference",
|
|
@@ -627,29 +539,57 @@
|
|
|
627
539
|
"fileUrlPath": "src/plugins/clips/Clips.ts",
|
|
628
540
|
"releaseTag": "Beta",
|
|
629
541
|
"isAbstract": false,
|
|
630
|
-
"name": "
|
|
542
|
+
"name": "Clips",
|
|
631
543
|
"preserveMemberOrder": false,
|
|
632
544
|
"members": [
|
|
633
545
|
{
|
|
634
546
|
"kind": "Method",
|
|
635
|
-
"canonicalReference": "@gcorevideo/player!
|
|
636
|
-
"docComment": "
|
|
547
|
+
"canonicalReference": "@gcorevideo/player!Clips#destroy:member(1)",
|
|
548
|
+
"docComment": "",
|
|
637
549
|
"excerptTokens": [
|
|
638
550
|
{
|
|
639
551
|
"kind": "Content",
|
|
640
|
-
"text": "
|
|
552
|
+
"text": "destroy(): "
|
|
641
553
|
},
|
|
642
554
|
{
|
|
643
555
|
"kind": "Content",
|
|
644
|
-
"text": "
|
|
556
|
+
"text": "import(\"@clappr/core\")."
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"kind": "Reference",
|
|
560
|
+
"text": "UIObject",
|
|
561
|
+
"canonicalReference": "@clappr/core!default:class"
|
|
645
562
|
},
|
|
646
563
|
{
|
|
647
564
|
"kind": "Content",
|
|
648
|
-
"text": "
|
|
565
|
+
"text": ";"
|
|
566
|
+
}
|
|
567
|
+
],
|
|
568
|
+
"isStatic": false,
|
|
569
|
+
"returnTypeTokenRange": {
|
|
570
|
+
"startIndex": 1,
|
|
571
|
+
"endIndex": 3
|
|
572
|
+
},
|
|
573
|
+
"releaseTag": "Beta",
|
|
574
|
+
"isProtected": false,
|
|
575
|
+
"overloadIndex": 1,
|
|
576
|
+
"parameters": [],
|
|
577
|
+
"isOptional": false,
|
|
578
|
+
"isAbstract": false,
|
|
579
|
+
"name": "destroy"
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"kind": "Method",
|
|
583
|
+
"canonicalReference": "@gcorevideo/player!Clips#disable:member(1)",
|
|
584
|
+
"docComment": "",
|
|
585
|
+
"excerptTokens": [
|
|
586
|
+
{
|
|
587
|
+
"kind": "Content",
|
|
588
|
+
"text": "disable(): "
|
|
649
589
|
},
|
|
650
590
|
{
|
|
651
591
|
"kind": "Content",
|
|
652
|
-
"text": "
|
|
592
|
+
"text": "void"
|
|
653
593
|
},
|
|
654
594
|
{
|
|
655
595
|
"kind": "Content",
|
|
@@ -658,25 +598,138 @@
|
|
|
658
598
|
],
|
|
659
599
|
"isStatic": false,
|
|
660
600
|
"returnTypeTokenRange": {
|
|
661
|
-
"startIndex":
|
|
662
|
-
"endIndex":
|
|
601
|
+
"startIndex": 1,
|
|
602
|
+
"endIndex": 2
|
|
663
603
|
},
|
|
664
604
|
"releaseTag": "Beta",
|
|
665
605
|
"isProtected": false,
|
|
666
606
|
"overloadIndex": 1,
|
|
667
|
-
"parameters": [
|
|
607
|
+
"parameters": [],
|
|
608
|
+
"isOptional": false,
|
|
609
|
+
"isAbstract": false,
|
|
610
|
+
"name": "disable"
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
"kind": "Method",
|
|
614
|
+
"canonicalReference": "@gcorevideo/player!Clips#enable:member(1)",
|
|
615
|
+
"docComment": "",
|
|
616
|
+
"excerptTokens": [
|
|
668
617
|
{
|
|
669
|
-
"
|
|
670
|
-
"
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
"
|
|
618
|
+
"kind": "Content",
|
|
619
|
+
"text": "enable(): "
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"kind": "Content",
|
|
623
|
+
"text": "void"
|
|
624
|
+
},
|
|
625
|
+
{
|
|
626
|
+
"kind": "Content",
|
|
627
|
+
"text": ";"
|
|
675
628
|
}
|
|
676
629
|
],
|
|
630
|
+
"isStatic": false,
|
|
631
|
+
"returnTypeTokenRange": {
|
|
632
|
+
"startIndex": 1,
|
|
633
|
+
"endIndex": 2
|
|
634
|
+
},
|
|
635
|
+
"releaseTag": "Beta",
|
|
636
|
+
"isProtected": false,
|
|
637
|
+
"overloadIndex": 1,
|
|
638
|
+
"parameters": [],
|
|
677
639
|
"isOptional": false,
|
|
678
640
|
"isAbstract": false,
|
|
679
|
-
"name": "
|
|
641
|
+
"name": "enable"
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"kind": "Method",
|
|
645
|
+
"canonicalReference": "@gcorevideo/player!Clips#render:member(1)",
|
|
646
|
+
"docComment": "",
|
|
647
|
+
"excerptTokens": [
|
|
648
|
+
{
|
|
649
|
+
"kind": "Content",
|
|
650
|
+
"text": "render(): "
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"kind": "Content",
|
|
654
|
+
"text": "this"
|
|
655
|
+
},
|
|
656
|
+
{
|
|
657
|
+
"kind": "Content",
|
|
658
|
+
"text": ";"
|
|
659
|
+
}
|
|
660
|
+
],
|
|
661
|
+
"isStatic": false,
|
|
662
|
+
"returnTypeTokenRange": {
|
|
663
|
+
"startIndex": 1,
|
|
664
|
+
"endIndex": 2
|
|
665
|
+
},
|
|
666
|
+
"releaseTag": "Beta",
|
|
667
|
+
"isProtected": false,
|
|
668
|
+
"overloadIndex": 1,
|
|
669
|
+
"parameters": [],
|
|
670
|
+
"isOptional": false,
|
|
671
|
+
"isAbstract": false,
|
|
672
|
+
"name": "render"
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"kind": "Property",
|
|
676
|
+
"canonicalReference": "@gcorevideo/player!Clips#supportedVersion:member",
|
|
677
|
+
"docComment": "",
|
|
678
|
+
"excerptTokens": [
|
|
679
|
+
{
|
|
680
|
+
"kind": "Content",
|
|
681
|
+
"text": "get supportedVersion(): "
|
|
682
|
+
},
|
|
683
|
+
{
|
|
684
|
+
"kind": "Content",
|
|
685
|
+
"text": "{\n min: string;\n }"
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
"kind": "Content",
|
|
689
|
+
"text": ";"
|
|
690
|
+
}
|
|
691
|
+
],
|
|
692
|
+
"isReadonly": true,
|
|
693
|
+
"isOptional": false,
|
|
694
|
+
"releaseTag": "Beta",
|
|
695
|
+
"name": "supportedVersion",
|
|
696
|
+
"propertyTypeTokenRange": {
|
|
697
|
+
"startIndex": 1,
|
|
698
|
+
"endIndex": 2
|
|
699
|
+
},
|
|
700
|
+
"isStatic": false,
|
|
701
|
+
"isProtected": false,
|
|
702
|
+
"isAbstract": false
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"kind": "Property",
|
|
706
|
+
"canonicalReference": "@gcorevideo/player!Clips#version:member",
|
|
707
|
+
"docComment": "",
|
|
708
|
+
"excerptTokens": [
|
|
709
|
+
{
|
|
710
|
+
"kind": "Content",
|
|
711
|
+
"text": "get version(): "
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
"kind": "Content",
|
|
715
|
+
"text": "string"
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
"kind": "Content",
|
|
719
|
+
"text": ";"
|
|
720
|
+
}
|
|
721
|
+
],
|
|
722
|
+
"isReadonly": true,
|
|
723
|
+
"isOptional": false,
|
|
724
|
+
"releaseTag": "Beta",
|
|
725
|
+
"name": "version",
|
|
726
|
+
"propertyTypeTokenRange": {
|
|
727
|
+
"startIndex": 1,
|
|
728
|
+
"endIndex": 2
|
|
729
|
+
},
|
|
730
|
+
"isStatic": false,
|
|
731
|
+
"isProtected": false,
|
|
732
|
+
"isAbstract": false
|
|
680
733
|
}
|
|
681
734
|
],
|
|
682
735
|
"extendsTokenRange": {
|
|
@@ -688,7 +741,7 @@
|
|
|
688
741
|
{
|
|
689
742
|
"kind": "Interface",
|
|
690
743
|
"canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
|
|
691
|
-
"docComment": "/**\n * Configuration options for the {@link ClipsPlugin
|
|
744
|
+
"docComment": "/**\n * Configuration options for the {@link ClipsPlugin} plugin.\n *\n * @beta\n */\n",
|
|
692
745
|
"excerptTokens": [
|
|
693
746
|
{
|
|
694
747
|
"kind": "Content",
|
|
@@ -703,7 +756,7 @@
|
|
|
703
756
|
{
|
|
704
757
|
"kind": "PropertySignature",
|
|
705
758
|
"canonicalReference": "@gcorevideo/player!ClipsPluginSettings#text:member",
|
|
706
|
-
"docComment": "/**\n * The text
|
|
759
|
+
"docComment": "/**\n * The compiled text of the clips description, one clip per line in format : `HH:MM:SS text` or `MM:SS text` or `SS text`\n */\n",
|
|
707
760
|
"excerptTokens": [
|
|
708
761
|
{
|
|
709
762
|
"kind": "Content",
|
|
@@ -923,7 +976,7 @@
|
|
|
923
976
|
{
|
|
924
977
|
"kind": "Class",
|
|
925
978
|
"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",
|
|
979
|
+
"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
980
|
"excerptTokens": [
|
|
928
981
|
{
|
|
929
982
|
"kind": "Content",
|
|
@@ -1002,70 +1055,21 @@
|
|
|
1002
1055
|
"members": [
|
|
1003
1056
|
{
|
|
1004
1057
|
"kind": "PropertySignature",
|
|
1005
|
-
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#
|
|
1006
|
-
"docComment": "",
|
|
1007
|
-
"excerptTokens": [
|
|
1008
|
-
{
|
|
1009
|
-
"kind": "Content",
|
|
1010
|
-
"text": "label?: "
|
|
1011
|
-
},
|
|
1012
|
-
{
|
|
1013
|
-
"kind": "Content",
|
|
1014
|
-
"text": "string"
|
|
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",
|
|
1058
|
+
"canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings#options:member",
|
|
1033
1059
|
"docComment": "",
|
|
1034
1060
|
"excerptTokens": [
|
|
1035
1061
|
{
|
|
1036
1062
|
"kind": "Content",
|
|
1037
|
-
"text": "
|
|
1063
|
+
"text": "options?: "
|
|
1038
1064
|
},
|
|
1039
1065
|
{
|
|
1040
|
-
"kind": "
|
|
1041
|
-
"text": "
|
|
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?: "
|
|
1066
|
+
"kind": "Reference",
|
|
1067
|
+
"text": "MenuOption",
|
|
1068
|
+
"canonicalReference": "@gcorevideo/player!MenuOption:type"
|
|
1065
1069
|
},
|
|
1066
1070
|
{
|
|
1067
1071
|
"kind": "Content",
|
|
1068
|
-
"text": "
|
|
1072
|
+
"text": "[]"
|
|
1069
1073
|
},
|
|
1070
1074
|
{
|
|
1071
1075
|
"kind": "Content",
|
|
@@ -1075,10 +1079,10 @@
|
|
|
1075
1079
|
"isReadonly": false,
|
|
1076
1080
|
"isOptional": true,
|
|
1077
1081
|
"releaseTag": "Beta",
|
|
1078
|
-
"name": "
|
|
1082
|
+
"name": "options",
|
|
1079
1083
|
"propertyTypeTokenRange": {
|
|
1080
1084
|
"startIndex": 1,
|
|
1081
|
-
"endIndex":
|
|
1085
|
+
"endIndex": 3
|
|
1082
1086
|
}
|
|
1083
1087
|
}
|
|
1084
1088
|
],
|
|
@@ -2038,162 +2042,28 @@
|
|
|
2038
2042
|
{
|
|
2039
2043
|
"parameterName": "array",
|
|
2040
2044
|
"parameterTypeTokenRange": {
|
|
2041
|
-
"startIndex": 1,
|
|
2042
|
-
"endIndex": 2
|
|
2043
|
-
},
|
|
2044
|
-
"isOptional": false
|
|
2045
|
-
}
|
|
2046
|
-
],
|
|
2047
|
-
"isOptional": false,
|
|
2048
|
-
"isAbstract": false,
|
|
2049
|
-
"name": "push"
|
|
2050
|
-
},
|
|
2051
|
-
{
|
|
2052
|
-
"kind": "Property",
|
|
2053
|
-
"canonicalReference": "@gcorevideo/player!GoogleAnalytics#supportedVersion:member",
|
|
2054
|
-
"docComment": "",
|
|
2055
|
-
"excerptTokens": [
|
|
2056
|
-
{
|
|
2057
|
-
"kind": "Content",
|
|
2058
|
-
"text": "get supportedVersion(): "
|
|
2059
|
-
},
|
|
2060
|
-
{
|
|
2061
|
-
"kind": "Content",
|
|
2062
|
-
"text": "{\n min: string;\n }"
|
|
2063
|
-
},
|
|
2064
|
-
{
|
|
2065
|
-
"kind": "Content",
|
|
2066
|
-
"text": ";"
|
|
2067
|
-
}
|
|
2068
|
-
],
|
|
2069
|
-
"isReadonly": true,
|
|
2070
|
-
"isOptional": false,
|
|
2071
|
-
"releaseTag": "Beta",
|
|
2072
|
-
"name": "supportedVersion",
|
|
2073
|
-
"propertyTypeTokenRange": {
|
|
2074
|
-
"startIndex": 1,
|
|
2075
|
-
"endIndex": 2
|
|
2076
|
-
},
|
|
2077
|
-
"isStatic": false,
|
|
2078
|
-
"isProtected": false,
|
|
2079
|
-
"isAbstract": false
|
|
2080
|
-
}
|
|
2081
|
-
],
|
|
2082
|
-
"extendsTokenRange": {
|
|
2083
|
-
"startIndex": 1,
|
|
2084
|
-
"endIndex": 2
|
|
2085
|
-
},
|
|
2086
|
-
"implementsTokenRanges": []
|
|
2087
|
-
},
|
|
2088
|
-
{
|
|
2089
|
-
"kind": "Interface",
|
|
2090
|
-
"canonicalReference": "@gcorevideo/player!InitEventData:interface",
|
|
2091
|
-
"docComment": "/**\n * Telemetry init event data\n *\n * @beta\n */\n",
|
|
2092
|
-
"excerptTokens": [
|
|
2093
|
-
{
|
|
2094
|
-
"kind": "Content",
|
|
2095
|
-
"text": "export interface InitEventData "
|
|
2096
|
-
}
|
|
2097
|
-
],
|
|
2098
|
-
"fileUrlPath": "src/plugins/telemetry/Telemetry.ts",
|
|
2099
|
-
"releaseTag": "Beta",
|
|
2100
|
-
"name": "InitEventData",
|
|
2101
|
-
"preserveMemberOrder": false,
|
|
2102
|
-
"members": [
|
|
2103
|
-
{
|
|
2104
|
-
"kind": "PropertySignature",
|
|
2105
|
-
"canonicalReference": "@gcorevideo/player!InitEventData#event:member",
|
|
2106
|
-
"docComment": "",
|
|
2107
|
-
"excerptTokens": [
|
|
2108
|
-
{
|
|
2109
|
-
"kind": "Content",
|
|
2110
|
-
"text": "event: "
|
|
2111
|
-
},
|
|
2112
|
-
{
|
|
2113
|
-
"kind": "Reference",
|
|
2114
|
-
"text": "TelemetryEvent.Init",
|
|
2115
|
-
"canonicalReference": "@gcorevideo/player!TelemetryEvent.Init:member"
|
|
2116
|
-
},
|
|
2117
|
-
{
|
|
2118
|
-
"kind": "Content",
|
|
2119
|
-
"text": ";"
|
|
2120
|
-
}
|
|
2121
|
-
],
|
|
2122
|
-
"isReadonly": false,
|
|
2123
|
-
"isOptional": false,
|
|
2124
|
-
"releaseTag": "Beta",
|
|
2125
|
-
"name": "event",
|
|
2126
|
-
"propertyTypeTokenRange": {
|
|
2127
|
-
"startIndex": 1,
|
|
2128
|
-
"endIndex": 2
|
|
2129
|
-
}
|
|
2130
|
-
}
|
|
2131
|
-
],
|
|
2132
|
-
"extendsTokenRanges": []
|
|
2133
|
-
},
|
|
2134
|
-
{
|
|
2135
|
-
"kind": "TypeAlias",
|
|
2136
|
-
"canonicalReference": "@gcorevideo/player!LangTag:type",
|
|
2137
|
-
"docComment": "/**\n * An ISO 639-1 language code.\n *\n * @example\n *\n * `pt`\n *\n * @public\n */\n",
|
|
2138
|
-
"excerptTokens": [
|
|
2139
|
-
{
|
|
2140
|
-
"kind": "Content",
|
|
2141
|
-
"text": "export type LangTag = "
|
|
2142
|
-
},
|
|
2143
|
-
{
|
|
2144
|
-
"kind": "Content",
|
|
2145
|
-
"text": "string"
|
|
2146
|
-
},
|
|
2147
|
-
{
|
|
2148
|
-
"kind": "Content",
|
|
2149
|
-
"text": ";"
|
|
2150
|
-
}
|
|
2151
|
-
],
|
|
2152
|
-
"fileUrlPath": "src/types.ts",
|
|
2153
|
-
"releaseTag": "Public",
|
|
2154
|
-
"name": "LangTag",
|
|
2155
|
-
"typeTokenRange": {
|
|
2156
|
-
"startIndex": 1,
|
|
2157
|
-
"endIndex": 2
|
|
2158
|
-
}
|
|
2159
|
-
},
|
|
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"
|
|
2045
|
+
"startIndex": 1,
|
|
2046
|
+
"endIndex": 2
|
|
2047
|
+
},
|
|
2048
|
+
"isOptional": false
|
|
2049
|
+
}
|
|
2050
|
+
],
|
|
2051
|
+
"isOptional": false,
|
|
2052
|
+
"isAbstract": false,
|
|
2053
|
+
"name": "push"
|
|
2173
2054
|
},
|
|
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
2055
|
{
|
|
2186
2056
|
"kind": "Property",
|
|
2187
|
-
"canonicalReference": "@gcorevideo/player!
|
|
2057
|
+
"canonicalReference": "@gcorevideo/player!GoogleAnalytics#supportedVersion:member",
|
|
2188
2058
|
"docComment": "",
|
|
2189
2059
|
"excerptTokens": [
|
|
2190
2060
|
{
|
|
2191
2061
|
"kind": "Content",
|
|
2192
|
-
"text": "get
|
|
2062
|
+
"text": "get supportedVersion(): "
|
|
2193
2063
|
},
|
|
2194
2064
|
{
|
|
2195
2065
|
"kind": "Content",
|
|
2196
|
-
"text": "{\n
|
|
2066
|
+
"text": "{\n min: string;\n }"
|
|
2197
2067
|
},
|
|
2198
2068
|
{
|
|
2199
2069
|
"kind": "Content",
|
|
@@ -2203,7 +2073,7 @@
|
|
|
2203
2073
|
"isReadonly": true,
|
|
2204
2074
|
"isOptional": false,
|
|
2205
2075
|
"releaseTag": "Beta",
|
|
2206
|
-
"name": "
|
|
2076
|
+
"name": "supportedVersion",
|
|
2207
2077
|
"propertyTypeTokenRange": {
|
|
2208
2078
|
"startIndex": 1,
|
|
2209
2079
|
"endIndex": 2
|
|
@@ -2221,63 +2091,32 @@
|
|
|
2221
2091
|
},
|
|
2222
2092
|
{
|
|
2223
2093
|
"kind": "Interface",
|
|
2224
|
-
"canonicalReference": "@gcorevideo/player!
|
|
2225
|
-
"docComment": "/**\n *
|
|
2094
|
+
"canonicalReference": "@gcorevideo/player!InitEventData:interface",
|
|
2095
|
+
"docComment": "/**\n * Telemetry init event data\n *\n * @beta\n */\n",
|
|
2226
2096
|
"excerptTokens": [
|
|
2227
2097
|
{
|
|
2228
2098
|
"kind": "Content",
|
|
2229
|
-
"text": "export interface
|
|
2099
|
+
"text": "export interface InitEventData "
|
|
2230
2100
|
}
|
|
2231
2101
|
],
|
|
2232
|
-
"fileUrlPath": "src/plugins/
|
|
2102
|
+
"fileUrlPath": "src/plugins/telemetry/Telemetry.ts",
|
|
2233
2103
|
"releaseTag": "Beta",
|
|
2234
|
-
"name": "
|
|
2104
|
+
"name": "InitEventData",
|
|
2235
2105
|
"preserveMemberOrder": false,
|
|
2236
2106
|
"members": [
|
|
2237
2107
|
{
|
|
2238
2108
|
"kind": "PropertySignature",
|
|
2239
|
-
"canonicalReference": "@gcorevideo/player!
|
|
2240
|
-
"docComment": "
|
|
2109
|
+
"canonicalReference": "@gcorevideo/player!InitEventData#event:member",
|
|
2110
|
+
"docComment": "",
|
|
2241
2111
|
"excerptTokens": [
|
|
2242
2112
|
{
|
|
2243
2113
|
"kind": "Content",
|
|
2244
|
-
"text": "
|
|
2114
|
+
"text": "event: "
|
|
2245
2115
|
},
|
|
2246
2116
|
{
|
|
2247
2117
|
"kind": "Reference",
|
|
2248
|
-
"text": "
|
|
2249
|
-
"canonicalReference": "!
|
|
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"
|
|
2118
|
+
"text": "TelemetryEvent.Init",
|
|
2119
|
+
"canonicalReference": "@gcorevideo/player!TelemetryEvent.Init:member"
|
|
2281
2120
|
},
|
|
2282
2121
|
{
|
|
2283
2122
|
"kind": "Content",
|
|
@@ -2285,9 +2124,9 @@
|
|
|
2285
2124
|
}
|
|
2286
2125
|
],
|
|
2287
2126
|
"isReadonly": false,
|
|
2288
|
-
"isOptional":
|
|
2127
|
+
"isOptional": false,
|
|
2289
2128
|
"releaseTag": "Beta",
|
|
2290
|
-
"name": "
|
|
2129
|
+
"name": "event",
|
|
2291
2130
|
"propertyTypeTokenRange": {
|
|
2292
2131
|
"startIndex": 1,
|
|
2293
2132
|
"endIndex": 2
|
|
@@ -2296,6 +2135,32 @@
|
|
|
2296
2135
|
],
|
|
2297
2136
|
"extendsTokenRanges": []
|
|
2298
2137
|
},
|
|
2138
|
+
{
|
|
2139
|
+
"kind": "TypeAlias",
|
|
2140
|
+
"canonicalReference": "@gcorevideo/player!LangTag:type",
|
|
2141
|
+
"docComment": "/**\n * An ISO 639-1 language code.\n *\n * @example\n *\n * `pt`\n *\n * @public\n */\n",
|
|
2142
|
+
"excerptTokens": [
|
|
2143
|
+
{
|
|
2144
|
+
"kind": "Content",
|
|
2145
|
+
"text": "export type LangTag = "
|
|
2146
|
+
},
|
|
2147
|
+
{
|
|
2148
|
+
"kind": "Content",
|
|
2149
|
+
"text": "string"
|
|
2150
|
+
},
|
|
2151
|
+
{
|
|
2152
|
+
"kind": "Content",
|
|
2153
|
+
"text": ";"
|
|
2154
|
+
}
|
|
2155
|
+
],
|
|
2156
|
+
"fileUrlPath": "src/types.ts",
|
|
2157
|
+
"releaseTag": "Public",
|
|
2158
|
+
"name": "LangTag",
|
|
2159
|
+
"typeTokenRange": {
|
|
2160
|
+
"startIndex": 1,
|
|
2161
|
+
"endIndex": 2
|
|
2162
|
+
}
|
|
2163
|
+
},
|
|
2299
2164
|
{
|
|
2300
2165
|
"kind": "Class",
|
|
2301
2166
|
"canonicalReference": "@gcorevideo/player!Logo:class",
|
|
@@ -2577,7 +2442,7 @@
|
|
|
2577
2442
|
{
|
|
2578
2443
|
"kind": "Class",
|
|
2579
2444
|
"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",
|
|
2445
|
+
"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
2446
|
"excerptTokens": [
|
|
2582
2447
|
{
|
|
2583
2448
|
"kind": "Content",
|
|
@@ -2788,12 +2653,12 @@
|
|
|
2788
2653
|
},
|
|
2789
2654
|
{
|
|
2790
2655
|
"kind": "Method",
|
|
2791
|
-
"canonicalReference": "@gcorevideo/player!MediaControl#
|
|
2792
|
-
"docComment": "/**\n * Get a media control element DOM node\n *\n * @remarks\n *\n * Use this method to render custom media control UI in a plugin\n *\n * @deprecated\n *\n * Use {@link MediaControl.putElement} instead\n *\n * @param name - The name of the media control element\n *\n * @returns The DOM node to render to or extend\n *\n * @example\n * ```ts\n * class MyPlugin extends UICorePlugin {\n * override render() {\n *
|
|
2656
|
+
"canonicalReference": "@gcorevideo/player!MediaControl#mount:member(1)",
|
|
2657
|
+
"docComment": "/**\n * Get a media control element DOM node\n *\n * @remarks\n *\n * Use this method to render custom media control UI in a plugin\n *\n * @deprecated\n *\n * Use {@link MediaControl.putElement} instead\n *\n * @param name - The name of the media control element\n *\n * @returns The DOM node to render to or extend\n *\n * @example\n * ```ts\n * class MyPlugin extends UICorePlugin {\n * override render() {\n * this.$el.html('<div data-clips>Here we go</div>')\n * this.core.getPlugin('media_control').mount('clips', this.$el)\n * return this\n * }\n * }\n * ```\n *\n */\n",
|
|
2793
2658
|
"excerptTokens": [
|
|
2794
2659
|
{
|
|
2795
2660
|
"kind": "Content",
|
|
2796
|
-
"text": "
|
|
2661
|
+
"text": "mount(name: "
|
|
2797
2662
|
},
|
|
2798
2663
|
{
|
|
2799
2664
|
"kind": "Reference",
|
|
@@ -2802,66 +2667,13 @@
|
|
|
2802
2667
|
},
|
|
2803
2668
|
{
|
|
2804
2669
|
"kind": "Content",
|
|
2805
|
-
"text": "
|
|
2670
|
+
"text": ", element: "
|
|
2806
2671
|
},
|
|
2807
2672
|
{
|
|
2808
2673
|
"kind": "Reference",
|
|
2809
2674
|
"text": "ZeptoResult",
|
|
2810
2675
|
"canonicalReference": "@gcorevideo/player!ZeptoResult:type"
|
|
2811
2676
|
},
|
|
2812
|
-
{
|
|
2813
|
-
"kind": "Content",
|
|
2814
|
-
"text": " | null"
|
|
2815
|
-
},
|
|
2816
|
-
{
|
|
2817
|
-
"kind": "Content",
|
|
2818
|
-
"text": ";"
|
|
2819
|
-
}
|
|
2820
|
-
],
|
|
2821
|
-
"isStatic": false,
|
|
2822
|
-
"returnTypeTokenRange": {
|
|
2823
|
-
"startIndex": 3,
|
|
2824
|
-
"endIndex": 5
|
|
2825
|
-
},
|
|
2826
|
-
"releaseTag": "Beta",
|
|
2827
|
-
"isProtected": false,
|
|
2828
|
-
"overloadIndex": 1,
|
|
2829
|
-
"parameters": [
|
|
2830
|
-
{
|
|
2831
|
-
"parameterName": "name",
|
|
2832
|
-
"parameterTypeTokenRange": {
|
|
2833
|
-
"startIndex": 1,
|
|
2834
|
-
"endIndex": 2
|
|
2835
|
-
},
|
|
2836
|
-
"isOptional": false
|
|
2837
|
-
}
|
|
2838
|
-
],
|
|
2839
|
-
"isOptional": false,
|
|
2840
|
-
"isAbstract": false,
|
|
2841
|
-
"name": "getElement"
|
|
2842
|
-
},
|
|
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
2677
|
{
|
|
2866
2678
|
"kind": "Content",
|
|
2867
2679
|
"text": "): "
|
|
@@ -2885,9 +2697,17 @@
|
|
|
2885
2697
|
"overloadIndex": 1,
|
|
2886
2698
|
"parameters": [
|
|
2887
2699
|
{
|
|
2888
|
-
"parameterName": "
|
|
2700
|
+
"parameterName": "name",
|
|
2889
2701
|
"parameterTypeTokenRange": {
|
|
2890
2702
|
"startIndex": 1,
|
|
2703
|
+
"endIndex": 2
|
|
2704
|
+
},
|
|
2705
|
+
"isOptional": false
|
|
2706
|
+
},
|
|
2707
|
+
{
|
|
2708
|
+
"parameterName": "element",
|
|
2709
|
+
"parameterTypeTokenRange": {
|
|
2710
|
+
"startIndex": 3,
|
|
2891
2711
|
"endIndex": 4
|
|
2892
2712
|
},
|
|
2893
2713
|
"isOptional": false
|
|
@@ -2895,7 +2715,7 @@
|
|
|
2895
2715
|
],
|
|
2896
2716
|
"isOptional": false,
|
|
2897
2717
|
"isAbstract": false,
|
|
2898
|
-
"name": "
|
|
2718
|
+
"name": "mount"
|
|
2899
2719
|
},
|
|
2900
2720
|
{
|
|
2901
2721
|
"kind": "Property",
|
|
@@ -3184,24 +3004,174 @@
|
|
|
3184
3004
|
"isAbstract": false
|
|
3185
3005
|
}
|
|
3186
3006
|
],
|
|
3187
|
-
"extendsTokenRange": {
|
|
3007
|
+
"extendsTokenRange": {
|
|
3008
|
+
"startIndex": 1,
|
|
3009
|
+
"endIndex": 2
|
|
3010
|
+
},
|
|
3011
|
+
"implementsTokenRanges": []
|
|
3012
|
+
},
|
|
3013
|
+
{
|
|
3014
|
+
"kind": "TypeAlias",
|
|
3015
|
+
"canonicalReference": "@gcorevideo/player!MediaControlElement:type",
|
|
3016
|
+
"docComment": "/**\n * Built-in media control elements.\n *\n * @beta\n */\n",
|
|
3017
|
+
"excerptTokens": [
|
|
3018
|
+
{
|
|
3019
|
+
"kind": "Content",
|
|
3020
|
+
"text": "export type MediaControlElement = "
|
|
3021
|
+
},
|
|
3022
|
+
{
|
|
3023
|
+
"kind": "Reference",
|
|
3024
|
+
"text": "MediaControlLeftElement",
|
|
3025
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
|
|
3026
|
+
},
|
|
3027
|
+
{
|
|
3028
|
+
"kind": "Content",
|
|
3029
|
+
"text": " | "
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
"kind": "Reference",
|
|
3033
|
+
"text": "MediaControlLayerElement",
|
|
3034
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
|
|
3035
|
+
},
|
|
3036
|
+
{
|
|
3037
|
+
"kind": "Content",
|
|
3038
|
+
"text": " | "
|
|
3039
|
+
},
|
|
3040
|
+
{
|
|
3041
|
+
"kind": "Reference",
|
|
3042
|
+
"text": "MediaControlRightElement",
|
|
3043
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
|
|
3044
|
+
},
|
|
3045
|
+
{
|
|
3046
|
+
"kind": "Content",
|
|
3047
|
+
"text": ";"
|
|
3048
|
+
}
|
|
3049
|
+
],
|
|
3050
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3051
|
+
"releaseTag": "Beta",
|
|
3052
|
+
"name": "MediaControlElement",
|
|
3053
|
+
"typeTokenRange": {
|
|
3054
|
+
"startIndex": 1,
|
|
3055
|
+
"endIndex": 6
|
|
3056
|
+
}
|
|
3057
|
+
},
|
|
3058
|
+
{
|
|
3059
|
+
"kind": "TypeAlias",
|
|
3060
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type",
|
|
3061
|
+
"docComment": "/**\n * Media control elements that appear in main layer, spanning the entire width of the player.\n *\n * @beta\n */\n",
|
|
3062
|
+
"excerptTokens": [
|
|
3063
|
+
{
|
|
3064
|
+
"kind": "Content",
|
|
3065
|
+
"text": "export type MediaControlLayerElement = "
|
|
3066
|
+
},
|
|
3067
|
+
{
|
|
3068
|
+
"kind": "Content",
|
|
3069
|
+
"text": "'seekbar' | 'seekBarContainer'"
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"kind": "Content",
|
|
3073
|
+
"text": ";"
|
|
3074
|
+
}
|
|
3075
|
+
],
|
|
3076
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3077
|
+
"releaseTag": "Beta",
|
|
3078
|
+
"name": "MediaControlLayerElement",
|
|
3079
|
+
"typeTokenRange": {
|
|
3080
|
+
"startIndex": 1,
|
|
3081
|
+
"endIndex": 2
|
|
3082
|
+
}
|
|
3083
|
+
},
|
|
3084
|
+
{
|
|
3085
|
+
"kind": "TypeAlias",
|
|
3086
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type",
|
|
3087
|
+
"docComment": "/**\n * Media control elements that appear in the left area.\n *\n * @beta\n */\n",
|
|
3088
|
+
"excerptTokens": [
|
|
3089
|
+
{
|
|
3090
|
+
"kind": "Content",
|
|
3091
|
+
"text": "export type MediaControlLeftElement = "
|
|
3092
|
+
},
|
|
3093
|
+
{
|
|
3094
|
+
"kind": "Content",
|
|
3095
|
+
"text": "'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips'"
|
|
3096
|
+
},
|
|
3097
|
+
{
|
|
3098
|
+
"kind": "Content",
|
|
3099
|
+
"text": ";"
|
|
3100
|
+
}
|
|
3101
|
+
],
|
|
3102
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3103
|
+
"releaseTag": "Beta",
|
|
3104
|
+
"name": "MediaControlLeftElement",
|
|
3105
|
+
"typeTokenRange": {
|
|
3106
|
+
"startIndex": 1,
|
|
3107
|
+
"endIndex": 2
|
|
3108
|
+
}
|
|
3109
|
+
},
|
|
3110
|
+
{
|
|
3111
|
+
"kind": "TypeAlias",
|
|
3112
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type",
|
|
3113
|
+
"docComment": "/**\n * Media control elements that appear in the right area.\n *\n * @beta\n */\n",
|
|
3114
|
+
"excerptTokens": [
|
|
3115
|
+
{
|
|
3116
|
+
"kind": "Content",
|
|
3117
|
+
"text": "export type MediaControlRightElement = "
|
|
3118
|
+
},
|
|
3119
|
+
{
|
|
3120
|
+
"kind": "Content",
|
|
3121
|
+
"text": "'audiotracks' | 'cc' | 'fullscreen' | 'hd-indicator' | 'gear' | 'multicamera' | 'pip' | 'vr'"
|
|
3122
|
+
},
|
|
3123
|
+
{
|
|
3124
|
+
"kind": "Content",
|
|
3125
|
+
"text": ";"
|
|
3126
|
+
}
|
|
3127
|
+
],
|
|
3128
|
+
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3129
|
+
"releaseTag": "Beta",
|
|
3130
|
+
"name": "MediaControlRightElement",
|
|
3131
|
+
"typeTokenRange": {
|
|
3188
3132
|
"startIndex": 1,
|
|
3189
3133
|
"endIndex": 2
|
|
3190
|
-
}
|
|
3191
|
-
"implementsTokenRanges": []
|
|
3134
|
+
}
|
|
3192
3135
|
},
|
|
3193
3136
|
{
|
|
3194
3137
|
"kind": "TypeAlias",
|
|
3195
|
-
"canonicalReference": "@gcorevideo/player!
|
|
3196
|
-
"docComment": "/**\n *
|
|
3138
|
+
"canonicalReference": "@gcorevideo/player!MediaControlSettings:type",
|
|
3139
|
+
"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",
|
|
3197
3140
|
"excerptTokens": [
|
|
3198
3141
|
{
|
|
3199
3142
|
"kind": "Content",
|
|
3200
|
-
"text": "export type
|
|
3143
|
+
"text": "export type MediaControlSettings = "
|
|
3144
|
+
},
|
|
3145
|
+
{
|
|
3146
|
+
"kind": "Content",
|
|
3147
|
+
"text": "{\n left: "
|
|
3148
|
+
},
|
|
3149
|
+
{
|
|
3150
|
+
"kind": "Reference",
|
|
3151
|
+
"text": "MediaControlLeftElement",
|
|
3152
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
|
|
3201
3153
|
},
|
|
3202
3154
|
{
|
|
3203
3155
|
"kind": "Content",
|
|
3204
|
-
"text": "
|
|
3156
|
+
"text": "[];\n right: "
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
"kind": "Reference",
|
|
3160
|
+
"text": "MediaControlRightElement",
|
|
3161
|
+
"canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
|
|
3162
|
+
},
|
|
3163
|
+
{
|
|
3164
|
+
"kind": "Content",
|
|
3165
|
+
"text": "[];\n default: "
|
|
3166
|
+
},
|
|
3167
|
+
{
|
|
3168
|
+
"kind": "Reference",
|
|
3169
|
+
"text": "MediaControlLayerElement",
|
|
3170
|
+
"canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
|
|
3171
|
+
},
|
|
3172
|
+
{
|
|
3173
|
+
"kind": "Content",
|
|
3174
|
+
"text": "[];\n seekEnabled: boolean;\n}"
|
|
3205
3175
|
},
|
|
3206
3176
|
{
|
|
3207
3177
|
"kind": "Content",
|
|
@@ -3210,7 +3180,33 @@
|
|
|
3210
3180
|
],
|
|
3211
3181
|
"fileUrlPath": "src/plugins/media-control/MediaControl.ts",
|
|
3212
3182
|
"releaseTag": "Beta",
|
|
3213
|
-
"name": "
|
|
3183
|
+
"name": "MediaControlSettings",
|
|
3184
|
+
"typeTokenRange": {
|
|
3185
|
+
"startIndex": 1,
|
|
3186
|
+
"endIndex": 8
|
|
3187
|
+
}
|
|
3188
|
+
},
|
|
3189
|
+
{
|
|
3190
|
+
"kind": "TypeAlias",
|
|
3191
|
+
"canonicalReference": "@gcorevideo/player!MenuOption:type",
|
|
3192
|
+
"docComment": "/**\n * @beta\n */\n",
|
|
3193
|
+
"excerptTokens": [
|
|
3194
|
+
{
|
|
3195
|
+
"kind": "Content",
|
|
3196
|
+
"text": "export type MenuOption = "
|
|
3197
|
+
},
|
|
3198
|
+
{
|
|
3199
|
+
"kind": "Content",
|
|
3200
|
+
"text": "{\n label?: string;\n labelKey?: string;\n name: string;\n handler?: () => void;\n icon?: string;\n}"
|
|
3201
|
+
},
|
|
3202
|
+
{
|
|
3203
|
+
"kind": "Content",
|
|
3204
|
+
"text": ";"
|
|
3205
|
+
}
|
|
3206
|
+
],
|
|
3207
|
+
"fileUrlPath": "src/plugins/context-menu/ContextMenu.ts",
|
|
3208
|
+
"releaseTag": "Beta",
|
|
3209
|
+
"name": "MenuOption",
|
|
3214
3210
|
"typeTokenRange": {
|
|
3215
3211
|
"startIndex": 1,
|
|
3216
3212
|
"endIndex": 2
|
|
@@ -3618,6 +3614,71 @@
|
|
|
3618
3614
|
},
|
|
3619
3615
|
"implementsTokenRanges": []
|
|
3620
3616
|
},
|
|
3617
|
+
{
|
|
3618
|
+
"kind": "Class",
|
|
3619
|
+
"canonicalReference": "@gcorevideo/player!NerdStats:class",
|
|
3620
|
+
"docComment": "/**\n * `PLUGIN` that displays useful network-related statistics.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link BottomGear}\n *\n * - {@link ClapprStats}\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
|
|
3621
|
+
"excerptTokens": [
|
|
3622
|
+
{
|
|
3623
|
+
"kind": "Content",
|
|
3624
|
+
"text": "export declare class NerdStats extends "
|
|
3625
|
+
},
|
|
3626
|
+
{
|
|
3627
|
+
"kind": "Reference",
|
|
3628
|
+
"text": "UICorePlugin",
|
|
3629
|
+
"canonicalReference": "@gcorevideo/player!~UICorePlugin"
|
|
3630
|
+
},
|
|
3631
|
+
{
|
|
3632
|
+
"kind": "Content",
|
|
3633
|
+
"text": " "
|
|
3634
|
+
}
|
|
3635
|
+
],
|
|
3636
|
+
"fileUrlPath": "src/plugins/clappr-nerd-stats/NerdStats.ts",
|
|
3637
|
+
"releaseTag": "Beta",
|
|
3638
|
+
"isAbstract": false,
|
|
3639
|
+
"name": "NerdStats",
|
|
3640
|
+
"preserveMemberOrder": false,
|
|
3641
|
+
"members": [
|
|
3642
|
+
{
|
|
3643
|
+
"kind": "Constructor",
|
|
3644
|
+
"canonicalReference": "@gcorevideo/player!NerdStats:constructor(1)",
|
|
3645
|
+
"docComment": "/**\n * Constructs a new instance of the `NerdStats` class\n */\n",
|
|
3646
|
+
"excerptTokens": [
|
|
3647
|
+
{
|
|
3648
|
+
"kind": "Content",
|
|
3649
|
+
"text": "constructor(core: "
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
"kind": "Reference",
|
|
3653
|
+
"text": "Core",
|
|
3654
|
+
"canonicalReference": "@clappr/core!default:class"
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
"kind": "Content",
|
|
3658
|
+
"text": ");"
|
|
3659
|
+
}
|
|
3660
|
+
],
|
|
3661
|
+
"releaseTag": "Beta",
|
|
3662
|
+
"isProtected": false,
|
|
3663
|
+
"overloadIndex": 1,
|
|
3664
|
+
"parameters": [
|
|
3665
|
+
{
|
|
3666
|
+
"parameterName": "core",
|
|
3667
|
+
"parameterTypeTokenRange": {
|
|
3668
|
+
"startIndex": 1,
|
|
3669
|
+
"endIndex": 2
|
|
3670
|
+
},
|
|
3671
|
+
"isOptional": false
|
|
3672
|
+
}
|
|
3673
|
+
]
|
|
3674
|
+
}
|
|
3675
|
+
],
|
|
3676
|
+
"extendsTokenRange": {
|
|
3677
|
+
"startIndex": 1,
|
|
3678
|
+
"endIndex": 2
|
|
3679
|
+
},
|
|
3680
|
+
"implementsTokenRanges": []
|
|
3681
|
+
},
|
|
3621
3682
|
{
|
|
3622
3683
|
"kind": "Class",
|
|
3623
3684
|
"canonicalReference": "@gcorevideo/player!PictureInPicture:class",
|
|
@@ -3999,7 +4060,7 @@
|
|
|
3999
4060
|
{
|
|
4000
4061
|
"kind": "Class",
|
|
4001
4062
|
"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 * }
|
|
4063
|
+
"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
4064
|
"excerptTokens": [
|
|
4004
4065
|
{
|
|
4005
4066
|
"kind": "Content",
|
|
@@ -5359,7 +5420,7 @@
|
|
|
5359
5420
|
{
|
|
5360
5421
|
"kind": "PropertySignature",
|
|
5361
5422
|
"canonicalReference": "@gcorevideo/player!PlayerConfig#playbackType:member",
|
|
5362
|
-
"docComment": "/**\n *
|
|
5423
|
+
"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
5424
|
"excerptTokens": [
|
|
5364
5425
|
{
|
|
5365
5426
|
"kind": "Content",
|
|
@@ -6224,7 +6285,7 @@
|
|
|
6224
6285
|
{
|
|
6225
6286
|
"kind": "Interface",
|
|
6226
6287
|
"canonicalReference": "@gcorevideo/player!QualityLevel:interface",
|
|
6227
|
-
"docComment": "/**\n * A level of quality within a media source.\n *\n * @public\n */\n",
|
|
6288
|
+
"docComment": "/**\n * A level of quality within a media source/representation.\n *\n * @public\n */\n",
|
|
6228
6289
|
"excerptTokens": [
|
|
6229
6290
|
{
|
|
6230
6291
|
"kind": "Content",
|
|
@@ -6266,7 +6327,7 @@
|
|
|
6266
6327
|
{
|
|
6267
6328
|
"kind": "PropertySignature",
|
|
6268
6329
|
"canonicalReference": "@gcorevideo/player!QualityLevel#height:member",
|
|
6269
|
-
"docComment": "/**\n * Height of the video, pixels.\n */\n",
|
|
6330
|
+
"docComment": "/**\n * Height of the video frame, pixels.\n */\n",
|
|
6270
6331
|
"excerptTokens": [
|
|
6271
6332
|
{
|
|
6272
6333
|
"kind": "Content",
|
|
@@ -6293,7 +6354,7 @@
|
|
|
6293
6354
|
{
|
|
6294
6355
|
"kind": "PropertySignature",
|
|
6295
6356
|
"canonicalReference": "@gcorevideo/player!QualityLevel#level:member",
|
|
6296
|
-
"docComment": "/**\n * Zero-based index of the quality level
|
|
6357
|
+
"docComment": "/**\n * Zero-based index of the quality level. Quality levels go from low to high\n */\n",
|
|
6297
6358
|
"excerptTokens": [
|
|
6298
6359
|
{
|
|
6299
6360
|
"kind": "Content",
|
|
@@ -6320,7 +6381,7 @@
|
|
|
6320
6381
|
{
|
|
6321
6382
|
"kind": "PropertySignature",
|
|
6322
6383
|
"canonicalReference": "@gcorevideo/player!QualityLevel#width:member",
|
|
6323
|
-
"docComment": "/**\n * Width of the video, pixels.\n */\n",
|
|
6384
|
+
"docComment": "/**\n * Width of the video frame, pixels.\n */\n",
|
|
6324
6385
|
"excerptTokens": [
|
|
6325
6386
|
{
|
|
6326
6387
|
"kind": "Content",
|
|
@@ -6347,6 +6408,145 @@
|
|
|
6347
6408
|
],
|
|
6348
6409
|
"extendsTokenRanges": []
|
|
6349
6410
|
},
|
|
6411
|
+
{
|
|
6412
|
+
"kind": "Class",
|
|
6413
|
+
"canonicalReference": "@gcorevideo/player!QualityLevels:class",
|
|
6414
|
+
"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",
|
|
6415
|
+
"excerptTokens": [
|
|
6416
|
+
{
|
|
6417
|
+
"kind": "Content",
|
|
6418
|
+
"text": "export declare class QualityLevels extends "
|
|
6419
|
+
},
|
|
6420
|
+
{
|
|
6421
|
+
"kind": "Reference",
|
|
6422
|
+
"text": "UICorePlugin",
|
|
6423
|
+
"canonicalReference": "@gcorevideo/player!~UICorePlugin"
|
|
6424
|
+
},
|
|
6425
|
+
{
|
|
6426
|
+
"kind": "Content",
|
|
6427
|
+
"text": " "
|
|
6428
|
+
}
|
|
6429
|
+
],
|
|
6430
|
+
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
6431
|
+
"releaseTag": "Beta",
|
|
6432
|
+
"isAbstract": false,
|
|
6433
|
+
"name": "QualityLevels",
|
|
6434
|
+
"preserveMemberOrder": false,
|
|
6435
|
+
"members": [
|
|
6436
|
+
{
|
|
6437
|
+
"kind": "Property",
|
|
6438
|
+
"canonicalReference": "@gcorevideo/player!QualityLevels#events:member",
|
|
6439
|
+
"docComment": "",
|
|
6440
|
+
"excerptTokens": [
|
|
6441
|
+
{
|
|
6442
|
+
"kind": "Content",
|
|
6443
|
+
"text": "get events(): "
|
|
6444
|
+
},
|
|
6445
|
+
{
|
|
6446
|
+
"kind": "Content",
|
|
6447
|
+
"text": "{\n 'click .gear-sub-menu_btn': string;\n 'click .go-back': string;\n }"
|
|
6448
|
+
},
|
|
6449
|
+
{
|
|
6450
|
+
"kind": "Content",
|
|
6451
|
+
"text": ";"
|
|
6452
|
+
}
|
|
6453
|
+
],
|
|
6454
|
+
"isReadonly": true,
|
|
6455
|
+
"isOptional": false,
|
|
6456
|
+
"releaseTag": "Beta",
|
|
6457
|
+
"name": "events",
|
|
6458
|
+
"propertyTypeTokenRange": {
|
|
6459
|
+
"startIndex": 1,
|
|
6460
|
+
"endIndex": 2
|
|
6461
|
+
},
|
|
6462
|
+
"isStatic": false,
|
|
6463
|
+
"isProtected": false,
|
|
6464
|
+
"isAbstract": false
|
|
6465
|
+
}
|
|
6466
|
+
],
|
|
6467
|
+
"extendsTokenRange": {
|
|
6468
|
+
"startIndex": 1,
|
|
6469
|
+
"endIndex": 2
|
|
6470
|
+
},
|
|
6471
|
+
"implementsTokenRanges": []
|
|
6472
|
+
},
|
|
6473
|
+
{
|
|
6474
|
+
"kind": "Interface",
|
|
6475
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings:interface",
|
|
6476
|
+
"docComment": "/**\n * Configuration options for the {@link QualityLevels} plugin.\n *\n * @beta\n */\n",
|
|
6477
|
+
"excerptTokens": [
|
|
6478
|
+
{
|
|
6479
|
+
"kind": "Content",
|
|
6480
|
+
"text": "export interface QualityLevelsPluginSettings "
|
|
6481
|
+
}
|
|
6482
|
+
],
|
|
6483
|
+
"fileUrlPath": "src/plugins/level-selector/QualityLevels.ts",
|
|
6484
|
+
"releaseTag": "Beta",
|
|
6485
|
+
"name": "QualityLevelsPluginSettings",
|
|
6486
|
+
"preserveMemberOrder": false,
|
|
6487
|
+
"members": [
|
|
6488
|
+
{
|
|
6489
|
+
"kind": "PropertySignature",
|
|
6490
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings#labels:member",
|
|
6491
|
+
"docComment": "/**\n * The labels to show in the level selector.\n *\n * @example\n * ```ts\n * { 360: 'SD', 720: 'HD' }\n * ```\n *\n */\n",
|
|
6492
|
+
"excerptTokens": [
|
|
6493
|
+
{
|
|
6494
|
+
"kind": "Content",
|
|
6495
|
+
"text": "labels?: "
|
|
6496
|
+
},
|
|
6497
|
+
{
|
|
6498
|
+
"kind": "Reference",
|
|
6499
|
+
"text": "Record",
|
|
6500
|
+
"canonicalReference": "!Record:type"
|
|
6501
|
+
},
|
|
6502
|
+
{
|
|
6503
|
+
"kind": "Content",
|
|
6504
|
+
"text": "<number, string>"
|
|
6505
|
+
},
|
|
6506
|
+
{
|
|
6507
|
+
"kind": "Content",
|
|
6508
|
+
"text": ";"
|
|
6509
|
+
}
|
|
6510
|
+
],
|
|
6511
|
+
"isReadonly": false,
|
|
6512
|
+
"isOptional": true,
|
|
6513
|
+
"releaseTag": "Beta",
|
|
6514
|
+
"name": "labels",
|
|
6515
|
+
"propertyTypeTokenRange": {
|
|
6516
|
+
"startIndex": 1,
|
|
6517
|
+
"endIndex": 3
|
|
6518
|
+
}
|
|
6519
|
+
},
|
|
6520
|
+
{
|
|
6521
|
+
"kind": "PropertySignature",
|
|
6522
|
+
"canonicalReference": "@gcorevideo/player!QualityLevelsPluginSettings#restrictResolution:member",
|
|
6523
|
+
"docComment": "/**\n * The maximum resolution to allow in the level selector.\n */\n",
|
|
6524
|
+
"excerptTokens": [
|
|
6525
|
+
{
|
|
6526
|
+
"kind": "Content",
|
|
6527
|
+
"text": "restrictResolution?: "
|
|
6528
|
+
},
|
|
6529
|
+
{
|
|
6530
|
+
"kind": "Content",
|
|
6531
|
+
"text": "number"
|
|
6532
|
+
},
|
|
6533
|
+
{
|
|
6534
|
+
"kind": "Content",
|
|
6535
|
+
"text": ";"
|
|
6536
|
+
}
|
|
6537
|
+
],
|
|
6538
|
+
"isReadonly": false,
|
|
6539
|
+
"isOptional": true,
|
|
6540
|
+
"releaseTag": "Beta",
|
|
6541
|
+
"name": "restrictResolution",
|
|
6542
|
+
"propertyTypeTokenRange": {
|
|
6543
|
+
"startIndex": 1,
|
|
6544
|
+
"endIndex": 2
|
|
6545
|
+
}
|
|
6546
|
+
}
|
|
6547
|
+
],
|
|
6548
|
+
"extendsTokenRanges": []
|
|
6549
|
+
},
|
|
6350
6550
|
{
|
|
6351
6551
|
"kind": "Class",
|
|
6352
6552
|
"canonicalReference": "@gcorevideo/player!SeekTime:class",
|
|
@@ -8684,7 +8884,7 @@
|
|
|
8684
8884
|
{
|
|
8685
8885
|
"kind": "PropertySignature",
|
|
8686
8886
|
"canonicalReference": "@gcorevideo/player!TimePosition#current:member",
|
|
8687
|
-
"docComment": "/**\n * Current playback time, 0..duration
|
|
8887
|
+
"docComment": "/**\n * Current playback time, 0..duration\n */\n",
|
|
8688
8888
|
"excerptTokens": [
|
|
8689
8889
|
{
|
|
8690
8890
|
"kind": "Content",
|
|
@@ -8712,7 +8912,7 @@
|
|
|
8712
8912
|
{
|
|
8713
8913
|
"kind": "PropertySignature",
|
|
8714
8914
|
"canonicalReference": "@gcorevideo/player!TimePosition#total:member",
|
|
8715
|
-
"docComment": "/**\n * Total duration of the media
|
|
8915
|
+
"docComment": "/**\n * Total duration of the media content (or DVR window size or segment duration for live streams)\n */\n",
|
|
8716
8916
|
"excerptTokens": [
|
|
8717
8917
|
{
|
|
8718
8918
|
"kind": "Content",
|
|
@@ -8743,20 +8943,42 @@
|
|
|
8743
8943
|
{
|
|
8744
8944
|
"kind": "TypeAlias",
|
|
8745
8945
|
"canonicalReference": "@gcorevideo/player!TimeProgress:type",
|
|
8746
|
-
"docComment": "/**\n *
|
|
8946
|
+
"docComment": "/**\n * Time progress information indicated by Clappr CONTAINER_PROGRESS and PLAYBACK_PROGRESS events.\n *\n * @beta\n */\n",
|
|
8747
8947
|
"excerptTokens": [
|
|
8748
8948
|
{
|
|
8749
8949
|
"kind": "Content",
|
|
8750
8950
|
"text": "export type TimeProgress = "
|
|
8751
8951
|
},
|
|
8952
|
+
{
|
|
8953
|
+
"kind": "Content",
|
|
8954
|
+
"text": "{\n start: "
|
|
8955
|
+
},
|
|
8752
8956
|
{
|
|
8753
8957
|
"kind": "Reference",
|
|
8754
|
-
"text": "
|
|
8755
|
-
"canonicalReference": "@gcorevideo/player!
|
|
8958
|
+
"text": "TimeValue",
|
|
8959
|
+
"canonicalReference": "@gcorevideo/player!TimeValue:type"
|
|
8960
|
+
},
|
|
8961
|
+
{
|
|
8962
|
+
"kind": "Content",
|
|
8963
|
+
"text": ";\n current: "
|
|
8964
|
+
},
|
|
8965
|
+
{
|
|
8966
|
+
"kind": "Reference",
|
|
8967
|
+
"text": "TimeValue",
|
|
8968
|
+
"canonicalReference": "@gcorevideo/player!TimeValue:type"
|
|
8756
8969
|
},
|
|
8757
8970
|
{
|
|
8758
8971
|
"kind": "Content",
|
|
8759
|
-
"text": "
|
|
8972
|
+
"text": ";\n total: "
|
|
8973
|
+
},
|
|
8974
|
+
{
|
|
8975
|
+
"kind": "Reference",
|
|
8976
|
+
"text": "TimeValue",
|
|
8977
|
+
"canonicalReference": "@gcorevideo/player!TimeValue:type"
|
|
8978
|
+
},
|
|
8979
|
+
{
|
|
8980
|
+
"kind": "Content",
|
|
8981
|
+
"text": ";\n}"
|
|
8760
8982
|
},
|
|
8761
8983
|
{
|
|
8762
8984
|
"kind": "Content",
|
|
@@ -8768,7 +8990,7 @@
|
|
|
8768
8990
|
"name": "TimeProgress",
|
|
8769
8991
|
"typeTokenRange": {
|
|
8770
8992
|
"startIndex": 1,
|
|
8771
|
-
"endIndex":
|
|
8993
|
+
"endIndex": 8
|
|
8772
8994
|
}
|
|
8773
8995
|
},
|
|
8774
8996
|
{
|
|
@@ -8805,7 +9027,7 @@
|
|
|
8805
9027
|
{
|
|
8806
9028
|
"kind": "TypeAlias",
|
|
8807
9029
|
"canonicalReference": "@gcorevideo/player!TimeValue:type",
|
|
8808
|
-
"docComment": "/**\n * Playback time in seconds since the beginning of the stream
|
|
9030
|
+
"docComment": "/**\n * Playback time position in seconds since the beginning of the stream. For the live streams this is limited to the length of a segment. When DVR is enabled, this refers to the\n *\n * @public\n */\n",
|
|
8809
9031
|
"excerptTokens": [
|
|
8810
9032
|
{
|
|
8811
9033
|
"kind": "Content",
|