@gcorevideo/player 2.16.17 → 2.17.0

package/docs/api/player.player.getvolume.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [getVolume](./player.player.getvolume.md)
+
+## Player.getVolume() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Gets the current volume of the media content being played.
+
+**Signature:**
+
+```typescript
+getVolume(): number;
+```
+**Returns:**
+
+number
+
+a number between 0 and 1
+

package/docs/api/player.player.isdvrenabled.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [isDvrEnabled](./player.player.isdvrenabled.md)
+
+## Player.isDvrEnabled() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Indicates whether DVR is enabled.
+
+**Signature:**
+
+```typescript
+isDvrEnabled(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/api/player.player.isplaying.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [isPlaying](./player.player.isplaying.md)
+
+## Player.isPlaying() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Indicates the playing state of the player.
+
+**Signature:**
+
+```typescript
+isPlaying(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/api/player.player.md

@@ -97,8 +97,6 @@ Description
 
 **_(BETA)_** Configures the player.
 
-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).
-
 
 </td></tr>
 <tr><td>
@@ -111,7 +109,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Destroys the player, releasing all resources and removing any DOM elements added.
+**_(BETA)_** Destroys the player, releasing all resources and unmounting its UI from the DOM.
 
 
 </td></tr>
@@ -125,7 +123,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Current playback time in seconds, if appropriate.
+**_(BETA)_** Current playback (time since the beginning of the stream), if appropriate.
 
 
 </td></tr>
@@ -142,6 +140,48 @@ Can be called multiple times. Each consequent call extends the previous configur
 **_(BETA)_** Duration of the current media in seconds, if appropriate.
 
 
+</td></tr>
+<tr><td>
+
+[getVolume()](./player.player.getvolume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Gets the current volume of the media content being played.
+
+
+</td></tr>
+<tr><td>
+
+[isDvrEnabled()](./player.player.isdvrenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Indicates whether DVR is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[isPlaying()](./player.player.isplaying.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Indicates the playing state of the player.
+
+
 </td></tr>
 <tr><td>
 
@@ -153,7 +193,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Mutes the player.
+**_(BETA)_** Mutes the sound of the video.
 
 
 </td></tr>
@@ -167,7 +207,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Removes a listener from a player event
+**_(BETA)_** Removes a previously added event listener
 
 
 </td></tr>
@@ -256,6 +296,20 @@ Can be called multiple times. Each consequent call extends the previous configur
 **_(BETA)_** Seeks to the given time.
 
 
+</td></tr>
+<tr><td>
+
+[setVolume(volume)](./player.player.setvolume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Sets the current volume of the media content being played.
+
+
 </td></tr>
 <tr><td>
 
@@ -281,7 +335,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Unmutes the player.
+**_(BETA)_** Unmutes the video sound.
 
 
 </td></tr>
@@ -297,7 +351,7 @@ Can be called multiple times. Each consequent call extends the previous configur
 
 </td><td>
 
-**_(BETA)_** Unregisters a plugin.
+**_(BETA)_** Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.player.registerplugin.md)<!-- -->.
 
 
 </td></tr>

package/docs/api/player.player.mute.md

@@ -7,7 +7,7 @@
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
-Mutes the player.
+Mutes the sound of the video.
 
 **Signature:**
 

package/docs/api/player.player.off.md

@@ -7,7 +7,7 @@
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
-Removes a listener from a player event
+Removes a previously added event listener
 
 **Signature:**
 

package/docs/api/player.player.registerplugin.md

@@ -45,7 +45,7 @@ plugin
 
 </td><td>
 
-plugin to register
+a plugin class
 
 
 </td></tr>
@@ -54,3 +54,16 @@ plugin to register
 
 void
 
+## Remarks
+
+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.
+
+## Example
+
+
+```ts
+import MyPlugin from './MyPlugin.js'
+
+Player.registerPlugin(MyPlugin)
+```
+

package/docs/api/player.player.resize.md

@@ -57,3 +57,7 @@ new size of the player
 
 void
 
+## Remarks
+
+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.
+

package/docs/api/player.player.seek.md

@@ -45,7 +45,7 @@ number
 
 </td><td>
 
-time to seek to in seconds
+time to seek to in seconds (since the beginning of the stream)
 
 
 </td></tr>

package/docs/api/player.player.setvolume.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Player](./player.player.md) &gt; [setVolume](./player.player.setvolume.md)
+
+## Player.setVolume() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Sets the current volume of the media content being played.
+
+**Signature:**
+
+```typescript
+setVolume(volume: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+volume
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+a number between 0 and 1
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/api/player.player.unmute.md

@@ -7,7 +7,7 @@
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
-Unmutes the player.
+Unmutes the video sound.
 
 **Signature:**
 

package/docs/api/player.player.unregisterplugin.md

@@ -7,7 +7,7 @@
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
-Unregisters a plugin.
+Unregisters a plugin registered earlier with [Player.registerPlugin()](./player.player.registerplugin.md)<!-- -->.
 
 **Signature:**
 
@@ -45,7 +45,7 @@ plugin
 
 </td><td>
 
-plugin to unregister
+a plugin class
 
 
 </td></tr>

package/lib/Player.d.ts

@@ -32,7 +32,7 @@ export declare class Player {
      */
     on<T extends PlayerEvent>(event: T, handler: PlayerEventHandler<T>): void;
     /**
-     * Removes a listener from a player event
+     * Removes a previously added event listener
      * @param event - See {@link PlayerEvent}
      * @param handler - See {@link PlayerEventHandler}
      */
@@ -40,37 +40,76 @@ export declare class Player {
     /**
      * Configures the player.
      *
-     * 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).
-     *
      * @param config - complete or partial configuration
+     * @remarks
+     * Can be called multiple times.
+     * Each consequent call extends the previous configuration with only the new keys overridden.
+     *
+     * After a reconfiguration, if something significant has changed, it might make sense reinitialize the player (i.e, a `.destroy()` followed by an `.init()` call).
      */
     configure(config: Partial<PlayerConfig>): void;
     /**
      * Initializes the player at the given container element.
      * @param playerElement - DOM element to host the player
+     * @remarks
+     * The player will be initialized and attached to the given element.
+     *
+     * All the core plugins will be initialized at this point.
+     *
+     * If no sources were configured, it will trigger an error.
+     *
+     * The player container will be initialized and then all the registered UI plugins.
+     *
+     * If the `autoPlay` option is set, then it will trigger playback immediately.
+     *
+     * 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}.
+     *
+     * @example
+     * ```ts
+     * const player = new Player({
+     *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
+     * })
+     * document.addEventListener('DOMContentLoaded', () => {
+     *   player.attachTo(document.getElementById('video-container'))
+     * })
+     * ```
      */
     attachTo(playerElement: HTMLElement): void;
     /**
-     * Destroys the player, releasing all resources and removing any DOM elements added.
+     * Destroys the player, releasing all resources and unmounting its UI from the DOM.
      */
     destroy(): void;
     /**
-     * Current playback time in seconds, if appropriate.
-     * @returns For live streams, it returns the current time of the current segment.
+     * Current playback (time since the beginning of the stream), if appropriate.
+     *
+     * @returns Time in seconds
+     * @remarks
+     * For live streams, it returns the current time within the current segment.
      */
     getCurrentTime(): number;
     /**
      * Duration of the current media in seconds, if appropriate.
-     * @returns For live streams, it returns the duration of the current segment.
+     *
+     * @returns Time in seconds
+     * @remarks
+     * For live streams, it returns the duration of the current segment.
      */
     getDuration(): number;
     /**
-     * Mutes the player.
+     * Indicates whether DVR is enabled.
+     */
+    isDvrEnabled(): boolean;
+    /**
+     * Indicates the playing state of the player.
+     */
+    isPlaying(): boolean;
+    /**
+     * Mutes the sound of the video.
      */
     mute(): void;
     /**
-     * Unmutes the player.
+     * Unmutes the video sound.
      */
     unmute(): void;
     /**
@@ -84,6 +123,9 @@ export declare class Player {
     /**
      * Resizes the player container element and everything within it.
      * @param newSize - new size of the player
+     * @remarks
+     * 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.
      */
     resize(newSize: {
         width: number;
@@ -91,21 +133,44 @@ export declare class Player {
     }): void;
     /**
      * Seeks to the given time.
-     * @param time - time to seek to in seconds
+     * @param time - time to seek to in seconds (since the beginning of the stream)
      */
     seek(time: number): void;
+    /**
+     * Gets the current volume of the media content being played.
+     * @returns a number between 0 and 1
+     */
+    getVolume(): number;
+    /**
+     * Sets the current volume of the media content being played.
+     * @param volume - a number between 0 and 1
+     */
+    setVolume(volume: number): void;
     /**
      * Stops playback.
      */
     stop(): void;
     /**
      * Registers a plugin.
-     * @param plugin - plugin to register
+     * @param plugin - a plugin class
+     * @remarks
+     * 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.
+     *
+     * @see {@link https://github.com/clappr/clappr/wiki/Architecture}
+     * @example
+     * ```ts
+     * import MyPlugin from './MyPlugin.js'
+     *
+     * Player.registerPlugin(MyPlugin)
+     * ```
      */
     static registerPlugin(plugin: PlayerPlugin): void;
     /**
-     * Unregisters a plugin.
-     * @param plugin - plugin to unregister
+     * Unregisters a plugin registered earlier with {@link Player.registerPlugin}.
+     * @param plugin - a plugin class
      */
     static unregisterPlugin(plugin: PlayerPlugin): void;
     private setConfig;

package/lib/Player.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Player.d.ts","sourceRoot":"","sources":["../src/Player.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAyB,YAAY,EAAE,MAAM,YAAY,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAQtD;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,WAAW,IAAI,MAAM,IAAI,CAAA;AAelE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,aAAa,CAAA;AAI3D;;;;;;;GAOG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAgC;IAE9C,OAAO,CAAC,OAAO,CAAkB;IAEjC,OAAO,CAAC,MAAM,CAA4B;IAE1C,OAAO,CAAC,KAAK,CAAQ;IAErB,OAAO,CAAC,QAAQ,CAA2B;IAE3C,OAAO,CAAC,aAAa,CAA6C;IAElE,OAAO,CAAC,OAAO,CAAQ;gBAEX,MAAM,EAAE,YAAY;IAOhC;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAIlE;;;;OAIG;IACH,GAAG,CAAC,CAAC,SAAS,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAInE;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAIvC;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,WAAW,GAAG,IAAI;IAoB1C;;OAEG;IACH,OAAO;IAgBP;;;OAGG;IACH,cAAc,IAAI,MAAM;IAOxB;;;OAGG;IACH,WAAW,IAAI,MAAM;IAOrB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,MAAM;IAIN;;OAEG;IACH,KAAK;IAIL;;OAEG;IACH,IAAI;IAIJ;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAIjD;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM;IAIjB;;OAEG;IACH,IAAI;IAIJ;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY;IAI1C;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,YAAY;IAI5C,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,UAAU;YAqBJ,MAAM;IAwEpB,OAAO,CAAC,MAAM,CAiDb;IAED,OAAO,CAAC,gBAAgB;IAyCxB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,2BAA2B;CAcpC"}
+{"version":3,"file":"Player.d.ts","sourceRoot":"","sources":["../src/Player.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAyB,YAAY,EAAE,MAAM,YAAY,CAAA;AACrE,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAOtD;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,WAAW,IAAI,MAAM,IAAI,CAAA;AAelE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,aAAa,CAAA;AAI3D;;;;;;;GAOG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAgC;IAE9C,OAAO,CAAC,OAAO,CAAkB;IAEjC,OAAO,CAAC,MAAM,CAA4B;IAE1C,OAAO,CAAC,KAAK,CAAQ;IAErB,OAAO,CAAC,QAAQ,CAA2B;IAE3C,OAAO,CAAC,aAAa,CAA6C;IAElE,OAAO,CAAC,OAAO,CAAQ;gBAEX,MAAM,EAAE,YAAY;IAOhC;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAIlE;;;;OAIG;IACH,GAAG,CAAC,CAAC,SAAS,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAInE;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC;IAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,aAAa,EAAE,WAAW,GAAG,IAAI;IAoB1C;;OAEG;IACH,OAAO;IAgBP;;;;;;OAMG;IACH,cAAc,IAAI,MAAM;IAOxB;;;;;;OAMG;IACH,WAAW,IAAI,MAAM;IAOrB;;OAEG;IACH,YAAY,IAAI,OAAO;IAIvB;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,IAAI;IAIJ;;OAEG;IACH,MAAM;IAIN;;OAEG;IACH,KAAK;IAIL;;OAEG;IACH,IAAI;IAIJ;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAIjD;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM;IAIjB;;;OAGG;IACH,SAAS,IAAI,MAAM;IAMnB;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM;IAMxB;;OAEG;IACH,IAAI;IAIJ;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY;IAI1C;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,YAAY;IAI5C,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,UAAU;YAqBJ,MAAM;IAwEpB,OAAO,CAAC,MAAM,CAiDb;IAED,OAAO,CAAC,gBAAgB;IAyCxB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,2BAA2B;CAcpC"}