@gcorevideo/player 2.22.16 → 2.22.18

package/temp/player.api.json

@@ -363,75 +363,10 @@
           },
           "implementsTokenRanges": []
         },
-        {
-          "kind": "Class",
-          "canonicalReference": "@gcorevideo/player!ClapprNerdStats: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",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare class ClapprNerdStats extends "
-            },
-            {
-              "kind": "Reference",
-              "text": "UICorePlugin",
-              "canonicalReference": "@gcorevideo/player!~UICorePlugin"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "src/plugins/clappr-nerd-stats/ClapprNerdStats.ts",
-          "releaseTag": "Beta",
-          "isAbstract": false,
-          "name": "ClapprNerdStats",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@gcorevideo/player!ClapprNerdStats:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `ClapprNerdStats` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "constructor(core: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Core",
-                  "canonicalReference": "@clappr/core!default:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ");"
-                }
-              ],
-              "releaseTag": "Beta",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "core",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ]
-            }
-          ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
-        },
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!ClapprStats:class",
-          "docComment": "/**\n * `PLUGIN` that collects useful statistics about playback performance.\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 * @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 * Configuration options - {@link ClapprStatsSettings}\n *\n * Events - {@link ClapprStatsEvents}\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -489,7 +424,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!ClapprStats#exportMetrics:member(1)",
-              "docComment": "/**\n * Returns the collected metrics.\n *\n * @returns Currently collected metrics\n */\n",
+              "docComment": "/**\n * Returns the collected metrics.\n *\n * @returns Measurements collected so far\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -517,55 +452,6 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "exportMetrics"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!ClapprStats#setUpdateMetrics:member(1)",
-              "docComment": "/**\n * Registers a callback to receive the metrics.\n *\n * @param updateMetricsFn - The callback to receive the metrics\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "setUpdateMetrics(updateMetricsFn: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "MetricsUpdateFn",
-                  "canonicalReference": "@gcorevideo/player!~MetricsUpdateFn:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Beta",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "updateMetricsFn",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "setUpdateMetrics"
             }
           ],
           "extendsTokenRange": {
@@ -574,6 +460,32 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsSettings:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ClapprStatsSettings = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    runEach?: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-stats/ClapprStats.ts",
+          "releaseTag": "Public",
+          "name": "ClapprStatsSettings",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!ClickToPause:class",
@@ -607,12 +519,12 @@
         },
         {
           "kind": "Class",
-          "canonicalReference": "@gcorevideo/player!ClipsPlugin:class",
-          "docComment": "/**\n * `PLUGIN` that shows text over the seekbar to indicate the current clip.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClipsPluginSettings}\n *\n * @beta\n */\n",
+          "canonicalReference": "@gcorevideo/player!Clips:class",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare class ClipsPlugin extends "
+              "text": "export declare class Clips extends "
             },
             {
               "kind": "Reference",
@@ -627,29 +539,57 @@
           "fileUrlPath": "src/plugins/clips/Clips.ts",
           "releaseTag": "Beta",
           "isAbstract": false,
-          "name": "ClipsPlugin",
+          "name": "Clips",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!ClipsPlugin#getText:member(1)",
-              "docComment": "/**\n * Returns the text of the current clip.\n *\n * @param time - The current time of the player.\n *\n * @returns The text of the current clip.\n */\n",
+              "canonicalReference": "@gcorevideo/player!Clips#destroy:member(1)",
+              "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getText(time: "
+                  "text": "destroy(): "
                 },
                 {
                   "kind": "Content",
-                  "text": "number"
+                  "text": "import(\"@clappr/core\")."
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UIObject",
+                  "canonicalReference": "@clappr/core!default:class"
                 },
                 {
                   "kind": "Content",
-                  "text": "): "
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "destroy"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Clips#disable:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "disable(): "
                 },
                 {
                   "kind": "Content",
-                  "text": "string"
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -658,25 +598,138 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 1,
+                "endIndex": 2
               },
               "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "disable"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Clips#enable:member(1)",
+              "docComment": "",
+              "excerptTokens": [
                 {
-                  "parameterName": "time",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
+                  "kind": "Content",
+                  "text": "enable(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
                 }
               ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "enable"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Clips#render:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "render(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "this"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
               "isOptional": false,
               "isAbstract": false,
-              "name": "getText"
+              "name": "render"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@gcorevideo/player!Clips#supportedVersion:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get supportedVersion(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        min: string;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "supportedVersion",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@gcorevideo/player!Clips#version:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get version(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Beta",
+              "name": "version",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
             }
           ],
           "extendsTokenRange": {
@@ -688,7 +741,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!ClipsPluginSettings:interface",
-          "docComment": "/**\n * Configuration options for the {@link ClipsPlugin | clips} plugin.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Configuration options for the {@link ClipsPlugin} plugin.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -703,7 +756,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!ClipsPluginSettings#text:member",
-              "docComment": "/**\n * The text to display over the seekbar.\n */\n",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2600,12 +2653,12 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!MediaControl#getElement:member(1)",
-              "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 *     const mediaControl = this.core.getPlugin('media_control')\n *     const clipText = mediaControl.getElement('clipText')\n *     clipText?.el.text('Here we go')\n *     return this\n *   }\n * }\n * ```\n *\n */\n",
+              "canonicalReference": "@gcorevideo/player!MediaControl#mount:member(1)",
+              "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",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getElement(name: "
+                  "text": "mount(name: "
                 },
                 {
                   "kind": "Reference",
@@ -2614,7 +2667,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "): "
+                  "text": ", element: "
                 },
                 {
                   "kind": "Reference",
@@ -2623,7 +2676,11 @@
                 },
                 {
                   "kind": "Content",
-                  "text": " | null"
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
                 },
                 {
                   "kind": "Content",
@@ -2632,8 +2689,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 5
+                "startIndex": 5,
+                "endIndex": 6
               },
               "releaseTag": "Beta",
               "isProtected": false,
@@ -2646,11 +2703,19 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "element",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "getElement"
+              "name": "mount"
             },
             {
               "kind": "Property",
@@ -3027,7 +3092,7 @@
             },
             {
               "kind": "Content",
-              "text": "'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume'"
+              "text": "'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips'"
             },
             {
               "kind": "Content",
@@ -3549,6 +3614,71 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "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",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class NerdStats extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "UICorePlugin",
+              "canonicalReference": "@gcorevideo/player!~UICorePlugin"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/plugins/clappr-nerd-stats/NerdStats.ts",
+          "releaseTag": "Beta",
+          "isAbstract": false,
+          "name": "NerdStats",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Constructor",
+              "canonicalReference": "@gcorevideo/player!NerdStats:constructor(1)",
+              "docComment": "/**\n * Constructs a new instance of the `NerdStats` class\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "constructor(core: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Core",
+                  "canonicalReference": "@clappr/core!default:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ");"
+                }
+              ],
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "core",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ]
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!PictureInPicture:class",
@@ -6155,7 +6285,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!QualityLevel:interface",
-          "docComment": "/**\n * A level of quality within a media source.\n *\n * @public\n */\n",
+          "docComment": "/**\n * A level of quality within a media source/representation.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -6197,7 +6327,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!QualityLevel#height:member",
-              "docComment": "/**\n * Height of the video, pixels.\n */\n",
+              "docComment": "/**\n * Height of the video frame, pixels.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -6224,7 +6354,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!QualityLevel#level:member",
-              "docComment": "/**\n * Zero-based index of the quality level.\n */\n",
+              "docComment": "/**\n * Zero-based index of the quality level. Quality levels go from low to high\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -6251,7 +6381,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!QualityLevel#width:member",
-              "docComment": "/**\n * Width of the video, pixels.\n */\n",
+              "docComment": "/**\n * Width of the video frame, pixels.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -8754,7 +8884,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!TimePosition#current:member",
-              "docComment": "/**\n * Current playback time, 0..duration, seconds.\n */\n",
+              "docComment": "/**\n * Current playback time, 0..duration\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -8782,7 +8912,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!TimePosition#total:member",
-              "docComment": "/**\n * Total duration of the media, seconds.\n */\n",
+              "docComment": "/**\n * Total duration of the media content (or DVR window size or segment duration for live streams)\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -8813,20 +8943,42 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!TimeProgress:type",
-          "docComment": "/**\n * For the plugin development\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Time progress information indicated by Clappr CONTAINER_PROGRESS and PLAYBACK_PROGRESS events.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export type TimeProgress = "
             },
+            {
+              "kind": "Content",
+              "text": "{\n    start: "
+            },
             {
               "kind": "Reference",
-              "text": "TimePosition",
-              "canonicalReference": "@gcorevideo/player!TimePosition:interface"
+              "text": "TimeValue",
+              "canonicalReference": "@gcorevideo/player!TimeValue:type"
             },
             {
               "kind": "Content",
-              "text": " & {\n    start: number;\n}"
+              "text": ";\n    current: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TimeValue",
+              "canonicalReference": "@gcorevideo/player!TimeValue:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    total: "
+            },
+            {
+              "kind": "Reference",
+              "text": "TimeValue",
+              "canonicalReference": "@gcorevideo/player!TimeValue:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}"
             },
             {
               "kind": "Content",
@@ -8838,7 +8990,7 @@
           "name": "TimeProgress",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 3
+            "endIndex": 8
           }
         },
         {
@@ -8875,7 +9027,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!TimeValue:type",
-          "docComment": "/**\n * Playback time in seconds since the beginning of the stream (or a segment for the live streams)\n *\n * @public\n */\n",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",