@gcorevideo/player 2.24.2 → 2.24.5

package/temp/player.api.json

@@ -206,7 +206,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!BigMuteButton:class",
-          "docComment": "/**\n * `PLUGIN` that displays a big mute button over the video when it's muted. Once pressed, it unmutes the video.\n *\n * @beta\n */\n",
+          "docComment": "/**\n * `PLUGIN` that displays a big mute button over the video when it's being played muted.\n *\n * @remarks\n *\n * When pressed, it unmutes the video.\n *\n * @example\n * ```ts\n * import { BigMuteButton } from '@gcorevideo/player'\n * Player.registerPlugin(BigMuteButton)\n * ```\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1114,30 +1114,49 @@
           }
         },
         {
-          "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!ClapprStatsSettings:type",
-          "docComment": "",
+          "kind": "Interface",
+          "canonicalReference": "@gcorevideo/player!ClapprStatsSettings:interface",
+          "docComment": "/**\n * Config options for the {@link ClapprStats} plugin\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type ClapprStatsSettings = "
-            },
-            {
-              "kind": "Content",
-              "text": "{\n    runEach?: number;\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
+              "text": "export interface ClapprStatsSettings "
             }
           ],
           "fileUrlPath": "src/plugins/clappr-stats/ClapprStats.ts",
-          "releaseTag": "Public",
+          "releaseTag": "Beta",
           "name": "ClapprStatsSettings",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!ClapprStatsSettings#runEach:member",
+              "docComment": "/**\n * The interval in milliseconds of periodic measurements. The plugin will emit a {@link ClapprStatsEvents.REPORT} event with the collected metrics at the specified interval.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "runEach?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "runEach",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
         },
         {
           "kind": "Class",
@@ -1458,7 +1477,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@gcorevideo/player!ClipsPluginSettings#text:member",
-              "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",
+              "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",
@@ -1608,7 +1627,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!CmcdConfig:class",
-          "docComment": "/**\n * A `PLUGIN` that configures CMCD for playback\n *\n * @remarks\n *\n * Configuration options `cmcd`: {@link CmcdConfigPluginSettings}\n *\n * @beta\n */\n",
+          "docComment": "/**\n * A `PLUGIN` that configures {@link https://cdn.cta.tech/cta/media/media/resources/standards/pdfs/cta-5004-final.pdf | CMCD} for playback\n *\n * @remarks\n *\n * Configuration options - {@link CmcdConfigOptions}.\n *\n * @example\n * ```ts\n * import { CmcdConfig } from '@gcorevideo/player'\n * Player.registerPlugin(CmcdConfig)\n *\n * const player = new Player({\n *   source: 'https://example.com/video.mp4',\n *   cmcd: {\n *     sessionId: '1234567890',\n *     contentId: 'f572d396fae9206628714fb2ce00f72e94f2258f',\n *   },\n * })\n * ```\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -1663,41 +1682,10 @@
                 }
               ]
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@gcorevideo/player!CmcdConfig#bindEvents:member(1)",
-              "docComment": "/**\n * @inheritdocs\n */\n",
-              "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!CmcdConfig#exportIds:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Returns the current `sid` and `cid` values. Useful when the auto-generated values need to be known.\n *\n * @returns `sid` and `cid` values\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1724,45 +1712,37 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "exportIds"
-            },
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@gcorevideo/player!CmcdConfigOptions:interface",
+          "docComment": "/**\n * Config options for the {@link CmcdConfig} plugin\n *\n * @beta\n */\n",
+          "excerptTokens": [
             {
-              "kind": "Property",
-              "canonicalReference": "@gcorevideo/player!CmcdConfig#name:member",
-              "docComment": "/**\n * @inheritdocs\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "get name(): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": true,
-              "isOptional": false,
-              "releaseTag": "Beta",
-              "name": "name",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
+              "kind": "Content",
+              "text": "export interface CmcdConfigOptions "
+            }
+          ],
+          "fileUrlPath": "src/plugins/cmcd-config/CmcdConfig.ts",
+          "releaseTag": "Beta",
+          "name": "CmcdConfigOptions",
+          "preserveMemberOrder": false,
+          "members": [
             {
-              "kind": "Property",
-              "canonicalReference": "@gcorevideo/player!CmcdConfig#supportedVersion:member",
-              "docComment": "",
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!CmcdConfigOptions#contentId:member",
+              "docComment": "/**\n * `cid` value. If ommitted, the pathname part of the first source URL will be used\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get supportedVersion(): "
+                  "text": "contentId?: "
                 },
                 {
                   "kind": "Content",
@@ -1773,26 +1753,23 @@
                   "text": ";"
                 }
               ],
-              "isReadonly": true,
-              "isOptional": false,
+              "isReadonly": false,
+              "isOptional": true,
               "releaseTag": "Beta",
-              "name": "supportedVersion",
+              "name": "contentId",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
+              }
             },
             {
-              "kind": "Property",
-              "canonicalReference": "@gcorevideo/player!CmcdConfig#version:member",
-              "docComment": "",
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!CmcdConfigOptions#sessionId:member",
+              "docComment": "/**\n * `sid` value. If ommitted, a random UUID will be generated\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "get version(): "
+                  "text": "sessionId?: "
                 },
                 {
                   "kind": "Content",
@@ -1803,50 +1780,17 @@
                   "text": ";"
                 }
               ],
-              "isReadonly": true,
-              "isOptional": false,
+              "isReadonly": false,
+              "isOptional": true,
               "releaseTag": "Beta",
-              "name": "version",
+              "name": "sessionId",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            }
-          ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
-        },
-        {
-          "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!CmcdConfigPluginSettings:type",
-          "docComment": "/**\n * @beta\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export type CmcdConfigPluginSettings = "
-            },
-            {
-              "kind": "Content",
-              "text": "{\n    sessionId: string;\n    contentId?: string;\n}"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
+              }
             }
           ],
-          "fileUrlPath": "src/plugins/cmcd-config/CmcdConfig.ts",
-          "releaseTag": "Beta",
-          "name": "CmcdConfigPluginSettings",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
+          "extendsTokenRanges": []
         },
         {
           "kind": "TypeAlias",
@@ -2251,7 +2195,7 @@
         {
           "kind": "Enum",
           "canonicalReference": "@gcorevideo/player!ExtendedEvents:enum",
-          "docComment": "",
+          "docComment": "/**\n * Extended events for the {@link MediaControl} plugin\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2259,7 +2203,7 @@
             }
           ],
           "fileUrlPath": "src/plugins/media-control/MediaControl.ts",
-          "releaseTag": "Public",
+          "releaseTag": "Beta",
           "name": "ExtendedEvents",
           "preserveMemberOrder": false,
           "members": [
@@ -2281,7 +2225,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "MEDIACONTROL_MENU_COLLAPSE"
             },
             {
@@ -2302,7 +2246,7 @@
                 "startIndex": 1,
                 "endIndex": 2
               },
-              "releaseTag": "Public",
+              "releaseTag": "Beta",
               "name": "MEDIACONTROL_VOLUME"
             }
           ]
@@ -3655,6 +3599,37 @@
               "isAbstract": false,
               "name": "enableControlButton"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!MediaControl#getAvailableHeight:member(1)",
+              "docComment": "/**\n * @remarks\n *\n * This takes into account the container height and excludes the height of the controls bar\n *\n * @returns Vertical space available to render something on top of the container.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getAvailableHeight(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getAvailableHeight"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!MediaControl#mount:member(1)",
@@ -7221,30 +7196,130 @@
           "implementsTokenRanges": []
         },
         {
-          "kind": "TypeAlias",
-          "canonicalReference": "@gcorevideo/player!PosterPluginSettings:type",
-          "docComment": "",
+          "kind": "Interface",
+          "canonicalReference": "@gcorevideo/player!PosterPluginSettings:interface",
+          "docComment": "/**\n * Config options for the {@link Poster} plugin\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type PosterPluginSettings = "
+              "text": "export interface PosterPluginSettings "
+            }
+          ],
+          "fileUrlPath": "src/plugins/poster/Poster.ts",
+          "releaseTag": "Beta",
+          "name": "PosterPluginSettings",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!PosterPluginSettings#custom:member",
+              "docComment": "/**\n * Custom CSS background\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "custom?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "custom",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             },
             {
-              "kind": "Content",
-              "text": "{\n    custom?: string;\n    showForNoOp?: boolean;\n    url?: string;\n    showOnVideoEnd?: boolean;\n}"
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!PosterPluginSettings#showForNoOp:member",
+              "docComment": "/**\n * Whether to show the poster image when the playback is noop (i.e., when there is no appropriate video playback engine for current media sources set or the media sources are not set at all)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "showForNoOp?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "showForNoOp",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             },
             {
-              "kind": "Content",
-              "text": ";"
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!PosterPluginSettings#showOnVideoEnd:member",
+              "docComment": "/**\n * Whether to show the poster after playback has ended, by default `true`\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "showOnVideoEnd?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "showOnVideoEnd",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@gcorevideo/player!PosterPluginSettings#url:member",
+              "docComment": "/**\n * Poster image URL\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "url?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Beta",
+              "name": "url",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
-          "fileUrlPath": "src/plugins/poster/Poster.ts",
-          "releaseTag": "Public",
-          "name": "PosterPluginSettings",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
+          "extendsTokenRanges": []
         },
         {
           "kind": "Interface",