@gcorevideo/player 2.16.17 → 2.18.0

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,62 @@ 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>
+
+[isDvrInUse()](./player.player.isdvrinuse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Indicates whether DVR is in use.
+
+
+</td></tr>
+<tr><td>
+
+[isPlaying()](./player.player.isplaying.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Indicates the playing state.
+
+
 </td></tr>
 <tr><td>
 
@@ -153,7 +207,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 +221,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 +310,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 +349,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 +365,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,12 +7,12 @@
 > 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:**
 
 ```typescript
-off<T extends PlayerEvent>(event: T, handler: PlayerEventHandler<T>): void;
+off<E extends PlayerEvent>(event: E, handler: PlayerEventHandler<E>): void;
 ```
 
 ## Parameters
@@ -40,7 +40,7 @@ event
 
 </td><td>
 
-T
+E
 
 
 </td><td>
@@ -56,12 +56,12 @@ handler
 
 </td><td>
 
-[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;T&gt;
+[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;E&gt;
 
 
 </td><td>
 
-See [PlayerEventHandler](./player.playereventhandler.md)
+a callback attached earlier to that event type
 
 
 </td></tr>

package/docs/api/player.player.on.md

@@ -12,7 +12,7 @@ Adds a listener to a player event
 **Signature:**
 
 ```typescript
-on<T extends PlayerEvent>(event: T, handler: PlayerEventHandler<T>): void;
+on<E extends PlayerEvent>(event: E, handler: PlayerEventHandler<E>): void;
 ```
 
 ## Parameters
@@ -40,12 +40,12 @@ event
 
 </td><td>
 
-T
+E
 
 
 </td><td>
 
-See [PlayerEvent](./player.playerevent.md)
+event type, see [PlayerEvent](./player.playerevent.md)
 
 
 </td></tr>
@@ -56,12 +56,12 @@ handler
 
 </td><td>
 
-[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;T&gt;
+[PlayerEventHandler](./player.playereventhandler.md)<!-- -->&lt;E&gt;
 
 
 </td><td>
 
-See [PlayerEventHandler](./player.playereventhandler.md)
+a callback function to handle the event
 
 
 </td></tr>

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

@@ -12,10 +12,7 @@ Resizes the player container element and everything within it.
 **Signature:**
 
 ```typescript
-resize(newSize: {
-        width: number;
-        height: number;
-    }): void;
+resize(newSize: ContainerSize): void;
 ```
 
 ## Parameters
@@ -43,7 +40,7 @@ newSize
 
 </td><td>
 
-{ width: number; height: number; }
+[ContainerSize](./player.containersize.md)
 
 
 </td><td>
@@ -57,3 +54,7 @@ new size of the player
 
 void
 
+## Remarks
+
+Use this method when the player itself does not detect properly 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/docs/api/player.playercomponenttype.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlayerComponentType](./player.playercomponenttype.md)
+
+## PlayerComponentType type
+
+> 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.
+> 
+
+Subsystems of a player component.
+
+**Signature:**
+
+```typescript
+export type PlayerComponentType = 'container' | 'core' | 'playback';
+```

package/docs/api/player.playerdebugsettings.md

@@ -16,5 +16,5 @@ export type PlayerDebugSettings = PlayerDebugTag | boolean;
 
 ## Remarks
 
-true is equivalent to 'all', false is equivalent to 'none'
+`true` is equivalent to `'all'`<!-- -->, `false` is equivalent to `'none'`
 

package/docs/api/player.playerdebugtag.md

@@ -7,6 +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.
 > 
 
+Debug output category selector
 
 **Signature:**
 

package/docs/api/player.playerevent.md

@@ -48,6 +48,38 @@ Ended
 **_(BETA)_** Playback has reached the end of the media.
 
 
+</td></tr>
+<tr><td>
+
+Error
+
+
+</td><td>
+
+`"error"`
+
+
+</td><td>
+
+**_(BETA)_** An error occurred. Parameters: [PlaybackError](./player.playbackerror.md)
+
+
+</td></tr>
+<tr><td>
+
+Fullscreen
+
+
+</td><td>
+
+`"fullscreen"`
+
+
+</td><td>
+
+**_(BETA)_** The player has switched to or from the fullscreen mode. Parameters:`boolean` isFullscreen
+
+
 </td></tr>
 <tr><td>
 
@@ -96,6 +128,38 @@ Ready
 **_(BETA)_** The player is ready to use.
 
 
+</td></tr>
+<tr><td>
+
+Resize
+
+
+</td><td>
+
+`"resize"`
+
+
+</td><td>
+
+**_(BETA)_** The player's container has been resized. Parameters: [ContainerSize](./player.containersize.md)
+
+
+</td></tr>
+<tr><td>
+
+Seek
+
+
+</td><td>
+
+`"seek"`
+
+
+</td><td>
+
+**_(BETA)_** The player is seeking to a new position.
+
+
 </td></tr>
 <tr><td>
 
@@ -112,5 +176,37 @@ Stop
 **_(BETA)_** Playback has been stopped.
 
 
+</td></tr>
+<tr><td>
+
+TimeUpdate
+
+
+</td><td>
+
+`"timeupdate"`
+
+
+</td><td>
+
+**_(BETA)_** The current playback time has changed. Parameters: [TimePosition](./player.timeposition.md)
+
+
+</td></tr>
+<tr><td>
+
+VolumeUpdate
+
+
+</td><td>
+
+`"volumeupdate"`
+
+
+</td><td>
+
+**_(BETA)_** The volume has changed. Parameters: `number` volume in the range 0..1
+
+
 </td></tr>
 </tbody></table>

package/docs/api/player.playereventhandler.md

@@ -7,11 +7,12 @@
 > 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.
 > 
 
+Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
 
 **Signature:**
 
 ```typescript
-export type PlayerEventHandler<T extends PlayerEvent> = () => void;
+export type PlayerEventHandler<E extends PlayerEvent> = (...args: PlayerEventParams<E>) => void;
 ```
-**References:** [PlayerEvent](./player.playerevent.md)
+**References:** [PlayerEvent](./player.playerevent.md)<!-- -->, [PlayerEventParams](./player.playereventparams.md)
 

package/docs/api/player.playereventparams.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; [PlayerEventParams](./player.playereventparams.md)
+
+## PlayerEventParams type
+
+> 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.
+> 
+
+
+**Signature:**
+
+```typescript
+export type PlayerEventParams<E extends PlayerEvent> = E extends PlayerEvent.Seek ? [number] : E extends PlayerEvent.VolumeUpdate ? [number] : E extends PlayerEvent.TimeUpdate ? [TimePosition] : E extends PlayerEvent.Resize ? [{
+    width: number;
+    height: number;
+}] : E extends PlayerEvent.Fullscreen ? [boolean] : E extends PlayerEvent.Error ? [PlaybackError] : [];
+```
+**References:** [PlayerEvent](./player.playerevent.md)<!-- -->, [PlayerEvent.Seek](./player.playerevent.md)<!-- -->, [PlayerEvent.VolumeUpdate](./player.playerevent.md)<!-- -->, [PlayerEvent.TimeUpdate](./player.playerevent.md)<!-- -->, [TimePosition](./player.timeposition.md)<!-- -->, [PlayerEvent.Resize](./player.playerevent.md)<!-- -->, [PlayerEvent.Fullscreen](./player.playerevent.md)<!-- -->, [PlayerEvent.Error](./player.playerevent.md)<!-- -->, [PlaybackError](./player.playbackerror.md)
+

package/docs/api/player.playermediasourcedesc.md

@@ -57,7 +57,7 @@ string
 
 </td><td>
 
-**_(BETA)_** _(Optional)_ The MIME type of the media source (e.g. "video/mp4", "application/x-mpegURL")
+**_(BETA)_** _(Optional)_ The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
 
 
 </td></tr>

package/docs/api/player.playermediasourcedesc.mimetype.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.
 > 
 
-The MIME type of the media source (e.g. "video/mp4", "application/x-mpegURL")
+The MIME type of the media source (e.g. `"video/mp4"`<!-- -->, `"application/x-mpegURL"`<!-- -->). Necessary if the type cannot be detected from file extension of the source URL.
 
 **Signature:**
 

package/docs/api/player.qualitylevel.bitrate.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevel](./player.qualitylevel.md) &gt; [bitrate](./player.qualitylevel.bitrate.md)
+
+## QualityLevel.bitrate property
+
+> 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.
+> 
+
+Bitrate of the video, bps.
+
+**Signature:**
+
+```typescript
+bitrate: number;
+```

package/docs/api/player.qualitylevel.height.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevel](./player.qualitylevel.md) &gt; [height](./player.qualitylevel.height.md)
+
+## QualityLevel.height property
+
+> 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.
+> 
+
+Height of the video, pixels.
+
+**Signature:**
+
+```typescript
+height: number;
+```

package/docs/api/player.qualitylevel.level.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevel](./player.qualitylevel.md) &gt; [level](./player.qualitylevel.level.md)
+
+## QualityLevel.level property
+
+> 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.
+> 
+
+Zero-based index of the quality level.
+
+**Signature:**
+
+```typescript
+level: number;
+```