@gcorevideo/player 2.20.12 → 2.20.13

package/src/plugins/click-to-pause/ClickToPause.ts

@@ -70,11 +70,6 @@ export class ClickToPause extends ContainerPlugin {
     const isLivePlayback = this.container.getPlaybackType() === Playback.LIVE
     const pointerEnabled = !isLivePlayback || this.container.isDvrEnabled()
 
-    trace(`${T} settingsUpdate`, {
-      isLivePlayback,
-      pointerEnabled,
-    })
-
     if (pointerEnabled === this.pointerEnabled) {
       return
     }

package/src/plugins/dvr-controls/DvrControls.ts

@@ -129,7 +129,6 @@ export class DvrControls extends UICorePlugin {
   }
 
   private settingsUpdate() {
-    trace(`${T} settingsUpdate`)
     this.core.getPlugin('media_control').$el.removeClass('live')
     this.render()
   }

package/src/plugins/media-control/MediaControl.ts

@@ -19,6 +19,7 @@ import { reportError, trace } from '@gcorevideo/utils'
 
 import { type TimeProgress } from '../../playback.types.js'
 
+// TODO replace Kibo with mousetrap
 import { Kibo } from '../kibo/index.js'
 
 import { CLAPPR_VERSION } from '../../build.js'
@@ -90,17 +91,10 @@ type DisabledClickable = {
 }
 
 /**
- * `PLUGIN` that provides a foundation for developing custom media controls UI.
+ * `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
  * @beta
  * @remarks
  * 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.
- * @example
- * ```ts
- * Player.registerPlugin(MediaControl) // <--- This must go first
- * Player.registerPlugin(LevelSelector) // a media control plugin
- * Player.registerPlugin(NerdStats) // another media control plugin
- * ```
  */
 export class MediaControl extends UICorePlugin {
   private advertisementPlaying = false
@@ -1316,7 +1310,6 @@ export class MediaControl extends UICorePlugin {
   }
 
   private configure() {
-    // this.advertisementPlaying ? this.disable() : this.enable()
     this.trigger(Events.MEDIACONTROL_OPTIONS_CHANGE)
   }
 

package/src/plugins/poster/Poster.ts

@@ -9,7 +9,6 @@ import {
   UIContainerPlugin,
   template,
   $,
-  Container,
 } from '@clappr/core'
 import { trace } from '@gcorevideo/utils'
 
@@ -28,6 +27,8 @@ const T = 'plugins.poster'
  * @beta
  * @remarks
  * 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.
  *
  * Configuration options:
  *
@@ -51,6 +52,8 @@ const T = 'plugins.poster'
  * ```
  */
 export class Poster extends UIContainerPlugin {
+  // TODO merge non-poster related functionality into the ClickToPause plugin
+
   private hasFatalError = false
 
   private hasStartedPlaying = false
@@ -236,8 +239,6 @@ export class Poster extends UIContainerPlugin {
         this.container.playback.consent()
         this.container.playback.play()
       }
-    } else {
-      this.container.trigger('container:start')
     }
 
     return false

package/src/plugins/source-controller/SourceController.ts

@@ -108,6 +108,9 @@ export class SourceController extends CorePlugin {
     return { min: CLAPPR_VERSION }
   }
 
+  /**
+   * @internal
+   */
   constructor(core: ClapprCore) {
     super(core)
     this.sourcesList = this.core.options.sources

package/temp/player.api.json

@@ -2594,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",
@@ -3737,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",
@@ -3764,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",
@@ -5998,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",
@@ -7659,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",
@@ -7680,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