@gcorevideo/player 2.20.11 → 2.20.13

package/temp/player.api.json

@@ -162,7 +162,7 @@
   },
   "kind": "Package",
   "canonicalReference": "@gcorevideo/player!",
-  "docComment": "/**\n * Video player for the Gcore streaming platform\n *\n * @remarks\n *\n * This package provides a video player for the Gcore streaming platform. It is built on top of the Clappr library and provides a framework for building custom integrations. Start with {@link Player} for more information.\n *\n * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.\n *\n * @example\n * ```ts\n * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'\n *\n * Player.registerPlugin(MediaControl)\n * Player.registerPlugin(ErrorScreen)\n *\n * const player = new Player({\n *   autoPlay: true,\n *   mute: true,\n *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],\n * })\n *\n * player.attachTo(document.getElementById('container'))\n * ```\n *\n * @packageDocumentation\n */\n",
+  "docComment": "/**\n * Video player for the Gcore streaming platform\n *\n * @remarks\n *\n * This package provides a video player for the Gcore streaming platform. It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations. Start with {@link Player} for more information.\n *\n * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.\n *\n * @example\n * ```ts\n * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'\n *\n * Player.registerPlugin(MediaControl)\n * Player.registerPlugin(ErrorScreen)\n *\n * const player = new Player({\n *   autoPlay: true,\n *   mute: true,\n *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],\n * })\n *\n * player.attachTo(document.getElementById('container'))\n * ```\n *\n * @packageDocumentation\n */\n",
   "name": "@gcorevideo/player",
   "preserveMemberOrder": false,
   "members": [
@@ -1043,7 +1043,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!ContextMenuPluginSettings:interface",
-          "docComment": "/**\n * The plugin adds a context menu to the player.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Context menu plugin settings\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1331,7 +1331,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!Favicon:class",
-          "docComment": "/**\n * `PLUGIN` that adds custom favicon to the player's tab.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that changes the favicon according to the player's state.\n *\n * @remarks\n *\n * There are three states: stopped, playing and paused.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Favicon` class.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1352,172 +1352,36 @@
           "isAbstract": false,
           "name": "Favicon",
           "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@gcorevideo/player!Favicon:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `Favicon` 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
-                }
-              ]
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Favicon#bindEvents:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "bindEvents(): "
-                },
-                {
-                  "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": "bindEvents"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Favicon#configure:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "configure(): "
-                },
-                {
-                  "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": "configure"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Favicon#destroy:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "destroy(): "
-                },
-                {
-                  "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": "destroy"
-            },
+          "members": [],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@gcorevideo/player!FaviconPluginSettings:interface",
+          "docComment": "/**\n * @beta\n */\n",
+          "excerptTokens": [
             {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Favicon#disable:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "disable(): "
-                },
-                {
-                  "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": "disable"
-            },
+              "kind": "Content",
+              "text": "export interface FaviconPluginSettings "
+            }
+          ],
+          "fileUrlPath": "src/plugins/favicon/Favicon.ts",
+          "releaseTag": "Beta",
+          "name": "FaviconPluginSettings",
+          "preserveMemberOrder": false,
+          "members": [
             {
-              "kind": "Property",
-              "canonicalReference": "@gcorevideo/player!Favicon#name:member",
-              "docComment": "",
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!FaviconPluginSettings#faviconColor:member",
+              "docComment": "/**\n * CSS color of the favicon.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get name(): "
+                  "text": "faviconColor?: "
                 },
                 {
                   "kind": "Content",
@@ -1528,54 +1392,17 @@
                   "text": ";"
                 }
               ],
-              "isReadonly": true,
-              "isOptional": false,
-              "releaseTag": "Beta",
-              "name": "name",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@gcorevideo/player!Favicon#supportedVersion:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "get supportedVersion(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "{\n        min: string;\n    }"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": true,
-              "isOptional": false,
+              "isReadonly": false,
+              "isOptional": true,
               "releaseTag": "Beta",
-              "name": "supportedVersion",
+              "name": "faviconColor",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
+              }
             }
           ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
+          "extendsTokenRanges": []
         },
         {
           "kind": "TypeAlias",
@@ -2767,7 +2594,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!MediaControl:class",
-          "docComment": "/**\n * `PLUGIN` that provides a foundation for developing custom media controls UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI. The plugin registration should be arranged so that MediaControl is initialized before every other `PLUGIN` that depends on it.\n *\n * @example\n * ```ts\n * Player.registerPlugin(MediaControl) // <--- This must go first\n * Player.registerPlugin(LevelSelector) // a media control plugin\n * Player.registerPlugin(NerdStats) // another media control plugin\n * ```\n *\n * @beta\n */\n",
+          "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",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2976,6 +2803,37 @@
               "isAbstract": false,
               "name": "enableControlButton"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!MediaControl#getCenterPanel:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getCenterPanel(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getCenterPanel"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!MediaControl#getElement:member(1)",
@@ -3030,6 +2888,37 @@
               "isAbstract": false,
               "name": "getElement"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!MediaControl#getLeftPanel:member(1)",
+              "docComment": "/**\n * Get the left panel area to append custom elements to\n *\n * @returns ZeptoSelector of the left panel element\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getLeftPanel(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getLeftPanel"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!MediaControl#getRightPanel:member(1)",
@@ -3848,7 +3737,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!PlaybackError#origin:member",
-              "docComment": "/**\n * Exact component that originated the error.\n *\n * @example\n *\n * - 'core' - 'dash' - 'media_control'\n */\n",
+              "docComment": "/**\n * Name of the component that originated the error.\n *\n * @example\n *\n * - 'core' - 'dash' - 'media_control'\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -3875,7 +3764,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!PlaybackError#scope:member",
-              "docComment": "/**\n * Component subsystem of the error origin\n */\n",
+              "docComment": "/**\n * Component subsystem of the error origin, together with the `origin` uniquely identifies the originating component.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -6109,7 +5998,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!Poster:class",
-          "docComment": "/**\n * `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped\n *\n * @remarks\n *\n * When the playback is stopped, media control UI is disabled.\n *\n * Configuration options:\n *\n * - `poster.custom` - custom CSS background\n *\n * - `poster.showForNoOp` - whether to show the poster when the playback is not started\n *\n * - `poster.url` - the URL of the poster image\n *\n * - `poster.showOnVideoEnd` - whether to show the poster when the playback is ended\n *\n * @example\n * ```ts\n * new Player({\n *  ...\n *  poster: {\n *    showForNoOp: true,\n *    url: 'https://via.placeholder.com/150.png',\n *  }\n * })\n * ```\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped\n *\n * @remarks\n *\n * When the playback is stopped, media control UI is disabled. Note that the poster image, if specified via the player config, will be used to update video element's poster attribute by the HTML5-video-based playback module.\n *\n * Configuration options:\n *\n * - `poster.custom` - custom CSS background\n *\n * - `poster.showForNoOp` - whether to show the poster when the playback is not started\n *\n * - `poster.url` - the URL of the poster image\n *\n * - `poster.showOnVideoEnd` - whether to show the poster when the playback is ended\n *\n * @example\n * ```ts\n * new Player({\n *  ...\n *  poster: {\n *    showForNoOp: true,\n *    url: 'https://via.placeholder.com/150.png',\n *  }\n * })\n * ```\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -7770,7 +7659,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!SourceController:class",
-          "docComment": "/**\n * `PLUGIN` that is responsible for managing the automatic failover between sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works.\n *\n * This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.\n *\n * @example\n * ```ts\n * import { SourceController } from '@gcorevideo/player'\n *\n * Player.registerPlugin(SourceController)\n * ```\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that is responsible for managing the automatic failover between sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works.\n *\n * This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SourceController` class.\n *\n * @example\n * ```ts\n * import { SourceController } from '@gcorevideo/player'\n *\n * Player.registerPlugin(SourceController)\n * ```\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -7791,41 +7680,7 @@
           "isAbstract": false,
           "name": "SourceController",
           "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@gcorevideo/player!SourceController:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `SourceController` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "constructor(core: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ClapprCore",
-                  "canonicalReference": "@clappr/core!default:class"
-                },
-                {
-                  "kind": "Content",
-                  "text": ");"
-                }
-              ],
-              "releaseTag": "Beta",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "core",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ]
-            }
-          ],
+          "members": [],
           "extendsTokenRange": {
             "startIndex": 1,
             "endIndex": 2