@gcorevideo/player 2.16.17 → 2.17.0

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.\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 Clappr library and provides a framework for building custom integrations.\n *\n * @packageDocumentation\n */\n",
   "name": "@gcorevideo/player",
   "preserveMemberOrder": false,
   "members": [
@@ -447,16 +447,16 @@
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "@gcorevideo/player!PlaybackErrorCode.MediaSourceUnavailable:member",
+              "canonicalReference": "@gcorevideo/player!PlaybackErrorCode.MediaSourceAccessDenied:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "MediaSourceUnavailable = "
+                  "text": "MediaSourceAccessDenied = "
                 },
                 {
                   "kind": "Content",
-                  "text": "1"
+                  "text": "3"
                 }
               ],
               "initializerTokenRange": {
@@ -464,20 +464,20 @@
                 "endIndex": 2
               },
               "releaseTag": "Beta",
-              "name": "MediaSourceUnavailable"
+              "name": "MediaSourceAccessDenied"
             },
             {
               "kind": "EnumMember",
-              "canonicalReference": "@gcorevideo/player!PlaybackErrorCode.QualityLevelUnavailable:member",
+              "canonicalReference": "@gcorevideo/player!PlaybackErrorCode.MediaSourceUnavailable:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "QualityLevelUnavailable = "
+                  "text": "MediaSourceUnavailable = "
                 },
                 {
                   "kind": "Content",
-                  "text": "2"
+                  "text": "1"
                 }
               ],
               "initializerTokenRange": {
@@ -485,7 +485,7 @@
                 "endIndex": 2
               },
               "releaseTag": "Beta",
-              "name": "QualityLevelUnavailable"
+              "name": "MediaSourceUnavailable"
             }
           ]
         },
@@ -593,7 +593,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#attachTo:member(1)",
-              "docComment": "/**\n * Initializes the player at the given container element.\n *\n * @param playerElement - DOM element to host the player\n */\n",
+              "docComment": "/**\n * Initializes the player at the given container element.\n *\n * @remarks\n *\n * The player will be initialized and attached to the given element.\n *\n * All the core plugins will be initialized at this point.\n *\n * If no sources were configured, it will trigger an error.\n *\n * The player container will be initialized and then all the registered UI plugins.\n *\n * If the `autoPlay` option is set, then it will trigger playback immediately.\n *\n * It is an error to call this method twice. If you need to attache player to another DOM element, first call {@link Player.destroy} and then {@link Player.attachTo}.\n *\n * @param playerElement - DOM element to host the player\n *\n * @example\n * ```ts\n * const player = new Player({\n *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],\n * })\n * document.addEventListener('DOMContentLoaded', () => {\n *   player.attachTo(document.getElementById('video-container'))\n * })\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -642,7 +642,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#configure:member(1)",
-              "docComment": "/**\n * Configures the player.\n *\n * Can be called multiple times. Each consequent call extends the previous configuration. After a reconfiguration, if something significant has changed, the must be reinitialized (i.e, a `.destroy()` followed by an `.init()` call).\n *\n * @param config - complete or partial configuration\n */\n",
+              "docComment": "/**\n * Configures the player.\n *\n * @remarks\n *\n * Can be called multiple times. Each consequent call extends the previous configuration with only the new keys overridden.\n *\n * After a reconfiguration, if something significant has changed, it might make sense reinitialize the player (i.e, a `.destroy()` followed by an `.init()` call).\n *\n * @param config - complete or partial configuration\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -704,7 +704,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#destroy:member(1)",
-              "docComment": "/**\n * Destroys the player, releasing all resources and removing any DOM elements added.\n */\n",
+              "docComment": "/**\n * Destroys the player, releasing all resources and unmounting its UI from the DOM.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -735,7 +735,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#getCurrentTime:member(1)",
-              "docComment": "/**\n * Current playback time in seconds, if appropriate.\n *\n * @returns For live streams, it returns the current time of the current segment.\n */\n",
+              "docComment": "/**\n * Current playback (time since the beginning of the stream), if appropriate.\n *\n * @remarks\n *\n * For live streams, it returns the current time within the current segment.\n *\n * @returns Time in seconds\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -766,7 +766,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#getDuration:member(1)",
-              "docComment": "/**\n * Duration of the current media in seconds, if appropriate.\n *\n * @returns For live streams, it returns the duration of the current segment.\n */\n",
+              "docComment": "/**\n * Duration of the current media in seconds, if appropriate.\n *\n * @remarks\n *\n * For live streams, it returns the duration of the current segment.\n *\n * @returns Time in seconds\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -794,10 +794,103 @@
               "isAbstract": false,
               "name": "getDuration"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Player#getVolume:member(1)",
+              "docComment": "/**\n * Gets the current volume of the media content being played.\n *\n * @returns a number between 0 and 1\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getVolume(): "
+                },
+                {
+                  "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": "getVolume"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Player#isDvrEnabled:member(1)",
+              "docComment": "/**\n * Indicates whether DVR is enabled.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isDvrEnabled(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "isDvrEnabled"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Player#isPlaying:member(1)",
+              "docComment": "/**\n * Indicates the playing state of the player.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "isPlaying(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "isPlaying"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#mute:member(1)",
-              "docComment": "/**\n * Mutes the player.\n */\n",
+              "docComment": "/**\n * Mutes the sound of the video.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -828,7 +921,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#off:member(1)",
-              "docComment": "/**\n * Removes a listener from a player event\n *\n * @param event - See {@link PlayerEvent}\n *\n * @param handler - See {@link PlayerEventHandler}\n */\n",
+              "docComment": "/**\n * Removes a previously added event listener\n *\n * @param event - See {@link PlayerEvent}\n *\n * @param handler - See {@link PlayerEventHandler}\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1072,7 +1165,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player.registerPlugin:member(1)",
-              "docComment": "/**\n * Registers a plugin.\n *\n * @param plugin - plugin to register\n */\n",
+              "docComment": "/**\n * Registers a plugin.\n *\n * @remarks\n *\n * Use this method to extend the player with custom behavior. The plugin class must inherit from one of the Clappr UIPlugin, UIContainerPlugin or CorePlugin classes. A core plugin will be initialized and attached to the player when the player is initialized. A UI plugin will be initialized and attached to the player container is initialized.\n *\n * @param plugin - a plugin class\n *\n * @example\n * ```ts\n * import MyPlugin from './MyPlugin.js'\n *\n * Player.registerPlugin(MyPlugin)\n * ```\n *\n * @see\n *\n * {@link https://github.com/clappr/clappr/wiki/Architecture}\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1121,7 +1214,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#resize:member(1)",
-              "docComment": "/**\n * Resizes the player container element and everything within it.\n *\n * @param newSize - new size of the player\n */\n",
+              "docComment": "/**\n * Resizes the player container element and everything within it.\n *\n * @remarks\n *\n * Use this method when the player itself does not detect the change in size of its container element. It can be a case for orientation change on some mobile devices.\n *\n * @param newSize - new size of the player\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1169,7 +1262,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#seek:member(1)",
-              "docComment": "/**\n * Seeks to the given time.\n *\n * @param time - time to seek to in seconds\n */\n",
+              "docComment": "/**\n * Seeks to the given time.\n *\n * @param time - time to seek to in seconds (since the beginning of the stream)\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1214,6 +1307,54 @@
               "isAbstract": false,
               "name": "seek"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Player#setVolume:member(1)",
+              "docComment": "/**\n * Sets the current volume of the media content being played.\n *\n * @param volume - a number between 0 and 1\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setVolume(volume: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "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": "volume",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setVolume"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#stop:member(1)",
@@ -1248,7 +1389,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#unmute:member(1)",
-              "docComment": "/**\n * Unmutes the player.\n */\n",
+              "docComment": "/**\n * Unmutes the video sound.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1279,7 +1420,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player.unregisterPlugin:member(1)",
-              "docComment": "/**\n * Unregisters a plugin.\n *\n * @param plugin - plugin to unregister\n */\n",
+              "docComment": "/**\n * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.\n *\n * @param plugin - a plugin class\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",