@gcorevideo/player 2.17.0 → 2.18.0

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,7 +45,7 @@ Generic
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** An unknown or uncategorised error.
 
 
 </td></tr>
@@ -60,7 +61,7 @@ MediaSourceAccessDenied
 
 </td><td>
 
-**_(BETA)_**
+**_(BETA)_** The media source is not accessible due to some protection policy.
 
 
 </td></tr>
@@ -76,7 +77,7 @@ MediaSourceUnavailable
 
 </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.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

@@ -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.
 > 
 
-Indicates the playing state of the player.
+Indicates the playing state.
 
 **Signature:**
 

package/docs/api/player.player.md

@@ -168,6 +168,20 @@ Description
 **_(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>
 
@@ -179,7 +193,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Indicates the playing state of the player.
+**_(BETA)_** Indicates the playing state.
 
 
 </td></tr>

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

@@ -12,7 +12,7 @@ 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.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>
@@ -59,5 +56,5 @@ 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.
+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.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;
+```