@gcorevideo/player 2.22.17 → 2.22.20

package/temp/player.api.json

@@ -234,6 +234,32 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!BitrateTrackRecord:type",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type BitrateTrackRecord = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    start: number;\n    end?: number;\n    time?: number;\n    bitrate: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/types.ts",
+          "releaseTag": "Beta",
+          "name": "BitrateTrackRecord",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!BottomGear:class",
@@ -366,7 +392,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!ClapprStats:class",
-          "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",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -432,8 +458,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Metrics",
-                  "canonicalReference": "@gcorevideo/player!~Metrics:type"
+                  "text": "ClapprStatsMetrics",
+                  "canonicalReference": "@gcorevideo/player!ClapprStatsMetrics:type"
                 },
                 {
                   "kind": "Content",
@@ -460,6 +486,602 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Enum",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph:enum",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare enum ClapprStatsChronograph "
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/types.ts",
+          "releaseTag": "Beta",
+          "name": "ClapprStatsChronograph",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Buffering:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Buffering = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"buffering\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Buffering"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Pause:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Pause = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"pause\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Pause"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Session:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Session = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"session\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Session"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Startup:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Startup = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"startup\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Startup"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Watch:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Watch = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"watch\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Watch"
+            }
+          ]
+        },
+        {
+          "kind": "Enum",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsCounter:enum",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare enum ClapprStatsCounter "
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/types.ts",
+          "releaseTag": "Beta",
+          "name": "ClapprStatsCounter",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Buffering:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Buffering = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"buffering\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Buffering"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.ChangeLevel:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "ChangeLevel = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"changeLevel\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "ChangeLevel"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DecodedFrames:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "DecodedFrames = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"decodedFrames\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "DecodedFrames"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DroppedFrames:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "DroppedFrames = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"droppedFrames\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "DroppedFrames"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DvrUsage:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "DvrUsage = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"dvrUsage\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "DvrUsage"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Error:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Error = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"error\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Error"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fps:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Fps = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"fps\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Fps"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fullscreen:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Fullscreen = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"fullscreen\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Fullscreen"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Pause:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Pause = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"pause\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Pause"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Play:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Play = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"play\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Play"
+            },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Seek:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "Seek = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"seek\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "Seek"
+            }
+          ]
+        },
+        {
+          "kind": "Enum",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsEvents:enum",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare enum ClapprStatsEvents "
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/types.ts",
+          "releaseTag": "Beta",
+          "name": "ClapprStatsEvents",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsEvents.REPORT:member",
+              "docComment": "/**\n * Emitted periodically with current measurements.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "REPORT = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"clappr:stats:report\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "name": "REPORT"
+            }
+          ]
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsMetrics:type",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ClapprStatsMetrics = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    counters: {\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Play",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Play:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Pause",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Pause:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Error",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Error:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Buffering",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Buffering:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.DecodedFrames",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DecodedFrames:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.DroppedFrames",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DroppedFrames:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Fps",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fps:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.ChangeLevel",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.ChangeLevel:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Seek",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Seek:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.Fullscreen",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.Fullscreen:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsCounter.DvrUsage",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsCounter.DvrUsage:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n    };\n    chrono: {\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsChronograph.Startup",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Startup:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsChronograph.Watch",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Watch:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsChronograph.Pause",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Pause:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsChronograph.Buffering",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Buffering:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n        ["
+            },
+            {
+              "kind": "Reference",
+              "text": "ClapprStatsChronograph.Session",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsChronograph.Session:member"
+            },
+            {
+              "kind": "Content",
+              "text": "]: number;\n    };\n    extra: {\n        playbackName: string;\n        playbackType: string;\n        bitratesHistory: "
+            },
+            {
+              "kind": "Reference",
+              "text": "BitrateTrackRecord",
+              "canonicalReference": "@gcorevideo/player!BitrateTrackRecord:type"
+            },
+            {
+              "kind": "Content",
+              "text": "[];\n        bitrateWeightedMean: number;\n        bitrateMostUsed: number;\n        buffersize: number;\n        watchHistory: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Array",
+              "canonicalReference": "!Array:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<[number, number]>;\n        watchedPercentage: number;\n        bufferingPercentage: number;\n        bandwidth: number;\n        duration: number;\n        currentTime: number;\n    };\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/types.ts",
+          "releaseTag": "Beta",
+          "name": "ClapprStatsMetrics",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 38
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!ClapprStatsSettings:type",
@@ -741,7 +1363,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
-          "docComment": "/**\n * Configuration options for the {@link ClipsPlugin} plugin.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Configuration options for the {@link Clips} plugin.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -3617,7 +4239,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!NerdStats:class",
-          "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",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -5420,7 +6042,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!PlayerConfig#playbackType:member",
-              "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",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -8996,7 +9618,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!TimeUpdate:type",
-          "docComment": "/**\n * For the plugin development\n *\n * @beta\n */\n",
+          "docComment": "/**\n * For the plugin development\n *\n * @deprecated\n *\n * Use TimePosition instead\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -9007,10 +9629,6 @@
               "text": "TimePosition",
               "canonicalReference": "@gcorevideo/player!TimePosition:interface"
             },
-            {
-              "kind": "Content",
-              "text": " & {\n    firstFragDateTime: number;\n}"
-            },
             {
               "kind": "Content",
               "text": ";"
@@ -9021,7 +9639,7 @@
           "name": "TimeUpdate",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 3
+            "endIndex": 2
           }
         },
         {