@gcorevideo/player 2.22.18 → 2.22.21

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.
Files changed (94) hide show
  1. package/assets/audio-selector/track-selector.ejs +3 -3
  2. package/assets/bottom-gear/bottomgear.ejs +3 -3
  3. package/assets/dvr-controls/dvr_controls.scss +0 -12
  4. package/assets/level-selector/button.ejs +1 -1
  5. package/dist/core.js +1 -1
  6. package/dist/index.css +664 -671
  7. package/dist/index.js +285 -260
  8. package/dist/player.d.ts +144 -123
  9. package/dist/plugins/index.css +758 -765
  10. package/dist/plugins/index.js +194 -172
  11. package/docs/api/player.clapprstats.exportmetrics.md +2 -2
  12. package/docs/api/player.clapprstats.md +0 -4
  13. package/docs/api/player.clapprstatsbitratetrack.md +20 -0
  14. package/docs/api/player.clapprstatschronograph.md +115 -0
  15. package/docs/api/player.clapprstatscounter.md +211 -0
  16. package/docs/api/player.clapprstatsevents.md +51 -0
  17. package/docs/api/player.clapprstatsmetrics.md +52 -0
  18. package/docs/api/player.clipspluginsettings.md +1 -1
  19. package/docs/api/player.gearevents.md +1 -1
  20. package/docs/api/player.md +57 -2
  21. package/docs/api/player.mediacontrol.mount.md +0 -5
  22. package/docs/api/player.mediacontrol.putelement.md +5 -0
  23. package/docs/api/player.mediacontrol.toggleelement.md +1 -1
  24. package/docs/api/player.nerdstats.md +3 -3
  25. package/docs/api/player.playerconfig.md +1 -1
  26. package/docs/api/player.playerconfig.playbacktype.md +6 -1
  27. package/docs/api/player.timeupdate.md +6 -3
  28. package/lib/plugins/audio-selector/AudioSelector.d.ts +1 -1
  29. package/lib/plugins/audio-selector/AudioSelector.d.ts.map +1 -1
  30. package/lib/plugins/audio-selector/AudioSelector.js +15 -8
  31. package/lib/plugins/bottom-gear/BottomGear.d.ts +1 -1
  32. package/lib/plugins/bottom-gear/BottomGear.js +2 -2
  33. package/lib/plugins/clappr-nerd-stats/NerdStats.d.ts +4 -4
  34. package/lib/plugins/clappr-nerd-stats/NerdStats.js +4 -4
  35. package/lib/plugins/clappr-stats/ClapprStats.d.ts +5 -2
  36. package/lib/plugins/clappr-stats/ClapprStats.d.ts.map +1 -1
  37. package/lib/plugins/clappr-stats/ClapprStats.js +31 -33
  38. package/lib/plugins/clappr-stats/types.d.ts +21 -21
  39. package/lib/plugins/clappr-stats/types.d.ts.map +1 -1
  40. package/lib/plugins/clappr-stats/types.js +22 -22
  41. package/lib/plugins/clappr-stats/utils.d.ts +2 -2
  42. package/lib/plugins/clappr-stats/utils.d.ts.map +1 -1
  43. package/lib/plugins/click-to-pause/ClickToPause.js +1 -1
  44. package/lib/plugins/clips/Clips.d.ts +1 -1
  45. package/lib/plugins/dvr-controls/DvrControls.d.ts +6 -2
  46. package/lib/plugins/dvr-controls/DvrControls.d.ts.map +1 -1
  47. package/lib/plugins/dvr-controls/DvrControls.js +39 -27
  48. package/lib/plugins/media-control/MediaControl.d.ts +9 -2
  49. package/lib/plugins/media-control/MediaControl.d.ts.map +1 -1
  50. package/lib/plugins/media-control/MediaControl.js +26 -10
  51. package/lib/plugins/picture-in-picture/PictureInPicture.js +1 -1
  52. package/lib/plugins/subtitles/ClosedCaptions.js +1 -1
  53. package/lib/plugins/vast-ads/VastAds.js +1 -1
  54. package/lib/plugins/vast-ads/rollmanager.js +1 -1
  55. package/lib/plugins/volume-fade/VolumeFade.d.ts +25 -10
  56. package/lib/plugins/volume-fade/VolumeFade.d.ts.map +1 -1
  57. package/lib/plugins/volume-fade/VolumeFade.js +62 -60
  58. package/lib/testUtils.d.ts.map +1 -1
  59. package/lib/testUtils.js +7 -4
  60. package/lib/types.d.ts +1 -1
  61. package/package.json +3 -3
  62. package/src/playback/__tests__/HTML5Video.test.ts +2 -2
  63. package/src/plugins/audio-selector/AudioSelector.ts +14 -7
  64. package/src/plugins/audio-selector/__tests__/AudioSelector.test.ts +8 -8
  65. package/src/plugins/audio-selector/__tests__/__snapshots__/AudioSelector.test.ts.snap +15 -15
  66. package/src/plugins/bottom-gear/BottomGear.ts +2 -2
  67. package/src/plugins/bottom-gear/__tests__/BottomGear.test.ts +8 -5
  68. package/src/plugins/bottom-gear/__tests__/__snapshots__/BottomGear.test.ts.snap +3 -3
  69. package/src/plugins/clappr-nerd-stats/NerdStats.ts +5 -5
  70. package/src/plugins/clappr-stats/ClapprStats.ts +41 -40
  71. package/src/plugins/clappr-stats/__tests__/ClapprStats.test.ts +12 -12
  72. package/src/plugins/clappr-stats/types.ts +21 -21
  73. package/src/plugins/clappr-stats/utils.ts +2 -2
  74. package/src/plugins/click-to-pause/ClickToPause.ts +1 -1
  75. package/src/plugins/clips/Clips.ts +1 -1
  76. package/src/plugins/clips/__tests__/Clips.test.ts +1 -1
  77. package/src/plugins/clips/__tests__/__snapshots__/Clips.test.ts.snap +1 -1
  78. package/src/plugins/dvr-controls/DvrControls.ts +51 -37
  79. package/src/plugins/dvr-controls/__tests__/DvrControls.test.ts +84 -26
  80. package/src/plugins/dvr-controls/__tests__/__snapshots__/DvrControls.test.ts.snap +0 -12
  81. package/src/plugins/level-selector/__tests__/__snapshots__/QualityLevels.test.ts.snap +1 -1
  82. package/src/plugins/media-control/MediaControl.ts +27 -10
  83. package/src/plugins/media-control/__tests__/MediaControl.test.ts +8 -5
  84. package/src/plugins/media-control/__tests__/__snapshots__/MediaControl.test.ts.snap +20 -20
  85. package/src/plugins/picture-in-picture/PictureInPicture.ts +1 -1
  86. package/src/plugins/subtitles/ClosedCaptions.ts +1 -1
  87. package/src/plugins/subtitles/__tests__/ClosedCaptions.test.ts +1 -1
  88. package/src/plugins/vast-ads/VastAds.ts +1 -1
  89. package/src/plugins/vast-ads/rollmanager.ts +1 -1
  90. package/src/plugins/volume-fade/VolumeFade.ts +92 -75
  91. package/src/testUtils.ts +11 -5
  92. package/src/types.ts +1 -1
  93. package/temp/player.api.json +634 -16
  94. package/tsconfig.tsbuildinfo +1 -1
@@ -366,7 +366,7 @@
366
366
  {
367
367
  "kind": "Class",
368
368
  "canonicalReference": "@gcorevideo/player!ClapprStats:class",
369
- "docComment": "/**\n * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @beta\n */\n",
369
+ "docComment": "/**\n * `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.\n *\n * @remarks\n *\n * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.\n *\n * @see\n *\n * {@link NerdStats} - a plugin that visualises the playback metrics\n *\n * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @beta\n */\n",
370
370
  "excerptTokens": [
371
371
  {
372
372
  "kind": "Content",
@@ -432,8 +432,8 @@
432
432
  },
433
433
  {
434
434
  "kind": "Reference",
435
- "text": "Metrics",
436
- "canonicalReference": "@gcorevideo/player!~Metrics:type"
435
+ "text": "ClapprStatsMetrics",
436
+ "canonicalReference": "@gcorevideo/player!ClapprStatsMetrics:type"
437
437
  },
438
438
  {
439
439
  "kind": "Content",
@@ -460,6 +460,628 @@
460
460
  },
461
461
  "implementsTokenRanges": []
462
462
  },
463
+ {
464
+ "kind": "TypeAlias",
465
+ "canonicalReference": "@gcorevideo/player!ClapprStatsBitrateTrack:type",
466
+ "docComment": "/**\n * @beta\n */\n",
467
+ "excerptTokens": [
468
+ {
469
+ "kind": "Content",
470
+ "text": "export type ClapprStatsBitrateTrack = "
471
+ },
472
+ {
473
+ "kind": "Content",
474
+ "text": "{\n start: number;\n end?: number;\n time?: number;\n bitrate: number;\n}"
475
+ },
476
+ {
477
+ "kind": "Content",
478
+ "text": ";"
479
+ }
480
+ ],
481
+ "fileUrlPath": "src/plugins/clappr-stats/types.ts",
482
+ "releaseTag": "Beta",
483
+ "name": "ClapprStatsBitrateTrack",
484
+ "typeTokenRange": {
485
+ "startIndex": 1,
486
+ "endIndex": 2
487
+ }
488
+ },
489
+ {
490
+ "kind": "Enum",
491
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph:enum",
492
+ "docComment": "/**\n * @beta\n */\n",
493
+ "excerptTokens": [
494
+ {
495
+ "kind": "Content",
496
+ "text": "export declare enum ClapprStatsChronograph "
497
+ }
498
+ ],
499
+ "fileUrlPath": "src/plugins/clappr-stats/types.ts",
500
+ "releaseTag": "Beta",
501
+ "name": "ClapprStatsChronograph",
502
+ "preserveMemberOrder": false,
503
+ "members": [
504
+ {
505
+ "kind": "EnumMember",
506
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Buffering:member",
507
+ "docComment": "",
508
+ "excerptTokens": [
509
+ {
510
+ "kind": "Content",
511
+ "text": "Buffering = "
512
+ },
513
+ {
514
+ "kind": "Content",
515
+ "text": "\"buffering\""
516
+ }
517
+ ],
518
+ "initializerTokenRange": {
519
+ "startIndex": 1,
520
+ "endIndex": 2
521
+ },
522
+ "releaseTag": "Beta",
523
+ "name": "Buffering"
524
+ },
525
+ {
526
+ "kind": "EnumMember",
527
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Pause:member",
528
+ "docComment": "",
529
+ "excerptTokens": [
530
+ {
531
+ "kind": "Content",
532
+ "text": "Pause = "
533
+ },
534
+ {
535
+ "kind": "Content",
536
+ "text": "\"pause\""
537
+ }
538
+ ],
539
+ "initializerTokenRange": {
540
+ "startIndex": 1,
541
+ "endIndex": 2
542
+ },
543
+ "releaseTag": "Beta",
544
+ "name": "Pause"
545
+ },
546
+ {
547
+ "kind": "EnumMember",
548
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Session:member",
549
+ "docComment": "",
550
+ "excerptTokens": [
551
+ {
552
+ "kind": "Content",
553
+ "text": "Session = "
554
+ },
555
+ {
556
+ "kind": "Content",
557
+ "text": "\"session\""
558
+ }
559
+ ],
560
+ "initializerTokenRange": {
561
+ "startIndex": 1,
562
+ "endIndex": 2
563
+ },
564
+ "releaseTag": "Beta",
565
+ "name": "Session"
566
+ },
567
+ {
568
+ "kind": "EnumMember",
569
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Startup:member",
570
+ "docComment": "",
571
+ "excerptTokens": [
572
+ {
573
+ "kind": "Content",
574
+ "text": "Startup = "
575
+ },
576
+ {
577
+ "kind": "Content",
578
+ "text": "\"startup\""
579
+ }
580
+ ],
581
+ "initializerTokenRange": {
582
+ "startIndex": 1,
583
+ "endIndex": 2
584
+ },
585
+ "releaseTag": "Beta",
586
+ "name": "Startup"
587
+ },
588
+ {
589
+ "kind": "EnumMember",
590
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Watch:member",
591
+ "docComment": "",
592
+ "excerptTokens": [
593
+ {
594
+ "kind": "Content",
595
+ "text": "Watch = "
596
+ },
597
+ {
598
+ "kind": "Content",
599
+ "text": "\"watch\""
600
+ }
601
+ ],
602
+ "initializerTokenRange": {
603
+ "startIndex": 1,
604
+ "endIndex": 2
605
+ },
606
+ "releaseTag": "Beta",
607
+ "name": "Watch"
608
+ }
609
+ ]
610
+ },
611
+ {
612
+ "kind": "Enum",
613
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter:enum",
614
+ "docComment": "/**\n * @beta\n */\n",
615
+ "excerptTokens": [
616
+ {
617
+ "kind": "Content",
618
+ "text": "export declare enum ClapprStatsCounter "
619
+ }
620
+ ],
621
+ "fileUrlPath": "src/plugins/clappr-stats/types.ts",
622
+ "releaseTag": "Beta",
623
+ "name": "ClapprStatsCounter",
624
+ "preserveMemberOrder": false,
625
+ "members": [
626
+ {
627
+ "kind": "EnumMember",
628
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Buffering:member",
629
+ "docComment": "",
630
+ "excerptTokens": [
631
+ {
632
+ "kind": "Content",
633
+ "text": "Buffering = "
634
+ },
635
+ {
636
+ "kind": "Content",
637
+ "text": "\"buffering\""
638
+ }
639
+ ],
640
+ "initializerTokenRange": {
641
+ "startIndex": 1,
642
+ "endIndex": 2
643
+ },
644
+ "releaseTag": "Beta",
645
+ "name": "Buffering"
646
+ },
647
+ {
648
+ "kind": "EnumMember",
649
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.ChangeLevel:member",
650
+ "docComment": "",
651
+ "excerptTokens": [
652
+ {
653
+ "kind": "Content",
654
+ "text": "ChangeLevel = "
655
+ },
656
+ {
657
+ "kind": "Content",
658
+ "text": "\"changeLevel\""
659
+ }
660
+ ],
661
+ "initializerTokenRange": {
662
+ "startIndex": 1,
663
+ "endIndex": 2
664
+ },
665
+ "releaseTag": "Beta",
666
+ "name": "ChangeLevel"
667
+ },
668
+ {
669
+ "kind": "EnumMember",
670
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DecodedFrames:member",
671
+ "docComment": "",
672
+ "excerptTokens": [
673
+ {
674
+ "kind": "Content",
675
+ "text": "DecodedFrames = "
676
+ },
677
+ {
678
+ "kind": "Content",
679
+ "text": "\"decodedFrames\""
680
+ }
681
+ ],
682
+ "initializerTokenRange": {
683
+ "startIndex": 1,
684
+ "endIndex": 2
685
+ },
686
+ "releaseTag": "Beta",
687
+ "name": "DecodedFrames"
688
+ },
689
+ {
690
+ "kind": "EnumMember",
691
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DroppedFrames:member",
692
+ "docComment": "",
693
+ "excerptTokens": [
694
+ {
695
+ "kind": "Content",
696
+ "text": "DroppedFrames = "
697
+ },
698
+ {
699
+ "kind": "Content",
700
+ "text": "\"droppedFrames\""
701
+ }
702
+ ],
703
+ "initializerTokenRange": {
704
+ "startIndex": 1,
705
+ "endIndex": 2
706
+ },
707
+ "releaseTag": "Beta",
708
+ "name": "DroppedFrames"
709
+ },
710
+ {
711
+ "kind": "EnumMember",
712
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DvrUsage:member",
713
+ "docComment": "",
714
+ "excerptTokens": [
715
+ {
716
+ "kind": "Content",
717
+ "text": "DvrUsage = "
718
+ },
719
+ {
720
+ "kind": "Content",
721
+ "text": "\"dvrUsage\""
722
+ }
723
+ ],
724
+ "initializerTokenRange": {
725
+ "startIndex": 1,
726
+ "endIndex": 2
727
+ },
728
+ "releaseTag": "Beta",
729
+ "name": "DvrUsage"
730
+ },
731
+ {
732
+ "kind": "EnumMember",
733
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Error:member",
734
+ "docComment": "",
735
+ "excerptTokens": [
736
+ {
737
+ "kind": "Content",
738
+ "text": "Error = "
739
+ },
740
+ {
741
+ "kind": "Content",
742
+ "text": "\"error\""
743
+ }
744
+ ],
745
+ "initializerTokenRange": {
746
+ "startIndex": 1,
747
+ "endIndex": 2
748
+ },
749
+ "releaseTag": "Beta",
750
+ "name": "Error"
751
+ },
752
+ {
753
+ "kind": "EnumMember",
754
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fps:member",
755
+ "docComment": "",
756
+ "excerptTokens": [
757
+ {
758
+ "kind": "Content",
759
+ "text": "Fps = "
760
+ },
761
+ {
762
+ "kind": "Content",
763
+ "text": "\"fps\""
764
+ }
765
+ ],
766
+ "initializerTokenRange": {
767
+ "startIndex": 1,
768
+ "endIndex": 2
769
+ },
770
+ "releaseTag": "Beta",
771
+ "name": "Fps"
772
+ },
773
+ {
774
+ "kind": "EnumMember",
775
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fullscreen:member",
776
+ "docComment": "",
777
+ "excerptTokens": [
778
+ {
779
+ "kind": "Content",
780
+ "text": "Fullscreen = "
781
+ },
782
+ {
783
+ "kind": "Content",
784
+ "text": "\"fullscreen\""
785
+ }
786
+ ],
787
+ "initializerTokenRange": {
788
+ "startIndex": 1,
789
+ "endIndex": 2
790
+ },
791
+ "releaseTag": "Beta",
792
+ "name": "Fullscreen"
793
+ },
794
+ {
795
+ "kind": "EnumMember",
796
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Pause:member",
797
+ "docComment": "",
798
+ "excerptTokens": [
799
+ {
800
+ "kind": "Content",
801
+ "text": "Pause = "
802
+ },
803
+ {
804
+ "kind": "Content",
805
+ "text": "\"pause\""
806
+ }
807
+ ],
808
+ "initializerTokenRange": {
809
+ "startIndex": 1,
810
+ "endIndex": 2
811
+ },
812
+ "releaseTag": "Beta",
813
+ "name": "Pause"
814
+ },
815
+ {
816
+ "kind": "EnumMember",
817
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Play:member",
818
+ "docComment": "",
819
+ "excerptTokens": [
820
+ {
821
+ "kind": "Content",
822
+ "text": "Play = "
823
+ },
824
+ {
825
+ "kind": "Content",
826
+ "text": "\"play\""
827
+ }
828
+ ],
829
+ "initializerTokenRange": {
830
+ "startIndex": 1,
831
+ "endIndex": 2
832
+ },
833
+ "releaseTag": "Beta",
834
+ "name": "Play"
835
+ },
836
+ {
837
+ "kind": "EnumMember",
838
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Seek:member",
839
+ "docComment": "",
840
+ "excerptTokens": [
841
+ {
842
+ "kind": "Content",
843
+ "text": "Seek = "
844
+ },
845
+ {
846
+ "kind": "Content",
847
+ "text": "\"seek\""
848
+ }
849
+ ],
850
+ "initializerTokenRange": {
851
+ "startIndex": 1,
852
+ "endIndex": 2
853
+ },
854
+ "releaseTag": "Beta",
855
+ "name": "Seek"
856
+ }
857
+ ]
858
+ },
859
+ {
860
+ "kind": "Enum",
861
+ "canonicalReference": "@gcorevideo/player!ClapprStatsEvents:enum",
862
+ "docComment": "/**\n * @beta\n */\n",
863
+ "excerptTokens": [
864
+ {
865
+ "kind": "Content",
866
+ "text": "export declare enum ClapprStatsEvents "
867
+ }
868
+ ],
869
+ "fileUrlPath": "src/plugins/clappr-stats/types.ts",
870
+ "releaseTag": "Beta",
871
+ "name": "ClapprStatsEvents",
872
+ "preserveMemberOrder": false,
873
+ "members": [
874
+ {
875
+ "kind": "EnumMember",
876
+ "canonicalReference": "@gcorevideo/player!ClapprStatsEvents.REPORT:member",
877
+ "docComment": "/**\n * Emitted periodically with current measurements.\n */\n",
878
+ "excerptTokens": [
879
+ {
880
+ "kind": "Content",
881
+ "text": "REPORT = "
882
+ },
883
+ {
884
+ "kind": "Content",
885
+ "text": "\"clappr:stats:report\""
886
+ }
887
+ ],
888
+ "initializerTokenRange": {
889
+ "startIndex": 1,
890
+ "endIndex": 2
891
+ },
892
+ "releaseTag": "Beta",
893
+ "name": "REPORT"
894
+ }
895
+ ]
896
+ },
897
+ {
898
+ "kind": "TypeAlias",
899
+ "canonicalReference": "@gcorevideo/player!ClapprStatsMetrics:type",
900
+ "docComment": "/**\n * @beta\n */\n",
901
+ "excerptTokens": [
902
+ {
903
+ "kind": "Content",
904
+ "text": "export type ClapprStatsMetrics = "
905
+ },
906
+ {
907
+ "kind": "Content",
908
+ "text": "{\n counters: {\n ["
909
+ },
910
+ {
911
+ "kind": "Reference",
912
+ "text": "ClapprStatsCounter.Play",
913
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Play:member"
914
+ },
915
+ {
916
+ "kind": "Content",
917
+ "text": "]: number;\n ["
918
+ },
919
+ {
920
+ "kind": "Reference",
921
+ "text": "ClapprStatsCounter.Pause",
922
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Pause:member"
923
+ },
924
+ {
925
+ "kind": "Content",
926
+ "text": "]: number;\n ["
927
+ },
928
+ {
929
+ "kind": "Reference",
930
+ "text": "ClapprStatsCounter.Error",
931
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Error:member"
932
+ },
933
+ {
934
+ "kind": "Content",
935
+ "text": "]: number;\n ["
936
+ },
937
+ {
938
+ "kind": "Reference",
939
+ "text": "ClapprStatsCounter.Buffering",
940
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Buffering:member"
941
+ },
942
+ {
943
+ "kind": "Content",
944
+ "text": "]: number;\n ["
945
+ },
946
+ {
947
+ "kind": "Reference",
948
+ "text": "ClapprStatsCounter.DecodedFrames",
949
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DecodedFrames:member"
950
+ },
951
+ {
952
+ "kind": "Content",
953
+ "text": "]: number;\n ["
954
+ },
955
+ {
956
+ "kind": "Reference",
957
+ "text": "ClapprStatsCounter.DroppedFrames",
958
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DroppedFrames:member"
959
+ },
960
+ {
961
+ "kind": "Content",
962
+ "text": "]: number;\n ["
963
+ },
964
+ {
965
+ "kind": "Reference",
966
+ "text": "ClapprStatsCounter.Fps",
967
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fps:member"
968
+ },
969
+ {
970
+ "kind": "Content",
971
+ "text": "]: number;\n ["
972
+ },
973
+ {
974
+ "kind": "Reference",
975
+ "text": "ClapprStatsCounter.ChangeLevel",
976
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.ChangeLevel:member"
977
+ },
978
+ {
979
+ "kind": "Content",
980
+ "text": "]: number;\n ["
981
+ },
982
+ {
983
+ "kind": "Reference",
984
+ "text": "ClapprStatsCounter.Seek",
985
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Seek:member"
986
+ },
987
+ {
988
+ "kind": "Content",
989
+ "text": "]: number;\n ["
990
+ },
991
+ {
992
+ "kind": "Reference",
993
+ "text": "ClapprStatsCounter.Fullscreen",
994
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fullscreen:member"
995
+ },
996
+ {
997
+ "kind": "Content",
998
+ "text": "]: number;\n ["
999
+ },
1000
+ {
1001
+ "kind": "Reference",
1002
+ "text": "ClapprStatsCounter.DvrUsage",
1003
+ "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DvrUsage:member"
1004
+ },
1005
+ {
1006
+ "kind": "Content",
1007
+ "text": "]: number;\n };\n chrono: {\n ["
1008
+ },
1009
+ {
1010
+ "kind": "Reference",
1011
+ "text": "ClapprStatsChronograph.Startup",
1012
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Startup:member"
1013
+ },
1014
+ {
1015
+ "kind": "Content",
1016
+ "text": "]: number;\n ["
1017
+ },
1018
+ {
1019
+ "kind": "Reference",
1020
+ "text": "ClapprStatsChronograph.Watch",
1021
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Watch:member"
1022
+ },
1023
+ {
1024
+ "kind": "Content",
1025
+ "text": "]: number;\n ["
1026
+ },
1027
+ {
1028
+ "kind": "Reference",
1029
+ "text": "ClapprStatsChronograph.Pause",
1030
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Pause:member"
1031
+ },
1032
+ {
1033
+ "kind": "Content",
1034
+ "text": "]: number;\n ["
1035
+ },
1036
+ {
1037
+ "kind": "Reference",
1038
+ "text": "ClapprStatsChronograph.Buffering",
1039
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Buffering:member"
1040
+ },
1041
+ {
1042
+ "kind": "Content",
1043
+ "text": "]: number;\n ["
1044
+ },
1045
+ {
1046
+ "kind": "Reference",
1047
+ "text": "ClapprStatsChronograph.Session",
1048
+ "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Session:member"
1049
+ },
1050
+ {
1051
+ "kind": "Content",
1052
+ "text": "]: number;\n };\n extra: {\n playbackName: string;\n playbackType: string;\n bitratesHistory: "
1053
+ },
1054
+ {
1055
+ "kind": "Reference",
1056
+ "text": "ClapprStatsBitrateTrack",
1057
+ "canonicalReference": "@gcorevideo/player!ClapprStatsBitrateTrack:type"
1058
+ },
1059
+ {
1060
+ "kind": "Content",
1061
+ "text": "[];\n bitrateWeightedMean: number;\n bitrateMostUsed: number;\n buffersize: number;\n watchHistory: "
1062
+ },
1063
+ {
1064
+ "kind": "Reference",
1065
+ "text": "Array",
1066
+ "canonicalReference": "!Array:interface"
1067
+ },
1068
+ {
1069
+ "kind": "Content",
1070
+ "text": "<[number, number]>;\n watchedPercentage: number;\n bufferingPercentage: number;\n bandwidth: number;\n duration: number;\n currentTime: number;\n };\n}"
1071
+ },
1072
+ {
1073
+ "kind": "Content",
1074
+ "text": ";"
1075
+ }
1076
+ ],
1077
+ "fileUrlPath": "src/plugins/clappr-stats/types.ts",
1078
+ "releaseTag": "Beta",
1079
+ "name": "ClapprStatsMetrics",
1080
+ "typeTokenRange": {
1081
+ "startIndex": 1,
1082
+ "endIndex": 38
1083
+ }
1084
+ },
463
1085
  {
464
1086
  "kind": "TypeAlias",
465
1087
  "canonicalReference": "@gcorevideo/player!ClapprStatsSettings:type",
@@ -741,7 +1363,7 @@
741
1363
  {
742
1364
  "kind": "Interface",
743
1365
  "canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
744
- "docComment": "/**\n * Configuration options for the {@link ClipsPlugin} plugin.\n *\n * @beta\n */\n",
1366
+ "docComment": "/**\n * Configuration options for the {@link Clips} plugin.\n *\n * @beta\n */\n",
745
1367
  "excerptTokens": [
746
1368
  {
747
1369
  "kind": "Content",
@@ -1397,7 +2019,7 @@
1397
2019
  {
1398
2020
  "kind": "EnumMember",
1399
2021
  "canonicalReference": "@gcorevideo/player!GearEvents.RENDERED:member",
1400
- "docComment": "/**\n * Use this event to accurately attach an item to the gear menu\n */\n",
2022
+ "docComment": "/**\n * Subscribe to this event to accurately attach an item to the gear menu\n */\n",
1401
2023
  "excerptTokens": [
1402
2024
  {
1403
2025
  "kind": "Content",
@@ -2654,7 +3276,7 @@
2654
3276
  {
2655
3277
  "kind": "Method",
2656
3278
  "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",
3279
+ "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 * @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",
2658
3280
  "excerptTokens": [
2659
3281
  {
2660
3282
  "kind": "Content",
@@ -2750,7 +3372,7 @@
2750
3372
  {
2751
3373
  "kind": "Method",
2752
3374
  "canonicalReference": "@gcorevideo/player!MediaControl#putElement:member(1)",
2753
- "docComment": "",
3375
+ "docComment": "/**\n * @deprecated\n *\n * Use {@link MediaControl.mount} instead\n *\n * @param name - \n *\n * @param element - \n */\n",
2754
3376
  "excerptTokens": [
2755
3377
  {
2756
3378
  "kind": "Content",
@@ -2911,7 +3533,7 @@
2911
3533
  {
2912
3534
  "kind": "Method",
2913
3535
  "canonicalReference": "@gcorevideo/player!MediaControl#toggleElement:member(1)",
2914
- "docComment": "/**\n * Toggle the visibility of a media control element\n *\n * @param name - The name of the media control element\n *\n * @param show - Whether to show or hide the element\n */\n",
3536
+ "docComment": "/**\n * Toggle the visibility of a media control element\n *\n * @param name - The name of the media control element\n *\n * @param show - Visibility state\n */\n",
2915
3537
  "excerptTokens": [
2916
3538
  {
2917
3539
  "kind": "Content",
@@ -3617,7 +4239,7 @@
3617
4239
  {
3618
4240
  "kind": "Class",
3619
4241
  "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",
4242
+ "docComment": "/**\n * `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link BottomGear} - where the button is attached\n *\n * - {@link ClapprStats} - to get the metrics from\n *\n * The plugin is rendered as an item in the gear menu.\n *\n * When clicked, it shows an overlay window with the information about the network speed, latency, etc, and recommended quality level.\n *\n * @beta\n */\n",
3621
4243
  "excerptTokens": [
3622
4244
  {
3623
4245
  "kind": "Content",
@@ -5420,7 +6042,7 @@
5420
6042
  {
5421
6043
  "kind": "PropertySignature",
5422
6044
  "canonicalReference": "@gcorevideo/player!PlayerConfig#playbackType:member",
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",
6045
+ "docComment": "/**\n * Stream type.\n *\n * @remarks\n *\n * 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",
5424
6046
  "excerptTokens": [
5425
6047
  {
5426
6048
  "kind": "Content",
@@ -8996,7 +9618,7 @@
8996
9618
  {
8997
9619
  "kind": "TypeAlias",
8998
9620
  "canonicalReference": "@gcorevideo/player!TimeUpdate:type",
8999
- "docComment": "/**\n * For the plugin development\n *\n * @beta\n */\n",
9621
+ "docComment": "/**\n * For the plugin development\n *\n * @deprecated\n *\n * Use TimePosition instead\n *\n * @beta\n */\n",
9000
9622
  "excerptTokens": [
9001
9623
  {
9002
9624
  "kind": "Content",
@@ -9007,10 +9629,6 @@
9007
9629
  "text": "TimePosition",
9008
9630
  "canonicalReference": "@gcorevideo/player!TimePosition:interface"
9009
9631
  },
9010
- {
9011
- "kind": "Content",
9012
- "text": " & {\n firstFragDateTime: number;\n}"
9013
- },
9014
9632
  {
9015
9633
  "kind": "Content",
9016
9634
  "text": ";"
@@ -9021,7 +9639,7 @@
9021
9639
  "name": "TimeUpdate",
9022
9640
  "typeTokenRange": {
9023
9641
  "startIndex": 1,
9024
- "endIndex": 3
9642
+ "endIndex": 2
9025
9643
  }
9026
9644
  },
9027
9645
  {