@gcorevideo/player 2.26.7 → 2.26.9

package/dist/index.embed.js

@@ -50695,6 +50695,7 @@ function loadImageDimensions(url) {
  *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
  *   },
  * })
+
  * ```
  */
 class Thumbnails extends UICorePlugin {

package/dist/index.js

@@ -43265,7 +43265,7 @@ class Player {
     }
 }
 
-var version$1 = "2.26.7";
+var version$1 = "2.26.9";
 
 var packages = {
 	"node_modules/@clappr/core": {
@@ -52219,6 +52219,7 @@ const T$1 = 'plugins.thumbnails';
  *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
  *   },
  * })
+
  * ```
  */
 class Thumbnails extends UICorePlugin {

package/dist/player.d.ts

@@ -3103,6 +3103,7 @@ export declare class ClapprStats extends ContainerPlugin {
      *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
      *   },
      * })
+
      * ```
      */
     export declare class Thumbnails extends UICorePlugin {
@@ -3161,15 +3162,30 @@ export declare class ClapprStats extends ContainerPlugin {
     /**
      * Plugin configuration options for the thumbnails plugin.
      * @public
+     * @remarks
+     * Example of a VTT file:
+     * ```text
+     * 1
+     * 00:00:00,000 --> 00:00:10,000
+     * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56
+     *
+     * 2
+     * 00:00:10,000 --> 00:00:20,000
+     * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56
+     *
+     * ```
      */
-    export declare type ThumbnailsPluginSettings = {
+    export declare interface ThumbnailsPluginSettings {
         backdropHeight?: number;
         backdropMaxOpacity?: number;
         backdropMinOpacity?: number;
         spotlightHeight?: number;
         sprite: string;
+        /**
+         * The VTT file to use for the thumbnails.
+         */
         vtt: string;
-    };
+    }
 
     /**
      * Current playback time and total duration of the media.

package/docs/api/player.md

@@ -699,6 +699,17 @@ Configuration options for the [QualityLevels](./player.qualitylevels.md) plugin.
 **_(BETA)_** Plugin settings
 
 
+</td></tr>
+<tr><td>
+
+[ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md)
+
+
+</td><td>
+
+Plugin configuration options for the thumbnails plugin.
+
+
 </td></tr>
 <tr><td>
 
@@ -1077,17 +1088,6 @@ Built-in media control elements.
 **_(BETA)_** Callback to send the telemetry record to the storage.
 
 
-</td></tr>
-<tr><td>
-
-[ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md)
-
-
-</td><td>
-
-Plugin configuration options for the thumbnails plugin.
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/player.thumbnails.md

@@ -38,6 +38,7 @@ new Player({
      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
   },
 })
+
 ```
 
 ## Constructors

package/docs/api/player.thumbnailspluginsettings.backdropheight.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [backdropHeight](./player.thumbnailspluginsettings.backdropheight.md)
+
+## ThumbnailsPluginSettings.backdropHeight property
+
+**Signature:**
+
+```typescript
+backdropHeight?: number;
+```

package/docs/api/player.thumbnailspluginsettings.backdropmaxopacity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [backdropMaxOpacity](./player.thumbnailspluginsettings.backdropmaxopacity.md)
+
+## ThumbnailsPluginSettings.backdropMaxOpacity property
+
+**Signature:**
+
+```typescript
+backdropMaxOpacity?: number;
+```

package/docs/api/player.thumbnailspluginsettings.backdropminopacity.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [backdropMinOpacity](./player.thumbnailspluginsettings.backdropminopacity.md)
+
+## ThumbnailsPluginSettings.backdropMinOpacity property
+
+**Signature:**
+
+```typescript
+backdropMinOpacity?: number;
+```

package/docs/api/player.thumbnailspluginsettings.md

@@ -2,19 +2,164 @@
 
 [Home](./index.md) > [@gcorevideo/player](./player.md) > [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md)
 
-## ThumbnailsPluginSettings type
+## ThumbnailsPluginSettings interface
 
 Plugin configuration options for the thumbnails plugin.
 
 **Signature:**
 
 ```typescript
-export type ThumbnailsPluginSettings = {
-    backdropHeight?: number;
-    backdropMaxOpacity?: number;
-    backdropMinOpacity?: number;
-    spotlightHeight?: number;
-    sprite: string;
-    vtt: string;
-};
+export interface ThumbnailsPluginSettings 
 ```
+
+## Remarks
+
+Example of a VTT file:
+
+```text
+1
+00:00:00,000 --> 00:00:10,000
+3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56
+
+2
+00:00:10,000 --> 00:00:20,000
+3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56
+
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[backdropHeight?](./player.thumbnailspluginsettings.backdropheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[backdropMaxOpacity?](./player.thumbnailspluginsettings.backdropmaxopacity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[backdropMinOpacity?](./player.thumbnailspluginsettings.backdropminopacity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[spotlightHeight?](./player.thumbnailspluginsettings.spotlightheight.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[sprite](./player.thumbnailspluginsettings.sprite.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[vtt](./player.thumbnailspluginsettings.vtt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The VTT file to use for the thumbnails.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.thumbnailspluginsettings.spotlightheight.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [spotlightHeight](./player.thumbnailspluginsettings.spotlightheight.md)
+
+## ThumbnailsPluginSettings.spotlightHeight property
+
+**Signature:**
+
+```typescript
+spotlightHeight?: number;
+```

package/docs/api/player.thumbnailspluginsettings.sprite.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [sprite](./player.thumbnailspluginsettings.sprite.md)
+
+## ThumbnailsPluginSettings.sprite property
+
+**Signature:**
+
+```typescript
+sprite: string;
+```

package/docs/api/player.thumbnailspluginsettings.vtt.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ThumbnailsPluginSettings](./player.thumbnailspluginsettings.md) &gt; [vtt](./player.thumbnailspluginsettings.vtt.md)
+
+## ThumbnailsPluginSettings.vtt property
+
+The VTT file to use for the thumbnails.
+
+**Signature:**
+
+```typescript
+vtt: string;
+```

package/lib/plugins/thumbnails/Thumbnails.d.ts

@@ -3,15 +3,30 @@ import '../../../assets/thumbnails/style.scss';
 /**
  * Plugin configuration options for the thumbnails plugin.
  * @public
+ * @remarks
+ * Example of a VTT file:
+ * ```text
+ * 1
+ * 00:00:00,000 --> 00:00:10,000
+ * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56
+ *
+ * 2
+ * 00:00:10,000 --> 00:00:20,000
+ * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56
+ *
+ * ```
  */
-export type ThumbnailsPluginSettings = {
+export interface ThumbnailsPluginSettings {
     backdropHeight?: number;
     backdropMaxOpacity?: number;
     backdropMinOpacity?: number;
     spotlightHeight?: number;
     sprite: string;
+    /**
+     * The VTT file to use for the thumbnails.
+     */
     vtt: string;
-};
+}
 /**
  * `PLUGIN` that displays the thumbnails of the video when available.
  * @public
@@ -38,6 +53,7 @@ export type ThumbnailsPluginSettings = {
  *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
  *   },
  * })
+
  * ```
  */
 export declare class Thumbnails extends UICorePlugin {

package/lib/plugins/thumbnails/Thumbnails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Thumbnails.d.ts","sourceRoot":"","sources":["../../../src/plugins/thumbnails/Thumbnails.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAKZ,IAAI,EACL,MAAM,cAAc,CAAA;AAUrB,OAAO,uCAAuC,CAAA;AAM9C;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,qBAAqB,CAAoB;IAEjD,OAAO,CAAC,iBAAiB,CAAY;IAErC,OAAO,CAAC,gBAAgB,CAAY;IAEpC,OAAO,CAAC,aAAa,CAAI;IAEzB,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,YAAY,CAAQ;IAE5B,OAAO,CAAC,eAAe,CAAI;IAE3B,OAAO,CAAC,cAAc,CAAI;IAE1B,OAAO,CAAC,MAAM,CAAsB;IAEpC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;gBAE3C,IAAI,EAAE,IAAI;IAgBtB,OAAO,CAAC,iBAAiB;IAiCzB;;OAEG;IACM,UAAU;IAInB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,WAAW;YAmDL,eAAe;IAO7B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,IAAI;IAaZ,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,YAAY;IAkBpB,OAAO,CAAC,OAAO;IAUf,OAAO,CAAC,cAAc;IAuEtB,OAAO,CAAC,oBAAoB;IAiD5B,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,WAAW;IAgBnB,OAAO,KAAK,YAAY,GAMvB;IAEQ,MAAM;CAShB"}
+{"version":3,"file":"Thumbnails.d.ts","sourceRoot":"","sources":["../../../src/plugins/thumbnails/Thumbnails.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAKZ,IAAI,EACL,MAAM,cAAc,CAAA;AAUrB,OAAO,uCAAuC,CAAA;AAM9C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,UAAW,SAAQ,YAAY;IAC1C,OAAO,CAAC,qBAAqB,CAAoB;IAEjD,OAAO,CAAC,iBAAiB,CAAY;IAErC,OAAO,CAAC,gBAAgB,CAAY;IAEpC,OAAO,CAAC,aAAa,CAAI;IAEzB,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,YAAY,CAAQ;IAE5B,OAAO,CAAC,eAAe,CAAI;IAE3B,OAAO,CAAC,cAAc,CAAI;IAE1B,OAAO,CAAC,MAAM,CAAsB;IAEpC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;gBAE3C,IAAI,EAAE,IAAI;IAgBtB,OAAO,CAAC,iBAAiB;IAiCzB;;OAEG;IACM,UAAU;IAInB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,WAAW;YAmDL,eAAe;IAO7B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,IAAI;IAaZ,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,YAAY;IAkBpB,OAAO,CAAC,OAAO;IAUf,OAAO,CAAC,cAAc;IAuEtB,OAAO,CAAC,oBAAoB;IAiD5B,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,WAAW;IAgBnB,OAAO,KAAK,YAAY,GAMvB;IAEQ,MAAM;CAShB"}

package/lib/plugins/thumbnails/Thumbnails.js

@@ -33,6 +33,7 @@ const T = 'plugins.thumbnails';
  *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
  *   },
  * })
+
  * ```
  */
 export class Thumbnails extends UICorePlugin {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gcorevideo/player",
-  "version": "2.26.7",
+  "version": "2.26.9",
   "description": "Gcore JavaScript video player",
   "main": "dist/index.js",
   "type": "module",

package/src/plugins/thumbnails/Thumbnails.ts

@@ -24,13 +24,28 @@ import { loadImageDimensions } from './utils.js'
 /**
  * Plugin configuration options for the thumbnails plugin.
  * @public
+ * @remarks
+ * Example of a VTT file:
+ * ```text
+ * 1
+ * 00:00:00,000 --> 00:00:10,000
+ * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=0,0,100,56
+ *
+ * 2
+ * 00:00:10,000 --> 00:00:20,000
+ * 3dk4NsRt6vWsffEr_sprite.jpg#xywh=100,0,100,56
+ *
+ * ```
  */
-export type ThumbnailsPluginSettings = {
+export interface ThumbnailsPluginSettings {
   backdropHeight?: number
   backdropMaxOpacity?: number
   backdropMinOpacity?: number
   spotlightHeight?: number
   sprite: string
+  /**
+   * The VTT file to use for the thumbnails.
+   */
   vtt: string
 }
 
@@ -73,6 +88,7 @@ const T = 'plugins.thumbnails'
  *      'https://static.gvideo.co/videoplatform/sprites/2675/2452164_3dk4NsRt6vWsffEr.mp4_sprite.jpg',
  *   },
  * })
+
  * ```
  */
 export class Thumbnails extends UICorePlugin {
@@ -257,7 +273,7 @@ export class Thumbnails extends UICorePlugin {
   private mount() {
     const mediaControl = this.core.getPlugin('media_control') as MediaControl
     mediaControl.$el.find('.seek-time').css('bottom', 56) // TODO check the offset
-    mediaControl.$el.first().after(this.$el);
+    mediaControl.$el.first().after(this.$el)
   }
 
   private onMouseMoveSeekbar(_: MouseEvent, pos: number) {
@@ -279,7 +295,8 @@ export class Thumbnails extends UICorePlugin {
     $ref?: ZeptoResult,
   ) {
     const scaleFactor = height / thumb.h
-    const $container = $ref && $ref.length ? $ref : $('<div />').addClass('thumbnail-container')
+    const $container =
+      $ref && $ref.length ? $ref : $('<div />').addClass('thumbnail-container')
 
     $container.css('width', thumb.w * scaleFactor)
     $container.css('height', height)