@gcorevideo/player 2.16.17 → 2.18.0

package/docs/api/player.md

@@ -4,11 +4,11 @@
 
 ## player package
 
-Video player for the GCore streaming platform
+Video player for the Gcore streaming platform
 
 ## Remarks
 
-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.
+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.
 
 ## Classes
 
@@ -56,7 +56,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Codes of errors occurring within the playback component.
 
 
 </td></tr>
@@ -119,7 +119,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** An error occurred during the playback.
 
 
 </td></tr>
@@ -144,6 +144,28 @@ Description
 **_(BETA)_** Describes a media source with its MIME type and URL.
 
 
+</td></tr>
+<tr><td>
+
+[QualityLevel](./player.qualitylevel.md)
+
+
+</td><td>
+
+**_(BETA)_** A level of quality within a media source.
+
+
+</td></tr>
+<tr><td>
+
+[TimePosition](./player.timeposition.md)
+
+
+</td><td>
+
+**_(BETA)_** Current playback time and total duration of the media.
+
+
 </td></tr>
 </tbody></table>
 
@@ -162,12 +184,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ContainerSize](./player.containersize.md)
+
+
+</td><td>
+
+**_(BETA)_** Dimensions of the player container DOM element.
+
+
+</td></tr>
+<tr><td>
+
 [DashSettings](./player.dashsettings.md)
 
 
 </td><td>
 
-**_(BETA)_** [DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)
+**_(BETA)_** A plain JS object that must conform to the DASH.js settings schema.
+
+[DASH.js settings](https://cdn.dashjs.org/latest/jsdoc/module-Settings.html)
 
 
 </td></tr>
@@ -178,7 +213,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Levels of severity of errors. Non-fatal errors usually can be ignored.
 
 
 </td></tr>
@@ -189,7 +224,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** An ISO 639-1 language code.
 
 
 </td></tr>
@@ -200,7 +235,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Media delivery protocol
 
 
 </td></tr>
@@ -211,7 +246,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Module to perform the playback.
 
 
 </td></tr>
@@ -228,18 +263,18 @@ Description
 </td></tr>
 <tr><td>
 
-[PlayerDebugSettings](./player.playerdebugsettings.md)
+[PlayerComponentType](./player.playercomponenttype.md)
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Subsystems of a player component.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerDebugTag](./player.playerdebugtag.md)
+[PlayerDebugSettings](./player.playerdebugsettings.md)
 
 
 </td><td>
@@ -250,29 +285,29 @@ Description
 </td></tr>
 <tr><td>
 
-[PlayerEventHandler](./player.playereventhandler.md)
+[PlayerDebugTag](./player.playerdebugtag.md)
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Debug output category selector
 
 
 </td></tr>
 <tr><td>
 
-[PlayerMediaSource](./player.playermediasource.md)
+[PlayerEventHandler](./player.playereventhandler.md)
 
 
 </td><td>
 
-**_(BETA)_** A media source to fetch the media data from
+**_(BETA)_** Type of a listener callback function for a player event. See the description of the event parameters in [PlayerEvent](./player.playerevent.md)<!-- -->.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerPlugin](./player.playerplugin.md)
+[PlayerEventParams](./player.playereventparams.md)
 
 
 </td><td>
@@ -283,23 +318,23 @@ Description
 </td></tr>
 <tr><td>
 
-[QualityLevel](./player.qualitylevel.md)
+[PlayerMediaSource](./player.playermediasource.md)
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** A media source to fetch the media data from
 
 
 </td></tr>
 <tr><td>
 
-[TimePosition](./player.timeposition.md)
+[PlayerPlugin](./player.playerplugin.md)
 
 
 </td><td>
 
-**_(BETA)_** For the plugin development
+**_(BETA)_**
 
 
 </td></tr>
@@ -332,7 +367,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Playback time in seconds since the beginning of the stream (or a segment for the live streams) For the plugin development
+**_(BETA)_** Playback time in seconds since the beginning of the stream (or a segment for the live streams)
 
 
 </td></tr>
@@ -354,7 +389,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** \[language\]\[key\] =<!-- -->&gt; string
+**_(BETA)_** Localization strings for the player UI.
 
 
 </td></tr>
@@ -365,7 +400,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Preferred media delivery protocol
 
 
 </td></tr>

package/docs/api/player.mediatransport.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.
 > 
 
+Media delivery protocol
 
 **Signature:**
 

package/docs/api/player.playbackerror.code.md

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Error code.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.playbackerror.description.md

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Detailed description of the error.
+
 **Signature:**
 
 ```typescript

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

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Level of severity of the error.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.playbackerror.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.
 > 
 
+An error occurred during the playback.
 
 **Signature:**
 
@@ -52,7 +53,7 @@ Description
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Error code.
 
 
 </td></tr>
@@ -71,7 +72,7 @@ string
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Detailed description of the error.
 
 
 </td></tr>
@@ -90,7 +91,7 @@ string
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Level of severity of the error.
 
 
 </td></tr>
@@ -109,7 +110,45 @@ string
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** Error message. Non-fatal usually can be ignored.
+
+
+</td></tr>
+<tr><td>
+
+[origin](./player.playbackerror.origin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** Exact component that originated the error.
+
+
+</td></tr>
+<tr><td>
+
+[scope](./player.playbackerror.scope.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerComponentType](./player.playercomponenttype.md)
+
+
+</td><td>
+
+**_(BETA)_** Component subsystem of the error origin
 
 
 </td></tr>

package/docs/api/player.playbackerror.message.md

@@ -7,6 +7,8 @@
 > 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.
 > 
 
+Error message. Non-fatal usually can be ignored.
+
 **Signature:**
 
 ```typescript

package/docs/api/player.playbackerror.origin.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [PlaybackError](./player.playbackerror.md) &gt; [origin](./player.playbackerror.origin.md)
+
+## PlaybackError.origin 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.
+> 
+
+Exact component that originated the error.
+
+**Signature:**
+
+```typescript
+origin: string;
+```
+
+## Example
+
+- 'core' - 'dash' - 'media\_control'
+

package/docs/api/player.playbackerror.scope.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; [PlaybackError](./player.playbackerror.md) &gt; [scope](./player.playbackerror.scope.md)
+
+## PlaybackError.scope 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.
+> 
+
+Component subsystem of the error origin
+
+**Signature:**
+
+```typescript
+scope: PlayerComponentType;
+```

package/docs/api/player.playbackerrorcode.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.
 > 
 
+Codes of errors occurring within the playback component.
 
 **Signature:**
 
@@ -44,39 +45,39 @@ Generic
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** An unknown or uncategorised error.
 
 
 </td></tr>
 <tr><td>
 
-MediaSourceUnavailable
+MediaSourceAccessDenied
 
 
 </td><td>
 
-`1`
+`3`
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** The media source is not accessible due to some protection policy.
 
 
 </td></tr>
 <tr><td>
 
-QualityLevelUnavailable
+MediaSourceUnavailable
 
 
 </td><td>
 
-`2`
+`1`
 
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** The media source is not available. Typically a network error.
 
 
 </td></tr>

package/docs/api/player.playbackmodule.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.
 > 
 
+Module to perform the playback.
 
 **Signature:**
 

package/docs/api/player.player.attachto.md

@@ -54,3 +54,29 @@ DOM element to host the player
 
 void
 
+## 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 [Player.destroy()](./player.player.destroy.md) and then [Player.attachTo()](./player.player.attachto.md)<!-- -->.
+
+## 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'))
+})
+```
+

package/docs/api/player.player.configure.md

@@ -9,8 +9,6 @@
 
 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).
-
 **Signature:**
 
 ```typescript
@@ -56,3 +54,9 @@ complete or partial configuration
 
 void
 
+## 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).
+

package/docs/api/player.player.destroy.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.
 > 
 
-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.
 
 **Signature:**
 

package/docs/api/player.player.getcurrenttime.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.
 > 
 
-Current playback time in seconds, if appropriate.
+Current playback (time since the beginning of the stream), if appropriate.
 
 **Signature:**
 
@@ -18,5 +18,9 @@ getCurrentTime(): number;
 
 number
 
-For live streams, it returns the current time of the current segment.
+Time in seconds
+
+## Remarks
+
+For live streams, it returns the current time within the current segment.
 

package/docs/api/player.player.getduration.md

@@ -18,5 +18,9 @@ getDuration(): number;
 
 number
 
+Time in seconds
+
+## Remarks
+
 For live streams, it returns the duration of the current segment.
 

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.isdvrinuse.md

@@ -0,0 +1,24 @@
+<!-- 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; [isDvrInUse](./player.player.isdvrinuse.md)
+
+## Player.isDvrInUse() 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 in use.
+
+**Signature:**
+
+```typescript
+isDvrInUse(): boolean;
+```
+**Returns:**
+
+boolean
+
+## Remarks
+
+DVR mode, if it is enabled, is triggered we a user seeks behind the live edge.
+

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.
+
+**Signature:**
+
+```typescript
+isPlaying(): boolean;
+```
+**Returns:**
+
+boolean
+