@gcorevideo/player 2.22.18 → 2.22.20

package/docs/api/player.clapprstatschronograph.md

@@ -0,0 +1,115 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsChronograph](./player.clapprstatschronograph.md)
+
+## ClapprStatsChronograph enum
+
+> 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 declare enum ClapprStatsChronograph 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Buffering
+
+
+</td><td>
+
+`"buffering"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Pause
+
+
+</td><td>
+
+`"pause"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Session
+
+
+</td><td>
+
+`"session"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Startup
+
+
+</td><td>
+
+`"startup"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Watch
+
+
+</td><td>
+
+`"watch"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.clapprstatscounter.md

@@ -0,0 +1,211 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsCounter](./player.clapprstatscounter.md)
+
+## ClapprStatsCounter enum
+
+> 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 declare enum ClapprStatsCounter 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+Buffering
+
+
+</td><td>
+
+`"buffering"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+ChangeLevel
+
+
+</td><td>
+
+`"changeLevel"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+DecodedFrames
+
+
+</td><td>
+
+`"decodedFrames"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+DroppedFrames
+
+
+</td><td>
+
+`"droppedFrames"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+DvrUsage
+
+
+</td><td>
+
+`"dvrUsage"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Error
+
+
+</td><td>
+
+`"error"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Fps
+
+
+</td><td>
+
+`"fps"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Fullscreen
+
+
+</td><td>
+
+`"fullscreen"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Pause
+
+
+</td><td>
+
+`"pause"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Play
+
+
+</td><td>
+
+`"play"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+Seek
+
+
+</td><td>
+
+`"seek"`
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.clapprstatsevents.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsEvents](./player.clapprstatsevents.md)
+
+## ClapprStatsEvents enum
+
+> 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 declare enum ClapprStatsEvents 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+REPORT
+
+
+</td><td>
+
+`"clappr:stats:report"`
+
+
+</td><td>
+
+**_(BETA)_** Emitted periodically with current measurements.
+
+
+</td></tr>
+</tbody></table>

package/docs/api/player.clapprstatsmetrics.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [ClapprStatsMetrics](./player.clapprstatsmetrics.md)
+
+## ClapprStatsMetrics 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 ClapprStatsMetrics = {
+    counters: {
+        [ClapprStatsCounter.Play]: number;
+        [ClapprStatsCounter.Pause]: number;
+        [ClapprStatsCounter.Error]: number;
+        [ClapprStatsCounter.Buffering]: number;
+        [ClapprStatsCounter.DecodedFrames]: number;
+        [ClapprStatsCounter.DroppedFrames]: number;
+        [ClapprStatsCounter.Fps]: number;
+        [ClapprStatsCounter.ChangeLevel]: number;
+        [ClapprStatsCounter.Seek]: number;
+        [ClapprStatsCounter.Fullscreen]: number;
+        [ClapprStatsCounter.DvrUsage]: number;
+    };
+    chrono: {
+        [ClapprStatsChronograph.Startup]: number;
+        [ClapprStatsChronograph.Watch]: number;
+        [ClapprStatsChronograph.Pause]: number;
+        [ClapprStatsChronograph.Buffering]: number;
+        [ClapprStatsChronograph.Session]: number;
+    };
+    extra: {
+        playbackName: string;
+        playbackType: string;
+        bitratesHistory: BitrateTrackRecord[];
+        bitrateWeightedMean: number;
+        bitrateMostUsed: number;
+        buffersize: number;
+        watchHistory: Array<[number, number]>;
+        watchedPercentage: number;
+        bufferingPercentage: number;
+        bandwidth: number;
+        duration: number;
+        currentTime: number;
+    };
+};
+```
+**References:** [ClapprStatsCounter.Play](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Pause](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Error](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Buffering](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DecodedFrames](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DroppedFrames](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Fps](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.ChangeLevel](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Seek](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.Fullscreen](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsCounter.DvrUsage](./player.clapprstatscounter.md)<!-- -->, [ClapprStatsChronograph.Startup](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Watch](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Pause](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Buffering](./player.clapprstatschronograph.md)<!-- -->, [ClapprStatsChronograph.Session](./player.clapprstatschronograph.md)<!-- -->, [BitrateTrackRecord](./player.bitratetrackrecord.md)
+

package/docs/api/player.clipspluginsettings.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.
 > 
 
-Configuration options for the  plugin.
+Configuration options for the [Clips](./player.clips.md) plugin.
 
 **Signature:**
 

package/docs/api/player.md

@@ -215,7 +215,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** `PLUGIN` that displays useful network-related statistics.
+**_(BETA)_** `PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.
 
 
 </td></tr>
@@ -379,6 +379,39 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[ClapprStatsChronograph](./player.clapprstatschronograph.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClapprStatsCounter](./player.clapprstatscounter.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClapprStatsEvents](./player.clapprstatsevents.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
 [GearEvents](./player.gearevents.md)
 
 
@@ -491,7 +524,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Configuration options for the  plugin.
+**_(BETA)_** Configuration options for the [Clips](./player.clips.md) plugin.
 
 
 </td></tr>
@@ -655,6 +688,28 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[BitrateTrackRecord](./player.bitratetrackrecord.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[ClapprStatsMetrics](./player.clapprstatsmetrics.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
 [ClapprStatsSettings](./player.clapprstatssettings.md)
 
 

package/docs/api/player.nerdstats.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.
 > 
 
-`PLUGIN` that displays useful network-related statistics.
+`PLUGIN` that displays useful statistics regarding the playback as well as the network quality estimation.
 
 **Signature:**
 
@@ -20,9 +20,9 @@ export declare class NerdStats extends UICorePlugin
 
 Depends on:
 
-- [BottomGear](./player.bottomgear.md)
+- [BottomGear](./player.bottomgear.md) - where the button is attached
 
-- [ClapprStats](./player.clapprstats.md)
+- [ClapprStats](./player.clapprstats.md) - to get the metrics from
 
 The plugin is rendered as an item in the gear menu.
 

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)_ 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.
+_(Optional)_ Stream type.
 
 
 </td></tr>

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

@@ -4,10 +4,15 @@
 
 ## PlayerConfig.playbackType property
 
-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.
+Stream type.
 
 **Signature:**
 
 ```typescript
 playbackType?: PlaybackType;
 ```
+
+## Remarks
+
+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.
+

package/docs/api/player.timeupdate.md

@@ -7,14 +7,17 @@
 > 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.
 > 
 
+> Warning: This API is now obsolete.
+> 
+> Use TimePosition instead
+> 
+
 For the plugin development
 
 **Signature:**
 
 ```typescript
-export type TimeUpdate = TimePosition & {
-    firstFragDateTime: number;
-};
+export type TimeUpdate = TimePosition;
 ```
 **References:** [TimePosition](./player.timeposition.md)
 

package/lib/plugins/audio-selector/AudioSelector.d.ts

@@ -60,7 +60,7 @@ export declare class AudioTracks extends UICorePlugin {
     private buttonElementText;
     private trackElement;
     private getTitle;
-    private startTrackSwitch;
+    private startTrackSwitching;
     private updateText;
     private highlightCurrentTrack;
 }

package/lib/plugins/audio-selector/AudioSelector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AudioSelector.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio-selector/AudioSelector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAY,MAAM,cAAc,CAAA;AAO7D,OAAO,2CAA2C,CAAA;AASlD;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,YAAY,CAA0B;IAE9C,OAAO,CAAC,MAAM,CAAmB;IAEjC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IASnB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,wBAAwB;IAwBhC,OAAO,CAAC,YAAY;IAMpB;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,qBAAqB;CAW9B"}
+{"version":3,"file":"AudioSelector.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio-selector/AudioSelector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAY,MAAM,cAAc,CAAA;AAO7D,OAAO,2CAA2C,CAAA;AAUlD;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,YAAY,CAA0B;IAE9C,OAAO,CAAC,MAAM,CAAmB;IAEjC;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,MAAM,KAAK,OAAO,WAEjB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,UAAU;;MAItB;IAED;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IASnB,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,wBAAwB;IAwBhC,OAAO,CAAC,YAAY;IAMpB;;OAEG;IACM,MAAM;IAmBf,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,qBAAqB;CAe9B"}

package/lib/plugins/audio-selector/AudioSelector.js

@@ -4,6 +4,7 @@ import { CLAPPR_VERSION } from '../../build.js';
 import pluginHtml from '../../../assets/audio-selector/track-selector.ejs';
 import '../../../assets/audio-selector/style.scss';
 import audioArrow from '../../../assets/icons/old/quality-arrow.svg';
+// import { trace } from '@gcorevideo/utils'
 const VERSION = '2.22.4';
 // const T = 'plugins.audiotracks'
 /**
@@ -66,7 +67,7 @@ export class AudioTracks extends UICorePlugin {
         const mediaControl = this.core.getPlugin('media_control');
         assert(mediaControl, 'media_control plugin is required');
         this.listenTo(mediaControl, Events.MEDIACONTROL_RENDERED, () => {
-            mediaControl.putElement('audiotracks', this.$el);
+            mediaControl.mount('audiotracks', this.$el);
         });
         this.listenTo(mediaControl, Events.MEDIACONTROL_HIDE, this.hideMenu);
     }
@@ -97,18 +98,18 @@ export class AudioTracks extends UICorePlugin {
         if (!this.shouldRender()) {
             return this;
         }
-        const mediaControl = this.core.getPlugin('media_control');
         this.$el.html(AudioTracks.template({
             tracks: this.tracks,
             title: this.getTitle(),
             icon: audioArrow,
+            current: this.currentTrack?.id,
         }));
         this.updateText();
         this.highlightCurrentTrack();
         return this;
     }
     onTrackSelect(event) {
-        const id = event.target?.dataset?.audiotracksSelect;
+        const id = event.currentTarget?.dataset?.audiotracksSelect;
         if (id) {
             this.selectAudioTrack(id);
         }
@@ -117,7 +118,7 @@ export class AudioTracks extends UICorePlugin {
         return false;
     }
     selectAudioTrack(id) {
-        this.startTrackSwitch();
+        this.startTrackSwitching();
         this.core.activeContainer.switchAudioTrack(id);
         this.updateText();
     }
@@ -125,7 +126,9 @@ export class AudioTracks extends UICorePlugin {
         this.$el.find('#audiotracks-select').addClass('hidden');
     }
     toggleContextMenu() {
-        this.$el.find('#audiotracks-select').toggleClass('hidden');
+        this.$el.find('#audiotracks-select').toggleClass('hidden'); // TODO use plain CSS display: none
+        const open = !this.$el.find('#audiotracks-select').hasClass('hidden'); // TODO hold state
+        this.$el.find('#audiotracks-button').attr('aria-expanded', open);
     }
     buttonElement() {
         return this.$('button');
@@ -143,7 +146,7 @@ export class AudioTracks extends UICorePlugin {
         }
         return this.currentTrack.label || this.currentTrack.language;
     }
-    startTrackSwitch() {
+    startTrackSwitching() {
         this.buttonElement().addClass('changing');
     }
     updateText() {
@@ -154,12 +157,16 @@ export class AudioTracks extends UICorePlugin {
     }
     highlightCurrentTrack() {
         this.trackElement().removeClass('current');
-        this.trackElement().find('a').removeClass('gcore-skin-active');
+        this.trackElement()
+            .find('a')
+            .removeClass('gcore-skin-active')
+            .attr('aria-checked', 'false');
         if (this.currentTrack) {
             this.trackElement(this.currentTrack.id)
                 .addClass('current')
                 .find('a')
-                .addClass('gcore-skin-active');
+                .addClass('gcore-skin-active')
+                .attr('aria-checked', 'true');
         }
     }
 }