@gcorevideo/player 2.21.1 → 2.21.4

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 {@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",
+  "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 core functionality 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": [
@@ -237,7 +237,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!BottomGear:class",
-          "docComment": "/**\n * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI\n *\n * @remarks\n *\n * The plugins provides a base for attaching custom settings UI in the gear menu\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI\n *\n * @remarks\n *\n * The plugins provides a base for attaching custom settings UI in the gear menu\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -270,8 +270,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "GearItemElement",
-                  "canonicalReference": "@gcorevideo/player!GearItemElement:type"
+                  "text": "GearOptionsItem",
+                  "canonicalReference": "@gcorevideo/player!GearOptionsItem:type"
                 },
                 {
                   "kind": "Content",
@@ -767,6 +767,126 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@gcorevideo/player!ClosedCaptions:class",
+          "docComment": "/**\n * `PLUGIN` that provides a UI to select the subtitles when available.\n *\n * @remarks\n *\n * The plugin is activated when closed captions tracks are provided with the media source. It shows a familiar \"CC\" button with a dropdown menu to select the subtitles language.\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options - {@link ClosedCaptionsPluginSettings}\n *\n * @example\n * ```ts\n * import { ClosedCaptions } from '@gcorevideo/player'\n *\n * Player.registerPlugin(ClosedCaptions)\n *\n * new Player({\n *   ...\n *   cc: {\n *     language: 'en',\n *   },\n * })\n * ```\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare class ClosedCaptions extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "UICorePlugin",
+              "canonicalReference": "@gcorevideo/player!~UICorePlugin"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
+          "releaseTag": "Beta",
+          "isAbstract": false,
+          "name": "ClosedCaptions",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!ClosedCaptions#hide:member(1)",
+              "docComment": "/**\n * Hides the subtitles menu and the subtitles.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hide(): "
+                },
+                {
+                  "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": "hide"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!ClosedCaptions#show:member(1)",
+              "docComment": "/**\n * Shows the subtitles menu and the subtitles.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "show(): "
+                },
+                {
+                  "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": "show"
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!ClosedCaptionsPluginSettings:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type ClosedCaptionsPluginSettings = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    language?: string;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
+          "releaseTag": "Public",
+          "name": "ClosedCaptionsPluginSettings",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!ContainerPluginConstructor:type",
@@ -1269,12 +1389,39 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@gcorevideo/player!GearItemElement:type",
-          "docComment": "/**\n * An element inside the gear menu\n *\n * @beta\n */\n",
+          "docComment": "/**\n * @deprecated\n *\n * Use {@link GearOptionsItem} instead\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
               "text": "export type GearItemElement = "
             },
+            {
+              "kind": "Reference",
+              "text": "GearOptionsItem",
+              "canonicalReference": "@gcorevideo/player!GearOptionsItem:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
+          "releaseTag": "Public",
+          "name": "GearItemElement",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!GearOptionsItem:type",
+          "docComment": "/**\n * An element inside the gear menu\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type GearOptionsItem = "
+            },
             {
               "kind": "Content",
               "text": "'quality' | 'rate' | 'nerd'"
@@ -1286,7 +1433,7 @@
           ],
           "fileUrlPath": "src/plugins/bottom-gear/BottomGear.ts",
           "releaseTag": "Beta",
-          "name": "GearItemElement",
+          "name": "GearOptionsItem",
           "typeTokenRange": {
             "startIndex": 1,
             "endIndex": 2
@@ -2862,8 +3009,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "ZeptoResult",
-                  "canonicalReference": "@gcorevideo/player!ZeptoResult:type"
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
                 },
                 {
                   "kind": "Content",
@@ -3051,7 +3198,7 @@
             },
             {
               "kind": "Content",
-              "text": "'audioTracksSelector' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'subtitlesSelector'"
+              "text": "'audiotracks' | 'clipText' | 'gear' | 'pip' | 'playbackRate' | 'seekBarContainer' | 'cc'"
             },
             {
               "kind": "Content",
@@ -3887,7 +4034,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!PlaybackRate:class",
-          "docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that allows changing the playback speed of the video.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl | media_control}\n *\n * - {@link BottomGear | bottom_gear}\n *\n * It renders a button in the gear menu, which opens a dropdown with the options to change the playback rate. Note that the playback rate change is supported only for VOD or DVR enabled live streams.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -8002,98 +8149,31 @@
           "extendsTokenRanges": []
         },
         {
-          "kind": "Class",
-          "canonicalReference": "@gcorevideo/player!Subtitles:class",
-          "docComment": "/**\n * `PLUGIN` that provides a UI to select the subtitles when available.\n *\n * @remarks\n *\n * Depends on:\n *\n * - {@link MediaControl}\n *\n * Configuration options:\n *\n * - subtitles.language - The language of the subtitles to select by default.\n *\n * @example\n * ```ts\n * import { Subtitles } from '@gcorevideo/player'\n *\n * Player.registerPlugin(Subtitles)\n *\n * new Player({\n *   ...\n *   subtitles: {\n *     language: 'en',\n *   },\n * })\n * ```\n *\n * @beta\n */\n",
+          "kind": "TypeAlias",
+          "canonicalReference": "@gcorevideo/player!SubtitlesPluginSettings:type",
+          "docComment": "/**\n * @deprecated\n *\n * Use {@link ClosedCaptionsPluginSettings} instead.\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare class Subtitles extends "
+              "text": "export type SubtitlesPluginSettings = "
             },
             {
               "kind": "Reference",
-              "text": "UICorePlugin",
-              "canonicalReference": "@gcorevideo/player!~UICorePlugin"
+              "text": "ClosedCaptionsPluginSettings",
+              "canonicalReference": "@gcorevideo/player!ClosedCaptionsPluginSettings:type"
             },
             {
               "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "src/plugins/subtitles/Subtitles.ts",
-          "releaseTag": "Beta",
-          "isAbstract": false,
-          "name": "Subtitles",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Subtitles#hide:member(1)",
-              "docComment": "/**\n * Hides the subtitles menu and the subtitles.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "hide(): "
-                },
-                {
-                  "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": "hide"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!Subtitles#show:member(1)",
-              "docComment": "/**\n * Shows the subtitles menu and the subtitles.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "show(): "
-                },
-                {
-                  "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": "show"
+              "text": ";"
             }
           ],
-          "extendsTokenRange": {
+          "fileUrlPath": "src/plugins/subtitles/ClosedCaptions.ts",
+          "releaseTag": "Public",
+          "name": "SubtitlesPluginSettings",
+          "typeTokenRange": {
             "startIndex": 1,
             "endIndex": 2
-          },
-          "implementsTokenRanges": []
+          }
         },
         {
           "kind": "Class",
@@ -8496,6 +8576,106 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@gcorevideo/player!TextTrackItem:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface TextTrackItem "
+            }
+          ],
+          "fileUrlPath": "src/playback.types.ts",
+          "releaseTag": "Public",
+          "name": "TextTrackItem",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!TextTrackItem#id:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "id: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "id",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!TextTrackItem#name:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "name: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "name",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!TextTrackItem#track:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "track: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "TextTrack",
+                  "canonicalReference": "!TextTrack:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "track",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!Thumbnails:class",