@gcorevideo/player 2.22.15 → 2.22.17

package/docs/api/player.md

@@ -45,7 +45,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[AudioSelector](./player.audioselector.md)
+[AudioTracks](./player.audiotracks.md)
 
 
 </td><td>
@@ -75,17 +75,6 @@ Description
 **_(BETA)_** `PLUGIN` that adds a button to extend the media controls UI with extra options.
 
 
-</td></tr>
-<tr><td>
-
-[ClapprNerdStats](./player.clapprnerdstats.md)
-
-
-</td><td>
-
-**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
-
-
 </td></tr>
 <tr><td>
 
@@ -94,7 +83,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that collects useful statistics about playback performance.
+**_(BETA)_** `PLUGIN` that measures data about playback, which can be useful for analyzing performance and UX.
 
 
 </td></tr>
@@ -111,12 +100,12 @@ Description
 </td></tr>
 <tr><td>
 
-[ClipsPlugin](./player.clipsplugin.md)
+[Clips](./player.clips.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that shows text over the seekbar to indicate the current clip.
+**_(BETA)_** `PLUGIN` that allows marking up the timeline of the video
 
 
 </td></tr>
@@ -188,45 +177,45 @@ Description
 </td></tr>
 <tr><td>
 
-[LevelSelector](./player.levelselector.md)
+[Logo](./player.logo.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that provides a UI to select the desired quality level of the playback.
+**_(BETA)_** `PLUGIN` that adds custom logo to the player.
 
 
 </td></tr>
 <tr><td>
 
-[Logo](./player.logo.md)
+[MediaControl](./player.mediacontrol.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that adds custom logo to the player.
+**_(BETA)_** `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
 
 
 </td></tr>
 <tr><td>
 
-[MediaControl](./player.mediacontrol.md)
+[MultiCamera](./player.multicamera.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that provides basic playback controls UI and a foundation for developing custom UI.
+**_(BETA)_** `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
 
 
 </td></tr>
 <tr><td>
 
-[MultiCamera](./player.multicamera.md)
+[NerdStats](./player.nerdstats.md)
 
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that adds support for loading multiple streams and switching between them using the media control UI.
+**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
 
 
 </td></tr>
@@ -273,6 +262,17 @@ Description
 **_(BETA)_** `PLUGIN` that displays a poster image in the background and a big play button on top when playback is stopped
 
 
+</td></tr>
+<tr><td>
+
+[QualityLevels](./player.qualitylevels.md)
+
+
+</td><td>
+
+**_(BETA)_** `PLUGIN` that provides a UI to select the desired quality level of the playback.
+
+
 </td></tr>
 <tr><td>
 
@@ -491,7 +491,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Configuration options for the [clips](./player.clipsplugin.md) plugin.
+**_(BETA)_** Configuration options for the  plugin.
 
 
 </td></tr>
@@ -530,56 +530,56 @@ Description
 </td></tr>
 <tr><td>
 
-[LevelSelectorPluginSettings](./player.levelselectorpluginsettings.md)
+[PlaybackError](./player.playbackerror.md)
 
 
 </td><td>
 
-**_(BETA)_** Configuration options for the [level selector](./player.levelselector.md) plugin.
+An error occurred during the playback.
 
 
 </td></tr>
 <tr><td>
 
-[PlaybackError](./player.playbackerror.md)
+[PlayerConfig](./player.playerconfig.md)
 
 
 </td><td>
 
-An error occurred during the playback.
+Configuration options for the player
 
 
 </td></tr>
 <tr><td>
 
-[PlayerConfig](./player.playerconfig.md)
+[PlayerMediaSourceDesc](./player.playermediasourcedesc.md)
 
 
 </td><td>
 
-Configuration options for the player
+Describes a media source with its MIME type and URL.
 
 
 </td></tr>
 <tr><td>
 
-[PlayerMediaSourceDesc](./player.playermediasourcedesc.md)
+[QualityLevel](./player.qualitylevel.md)
 
 
 </td><td>
 
-Describes a media source with its MIME type and URL.
+A level of quality within a media source/representation.
 
 
 </td></tr>
 <tr><td>
 
-[QualityLevel](./player.qualitylevel.md)
+[QualityLevelsPluginSettings](./player.qualitylevelspluginsettings.md)
 
 
 </td><td>
 
-A level of quality within a media source.
+**_(BETA)_** Configuration options for the [QualityLevels](./player.qualitylevels.md) plugin.
 
 
 </td></tr>
@@ -655,6 +655,15 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ClapprStatsSettings](./player.clapprstatssettings.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
 [ClosedCaptionsPluginSettings](./player.closedcaptionspluginsettings.md)
 
 
@@ -759,7 +768,62 @@ An ISO 639-1 language code.
 
 </td><td>
 
-**_(BETA)_** Media control elements, mount points for additional plugins
+**_(BETA)_** Built-in media control elements.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlLayerElement](./player.mediacontrollayerelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in main layer, spanning the entire width of the player.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlLeftElement](./player.mediacontrolleftelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in the left area.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlRightElement](./player.mediacontrolrightelement.md)
+
+
+</td><td>
+
+**_(BETA)_** Media control elements that appear in the right area.
+
+
+</td></tr>
+<tr><td>
+
+[MediaControlSettings](./player.mediacontrolsettings.md)
+
+
+</td><td>
+
+**_(BETA)_** Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.
+
+
+</td></tr>
+<tr><td>
+
+[MenuOption](./player.menuoption.md)
+
+
+</td><td>
+
+**_(BETA)_**
 
 
 </td></tr>
@@ -940,7 +1004,7 @@ A media source to fetch the media data from
 
 </td><td>
 
-**_(BETA)_** For the plugin development
+**_(BETA)_** Time progress information indicated by Clappr CONTAINER\_PROGRESS and PLAYBACK\_PROGRESS events.
 
 
 </td></tr>
@@ -962,7 +1026,7 @@ A media source to fetch the media data from
 
 </td><td>
 
-Playback time in seconds since the beginning of the stream (or a segment for the live streams)
+Playback time position in seconds since the beginning of the stream. For the live streams this is limited to the length of a segment. When DVR is enabled, this refers to the
 
 
 </td></tr>

package/docs/api/player.mediacontrol.md

@@ -20,6 +20,14 @@ export declare class MediaControl extends UICorePlugin
 
 The methods exposed are to be used by the other plugins that extend the media control UI.
 
+Configuration options:
+
+- `mediaControl`<!-- -->: [MediaControlSettings](./player.mediacontrolsettings.md) - specifies the allowed media control elements in each area
+
+- `persistConfig`<!-- -->: boolean - `common` option, makes the plugin persist the media control settings
+
+- `chromeless`<!-- -->: boolean
+
 ## Constructors
 
 <table><thead><tr><th>
@@ -218,7 +226,7 @@ Description
 </td></tr>
 <tr><td>
 
-[getElement(name)](./player.mediacontrol.getelement.md)
+[mount(name, element)](./player.mediacontrol.mount.md)
 
 
 </td><td>
@@ -229,20 +237,6 @@ Description
 **_(BETA)_** Get a media control element DOM node
 
 
-</td></tr>
-<tr><td>
-
-[handleCustomArea(handler)](./player.mediacontrol.handlecustomarea.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(BETA)_**
-
-
 </td></tr>
 <tr><td>
 

package/docs/api/{player.mediacontrol.getelement.md → player.mediacontrol.mount.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [getElement](./player.mediacontrol.getelement.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControl](./player.mediacontrol.md) &gt; [mount](./player.mediacontrol.mount.md)
 
-## MediaControl.getElement() method
+## MediaControl.mount() 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.
 > 
@@ -17,7 +17,7 @@ Get a media control element DOM node
 **Signature:**
 
 ```typescript
-getElement(name: MediaControlElement): ZeptoResult | null;
+mount(name: MediaControlElement, element: ZeptoResult): void;
 ```
 
 ## Parameters
@@ -53,11 +53,25 @@ name
 The name of the media control element
 
 
+</td></tr>
+<tr><td>
+
+element
+
+
+</td><td>
+
+[ZeptoResult](./player.zeptoresult.md)
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 **Returns:**
 
-[ZeptoResult](./player.zeptoresult.md) \| null
+void
 
 The DOM node to render to or extend
 
@@ -71,9 +85,8 @@ Use this method to render custom media control UI in a plugin
 ```ts
 class MyPlugin extends UICorePlugin {
   override render() {
-    const mediaControl = this.core.getPlugin('media_control')
-    const clipText = mediaControl.getElement('clipText')
-    clipText?.el.text('Here we go')
+    this.$el.html('<div data-clips>Here we go</div>')
+    this.core.getPlugin('media_control').mount('clips', this.$el)
     return this
   }
 }

package/docs/api/player.mediacontrolelement.md

@@ -7,10 +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.
 > 
 
-Media control elements, mount points for additional plugins
+Built-in media control elements.
 
 **Signature:**
 
 ```typescript
-export type MediaControlElement = 'audiotracks' | 'cc' | 'clipText' | 'dvr' | 'duration' | 'fullscreen' | 'gear' | 'multicamera' | 'pip' | 'playbackRate' | 'position' | 'seekBarContainer' | 'vr' | 'volume';
+export type MediaControlElement = MediaControlLeftElement | MediaControlLayerElement | MediaControlRightElement;
 ```
+**References:** [MediaControlLeftElement](./player.mediacontrolleftelement.md)<!-- -->, [MediaControlLayerElement](./player.mediacontrollayerelement.md)<!-- -->, [MediaControlRightElement](./player.mediacontrolrightelement.md)
+

package/docs/api/player.mediacontrollayerelement.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; [MediaControlLayerElement](./player.mediacontrollayerelement.md)
+
+## MediaControlLayerElement 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.
+> 
+
+Media control elements that appear in main layer, spanning the entire width of the player.
+
+**Signature:**
+
+```typescript
+export type MediaControlLayerElement = 'seekbar' | 'seekBarContainer';
+```

package/docs/api/player.mediacontrolleftelement.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; [MediaControlLeftElement](./player.mediacontrolleftelement.md)
+
+## MediaControlLeftElement 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.
+> 
+
+Media control elements that appear in the left area.
+
+**Signature:**
+
+```typescript
+export type MediaControlLeftElement = 'clipText' | 'duration' | 'dvr' | 'playpause' | 'playstop' | 'position' | 'volume' | 'clips';
+```

package/docs/api/player.mediacontrolrightelement.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; [MediaControlRightElement](./player.mediacontrolrightelement.md)
+
+## MediaControlRightElement 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.
+> 
+
+Media control elements that appear in the right area.
+
+**Signature:**
+
+```typescript
+export type MediaControlRightElement = 'audiotracks' | 'cc' | 'fullscreen' | 'hd-indicator' | 'gear' | 'multicamera' | 'pip' | 'vr';
+```

package/docs/api/player.mediacontrolsettings.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [MediaControlSettings](./player.mediacontrolsettings.md)
+
+## MediaControlSettings 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.
+> 
+
+Specifies the allowed media control elements in each area. Can be used to restrict rendered media control elements.
+
+**Signature:**
+
+```typescript
+export type MediaControlSettings = {
+    left: MediaControlLeftElement[];
+    right: MediaControlRightElement[];
+    default: MediaControlLayerElement[];
+    seekEnabled: boolean;
+};
+```
+**References:** [MediaControlLeftElement](./player.mediacontrolleftelement.md)<!-- -->, [MediaControlRightElement](./player.mediacontrolrightelement.md)<!-- -->, [MediaControlLayerElement](./player.mediacontrollayerelement.md)
+

package/docs/api/player.menuoption.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; [MenuOption](./player.menuoption.md)
+
+## MenuOption 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 MenuOption = {
+    label?: string;
+    labelKey?: string;
+    name: string;
+    handler?: () => void;
+    icon?: string;
+};
+```

package/docs/api/{player.clapprnerdstats._constructor_.md → player.nerdstats._constructor_.md}

@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprNerdStats](./player.clapprnerdstats.md) &gt; [(constructor)](./player.clapprnerdstats._constructor_.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [NerdStats](./player.nerdstats.md) &gt; [(constructor)](./player.nerdstats._constructor_.md)
 
-## ClapprNerdStats.(constructor)
+## NerdStats.(constructor)
 
 > 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.
 > 
 
-Constructs a new instance of the `ClapprNerdStats` class
+Constructs a new instance of the `NerdStats` class
 
 **Signature:**
 

package/docs/api/{player.clapprnerdstats.md → player.nerdstats.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprNerdStats](./player.clapprnerdstats.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [NerdStats](./player.nerdstats.md)
 
-## ClapprNerdStats class
+## NerdStats class
 
 > 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.
 > 
@@ -12,7 +12,7 @@
 **Signature:**
 
 ```typescript
-export declare class ClapprNerdStats extends UICorePlugin 
+export declare class NerdStats extends UICorePlugin 
 ```
 **Extends:** UICorePlugin
 
@@ -48,7 +48,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(core)](./player.clapprnerdstats._constructor_.md)
+[(constructor)(core)](./player.nerdstats._constructor_.md)
 
 
 </td><td>
@@ -56,7 +56,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Constructs a new instance of the `ClapprNerdStats` class
+**_(BETA)_** Constructs a new instance of the `NerdStats` class
 
 
 </td></tr>

package/docs/api/player.playbackrate.md

@@ -41,7 +41,7 @@ const player = new Player({
       { value: 1, label: '1x' },
     ],
     defaultValue: 1,
-  } as PlaybackRateSettings,
+  },
 })
 ```
 

package/docs/api/player.playerconfig.md

@@ -199,7 +199,7 @@ _(Optional)_ Mute the audio output in order to comply with browsers' autoplay po
 
 </td><td>
 
-_(Optional)_ The type of playback (live stream or video on demand).
+_(Optional)_ Stream type.  Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
 
 
 </td></tr>

package/docs/api/player.playerconfig.playbacktype.md

@@ -4,7 +4,7 @@
 
 ## PlayerConfig.playbackType property
 
-The type of playback (live stream or video on demand).
+Stream type.  Should only be set if known in advance, as it should not change once determined. Otherwise it might cause inconsistencies in the UI plugins behavior, for instance, glitches with rendering of the DVR controls or seek bar.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## QualityLevel.height property
 
-Height of the video, pixels.
+Height of the video frame, pixels.
 
 **Signature:**
 

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

@@ -4,7 +4,7 @@
 
 ## QualityLevel.level property
 
-Zero-based index of the quality level.
+Zero-based index of the quality level. Quality levels go from low to high
 
 **Signature:**
 

package/docs/api/player.qualitylevel.md

@@ -4,7 +4,7 @@
 
 ## QualityLevel interface
 
-A level of quality within a media source.
+A level of quality within a media source/representation.
 
 **Signature:**
 
@@ -69,7 +69,7 @@ number
 
 </td><td>
 
-Height of the video, pixels.
+Height of the video frame, pixels.
 
 
 </td></tr>
@@ -88,7 +88,7 @@ number
 
 </td><td>
 
-Zero-based index of the quality level.
+Zero-based index of the quality level. Quality levels go from low to high
 
 
 </td></tr>
@@ -107,7 +107,7 @@ number
 
 </td><td>
 
-Width of the video, pixels.
+Width of the video frame, pixels.
 
 
 </td></tr>

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

@@ -4,7 +4,7 @@
 
 ## QualityLevel.width property
 
-Width of the video, pixels.
+Width of the video frame, pixels.
 
 **Signature:**
 

package/docs/api/{player.levelselector.events.md → player.qualitylevels.events.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [LevelSelector](./player.levelselector.md) &gt; [events](./player.levelselector.events.md)
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [QualityLevels](./player.qualitylevels.md) &gt; [events](./player.qualitylevels.events.md)
 
-## LevelSelector.events property
+## QualityLevels.events 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.
 >