@gcorevideo/player 2.24.14 → 2.25.0

package/temp/player.api.json

@@ -3390,7 +3390,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!MediaControl:class",
-          "docComment": "/**\n * `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI.\n *\n * Configuration options:\n *\n * - `mediaControl`: {@link MediaControlSettings} - specifies the allowed media control elements in each area\n *\n * - `persistConfig`: boolean - `common` option, makes the plugin persist the media control settings\n *\n * - `chromeless`: boolean\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that provides framework for building media control UI.\n *\n * @remarks\n *\n * The methods exposed are to be used by the other plugins that extend the media control UI.\n *\n * Configuration options (root level)\n *\n * - `hideMediaControlDelay`: number - specifies the delay in milliseconds before the media control UI is hidden after the last user interaction\n *\n * - `mediaControl`: {@link MediaControlSettings} - specifies the media control dashboard layout\n *\n * - `persistConfig`: boolean - `common` option, makes the plugin persist the media control settings\n *\n * - `chromeless`: boolean - `common` option, hides the media control UI\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -3477,23 +3477,23 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!MediaControl#disable:member(1)",
-              "docComment": "/**\n * Hides the media control UI\n */\n",
+              "canonicalReference": "@gcorevideo/player!MediaControl.defaultSettings:member(1)",
+              "docComment": "/**\n * @returns Default media control layout settings  @remark The method can be used to change the default dashboard layout, for example, removing the standard UI elements\n *\n * @example\n * ```ts\n * const settings = MediaControl.defaultSettings()\n * settings.left = settings.filter(item => item !== 'playpause' && item !== 'playstop')\n * ...\n * new Player({\n *   mediaControl: settings,\n * })\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "disable(): "
+                  "text": "static defaultSettings(): "
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "any"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": false,
+              "isStatic": true,
               "returnTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -3504,16 +3504,16 @@
               "parameters": [],
               "isOptional": false,
               "isAbstract": false,
-              "name": "disable"
+              "name": "defaultSettings"
             },
             {
               "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!MediaControl#disabledControlButton:member(1)",
-              "docComment": "/**\n * Disable the user interaction for the control buttons\n */\n",
+              "canonicalReference": "@gcorevideo/player!MediaControl#disable:member(1)",
+              "docComment": "/**\n * Hides the media control UI\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "disabledControlButton(): "
+                  "text": "disable(): "
                 },
                 {
                   "kind": "Content",
@@ -3535,7 +3535,7 @@
               "parameters": [],
               "isOptional": false,
               "isAbstract": false,
-              "name": "disabledControlButton"
+              "name": "disable"
             },
             {
               "kind": "Method",
@@ -3570,34 +3570,65 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!MediaControl#enableControlButton:member(1)",
-              "docComment": "/**\n * Enable the user interaction disabled earlier\n */\n",
+              "canonicalReference": "@gcorevideo/player!MediaControl.extendSettings:member(1)",
+              "docComment": "/**\n * Extend the default media control layout settings\n *\n * @remarks\n *\n * This method allows adding custom elements to the media control dashboard. The default settings are not modified.\n *\n * @param settings - Additional settings\n *\n * @returns The extended settings\n *\n * @example\n * ```ts\n * new Player({\n *   mediaControl: MediaControl.extendSettings({\n *     left: ['*'], // add all custom elements to the left panel\n *   }),\n * })\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "enableControlButton(): "
+                  "text": "static extendSettings(settings: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Partial",
+                  "canonicalReference": "!Partial:type"
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MediaControlSettings",
+                  "canonicalReference": "@gcorevideo/player!MediaControlSettings:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        left: string[];\n        right: string[];\n        default: string[];\n    }"
                 },
                 {
                   "kind": "Content",
                   "text": ";"
                 }
               ],
-              "isStatic": false,
+              "isStatic": true,
               "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
+                "startIndex": 6,
+                "endIndex": 7
               },
               "releaseTag": "Beta",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [],
+              "parameters": [
+                {
+                  "parameterName": "settings",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                }
+              ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "enableControlButton"
+              "name": "extendSettings"
             },
             {
               "kind": "Method",
@@ -3633,7 +3664,7 @@
             {
               "kind": "Method",
               "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 * @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",
+              "docComment": "/**\n * Mounts a media control element at a specific location\n *\n * @remarks\n *\n * Use this method to render custom media control UI in a plugin\n *\n * @param name - The location to mount the element\n *\n * @param element - The element to mount\n *\n * @example\n * ```ts\n * class MyPlugin extends UICorePlugin {\n *   override render() {\n *     this.$el.html('<div id=\"my-element\" class=\"my-class\">Here we go</div>')\n *     this.core.getPlugin('media_control').mount('left', this.$el)\n *     return this\n *   }\n * }\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -3641,8 +3672,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "MediaControlElement",
-                  "canonicalReference": "@gcorevideo/player!MediaControlElement:type"
+                  "text": "MediaControlSlotMountPoint",
+                  "canonicalReference": "@gcorevideo/player!MediaControlSlotMountPoint:type"
                 },
                 {
                   "kind": "Content",
@@ -3821,6 +3852,72 @@
               "isAbstract": false,
               "name": "setVolume"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!MediaControl#slot:member(1)",
+              "docComment": "/**\n * Mount a media control to its configured location\n *\n * @remarks\n *\n * Media controls layout is configured via {@link MediaControlSettings}. A plugin implementing custom elements on the media control dashboard, should use this method to mount the element to the correct location. The actual location is defined by the occurence of the element token in the `left`, `right` or `default` section of the {@link MediaControlSettings}.\n *\n * @param name - The name of the media control element\n *\n * @param element - The DOM node/fragment to mount\n *\n * @example\n * ```ts\n * class MyPlugin extends UICorePlugin {\n *   override render() {\n *     // mount the element where it is configured in the layout\n *     this.core.getPlugin('media_control').slot('my-element', this.$el)\n *   }\n * }\n * ...\n * Player.registerPlugin(MyPlugin)\n * ...\n * // Configuration of the media control layout\n * new Player({\n *   mediaControl: {\n *     left: ['my-element'], // the element will be mounted to the left panel\n *   },\n * })\n * ```\n *\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "slot(name: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MediaControlElement",
+                  "canonicalReference": "@gcorevideo/player!MediaControlElement:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", element: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ZeptoResult",
+                  "canonicalReference": "@gcorevideo/player!ZeptoResult:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "name",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "element",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "slot"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!MediaControl#toggleElement:member(1)",
@@ -3926,34 +4023,15 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!MediaControlElement:type",
-          "docComment": "/**\n * Built-in media control elements.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * Media control element. Each element's token in the media control layout settings determines where the element is rendered.\n *\n * @remarks\n *\n * Standard media control elements are defined in the {@link StandardMediaControlElement} type. Custom media control elements can be identified by a unique token.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export type MediaControlElement = "
             },
-            {
-              "kind": "Reference",
-              "text": "MediaControlLeftElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
-            },
             {
               "kind": "Content",
-              "text": " | "
-            },
-            {
-              "kind": "Reference",
-              "text": "MediaControlLayerElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
-            },
-            {
-              "kind": "Content",
-              "text": " | "
-            },
-            {
-              "kind": "Reference",
-              "text": "MediaControlRightElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
+              "text": "string"
             },
             {
               "kind": "Content",
@@ -3965,21 +4043,21 @@
           "name": "MediaControlElement",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 6
+            "endIndex": 2
           }
         },
         {
           "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type",
-          "docComment": "/**\n * Media control elements that appear in main layer, spanning the entire width of the player.\n *\n * @beta\n */\n",
+          "canonicalReference": "@gcorevideo/player!MediaControlPluginSettings:type",
+          "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type MediaControlLayerElement = "
+              "text": "export type MediaControlPluginSettings = "
             },
             {
               "kind": "Content",
-              "text": "'seekbar' | 'seekBarContainer'"
+              "text": "{\n    hideMediaControlDelay?: number;\n}"
             },
             {
               "kind": "Content",
@@ -3987,8 +4065,8 @@
             }
           ],
           "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
-          "releaseTag": "Beta",
-          "name": "MediaControlLayerElement",
+          "releaseTag": "Public",
+          "name": "MediaControlPluginSettings",
           "typeTokenRange": {
             "startIndex": 1,
             "endIndex": 2
@@ -3996,42 +4074,43 @@
         },
         {
           "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type",
-          "docComment": "/**\n * Media control elements that appear in the left area.\n *\n * @beta\n */\n",
+          "canonicalReference": "@gcorevideo/player!MediaControlSettings:type",
+          "docComment": "/**\n * Specifies the layout of media control elements. Actual elements will be rendered according to the playback settings. Custom elements rendered by the plugins will be mounted at the specified locations.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type MediaControlLeftElement = "
+              "text": "export type MediaControlSettings = "
             },
             {
               "kind": "Content",
-              "text": "'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips'"
+              "text": "{\n    left: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MediaControlElement",
+              "canonicalReference": "@gcorevideo/player!MediaControlElement:type"
             },
             {
               "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
-          "releaseTag": "Beta",
-          "name": "MediaControlLeftElement",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!MediaControlRightElement:type",
-          "docComment": "/**\n * Media control elements that appear in the right area.\n *\n * @beta\n */\n",
-          "excerptTokens": [
+              "text": "[];\n    right: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MediaControlElement",
+              "canonicalReference": "@gcorevideo/player!MediaControlElement:type"
+            },
             {
               "kind": "Content",
-              "text": "export type MediaControlRightElement = "
+              "text": "[];\n    default: "
+            },
+            {
+              "kind": "Reference",
+              "text": "MediaControlElement",
+              "canonicalReference": "@gcorevideo/player!MediaControlElement:type"
             },
             {
               "kind": "Content",
-              "text": "'audiotracks' | 'cc' | 'fullscreen' | 'hd-indicator' | 'gear' | 'multicamera' | 'pip' | 'vr'"
+              "text": "[];\n    seekEnabled: boolean;\n}"
             },
             {
               "kind": "Content",
@@ -4040,51 +4119,24 @@
           ],
           "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
           "releaseTag": "Beta",
-          "name": "MediaControlRightElement",
+          "name": "MediaControlSettings",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 2
+            "endIndex": 8
           }
         },
         {
           "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!MediaControlSettings:type",
-          "docComment": "/**\n * Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.\n *\n * @beta\n */\n",
+          "canonicalReference": "@gcorevideo/player!MediaControlSlotMountPoint:type",
+          "docComment": "/**\n * Identifies a location for mounting custom media control elements.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type MediaControlSettings = "
+              "text": "export type MediaControlSlotMountPoint = "
             },
             {
               "kind": "Content",
-              "text": "{\n    left: "
-            },
-            {
-              "kind": "Reference",
-              "text": "MediaControlLeftElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlLeftElement:type"
-            },
-            {
-              "kind": "Content",
-              "text": "[];\n    right: "
-            },
-            {
-              "kind": "Reference",
-              "text": "MediaControlRightElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlRightElement:type"
-            },
-            {
-              "kind": "Content",
-              "text": "[];\n    default: "
-            },
-            {
-              "kind": "Reference",
-              "text": "MediaControlLayerElement",
-              "canonicalReference": "@gcorevideo/player!MediaControlLayerElement:type"
-            },
-            {
-              "kind": "Content",
-              "text": "[];\n    seekEnabled: boolean;\n}"
+              "text": "'root' | 'base' | 'left' | 'right' | 'center' | 'seekbar'"
             },
             {
               "kind": "Content",
@@ -4093,10 +4145,10 @@
           ],
           "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
           "releaseTag": "Beta",
-          "name": "MediaControlSettings",
+          "name": "MediaControlSlotMountPoint",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 8
+            "endIndex": 2
           }
         },
         {
@@ -8815,6 +8867,32 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!StandardMediaControlElement:type",
+          "docComment": "/**\n * Built-in media control elements.\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StandardMediaControlElement = "
+            },
+            {
+              "kind": "Content",
+              "text": "'duration' | 'fullscreen' | 'hd-indicator' | 'playpause' | 'playstop' | 'position' | 'seekbar' | 'volume'"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
+          "releaseTag": "Beta",
+          "name": "StandardMediaControlElement",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@gcorevideo/player!StartEventData:interface",