@gcorevideo/player 2.20.9 → 2.20.12

package/docs/api/player.telemetry.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 collects and reports the performance statistics.
+`PLUGIN` that collects and reports the performance statistics.
 
 **Signature:**
 

package/docs/api/player.thumbnails.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.
 > 
 
-Displays the thumbnails of the video when available.
+`PLUGIN` that displays the thumbnails of the video when available.
 
 **Signature:**
 

package/docs/api/player.timeposition.current.md

@@ -4,9 +4,6 @@
 
 ## TimePosition.current 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.
-> 
-
 Current playback time, 0..duration, seconds.
 
 **Signature:**

package/docs/api/player.timeposition.md

@@ -4,9 +4,6 @@
 
 ## TimePosition interface
 
-> 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 and total duration of the media.
 
 **Signature:**
@@ -53,7 +50,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Current playback time, 0..duration, seconds.
+Current playback time, 0..duration, seconds.
 
 
 </td></tr>
@@ -72,7 +69,7 @@ Description
 
 </td><td>
 
-**_(BETA)_** Total duration of the media, seconds.
+Total duration of the media, seconds.
 
 
 </td></tr>

package/docs/api/player.timeposition.total.md

@@ -4,9 +4,6 @@
 
 ## TimePosition.total 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.
-> 
-
 Total duration of the media, seconds.
 
 **Signature:**

package/docs/api/player.timevalue.md

@@ -4,9 +4,6 @@
 
 ## TimeValue 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.
-> 
-
 Playback time in seconds since the beginning of the stream (or a segment for the live streams)
 
 **Signature:**

package/docs/api/player.translationkey.md

@@ -4,9 +4,6 @@
 
 ## TranslationKey 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:**
 

package/docs/api/player.translationsettings.md

@@ -4,9 +4,6 @@
 
 ## TranslationSettings 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.
-> 
-
 Localization strings for the player UI.
 
 **Signature:**

package/docs/api/player.transportpreference.md

@@ -4,15 +4,10 @@
 
 ## TransportPreference 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.
-> 
-
-Preferred media delivery protocol
+Preferred streaming media delivery protocol
 
 **Signature:**
 
 ```typescript
-export type TransportPreference = MediaTransport;
+export type TransportPreference = 'dash' | 'hls';
 ```
-**References:** [MediaTransport](./player.mediatransport.md)
-

package/docs/api/player.volumefade.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.
 > 
 
-Applies fade effect to the player's volume change.
+`PLUGIN` that applies fade effect to the player's volume change.
 
 **Signature:**
 

package/lib/Player.d.ts

@@ -2,7 +2,7 @@ import type { ContainerSize, PlayerPluginConstructor } from './types.js';
 import { PlayerConfig, PlayerEvent } from './types.js';
 import { PlaybackError, TimePosition } from './playback.types.js';
 /**
- * @beta
+ * @public
  */
 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;
@@ -11,17 +11,17 @@ export type PlayerEventParams<E extends PlayerEvent> = E extends PlayerEvent.See
 /**
  * Type of a listener callback function for a player event.
  * See the description of the event parameters in {@link PlayerEvent}.
- * @beta
+ * @public
  */
 export type PlayerEventHandler<E extends PlayerEvent> = (...args: PlayerEventParams<E>) => void;
 /**
  * Module to perform the playback.
- * @beta
+ * @public
  */
 export type PlaybackModule = 'dash' | 'hls' | 'html5_video';
 /**
- * The main component to use in the application code.
- * @beta
+ * `MAIN` component to use in the application code.
+ * @public
  * @remarks
  * The Player object provides very basic API to control playback.
  * To build a sophisticated UI, use the plugins framework to tap into the Clappr core.

package/lib/Player.js

@@ -17,8 +17,8 @@ const DEFAULT_OPTIONS = {
     strings: {},
 };
 /**
- * The main component to use in the application code.
- * @beta
+ * `MAIN` component to use in the application code.
+ * @public
  * @remarks
  * The Player object provides very basic API to control playback.
  * To build a sophisticated UI, use the plugins framework to tap into the Clappr core.

package/lib/index.d.ts

@@ -3,9 +3,26 @@
  *
  * @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.
+ * It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations.
  * Start with {@link Player} for more information.
  *
+ * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
+ * @example
+ * ```ts
+ * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(MediaControl)
+ * Player.registerPlugin(ErrorScreen)
+ *
+ * const player = new Player({
+ *   autoPlay: true,
+ *   mute: true,
+ *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
+ * })
+ *
+ * player.attachTo(document.getElementById('container'))
+ * ```
+ *
  * @packageDocumentation
  */
 export * from './index.core.js';

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA"}

package/lib/index.js

@@ -3,9 +3,26 @@
  *
  * @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.
+ * It is built on top of the {@link https://github.com/clappr/clappr | Clappr} library and provides a framework for building custom integrations.
  * Start with {@link Player} for more information.
  *
+ * Various plugins (marked with `PLUGIN` keyword) are available to extend the player with additional features.
+ * @example
+ * ```ts
+ * import { Player, MediaControl, ErrorScreen } from '@gcorevideo/player'
+ *
+ * Player.registerPlugin(MediaControl)
+ * Player.registerPlugin(ErrorScreen)
+ *
+ * const player = new Player({
+ *   autoPlay: true,
+ *   mute: true,
+ *   sources: [{ source: 'https://example.com/a.mpd', mimeType: 'application/dash+xml' }],
+ * })
+ *
+ * player.attachTo(document.getElementById('container'))
+ * ```
+ *
  * @packageDocumentation
  */
 export * from './index.core.js';

package/lib/playback.types.d.ts

@@ -1,11 +1,11 @@
 /**
  * Playback time in seconds since the beginning of the stream (or a segment for the live streams)
- * @beta
+ * @public
  */
 export type TimeValue = number;
 /**
  * Current playback time and total duration of the media.
- * @beta
+ * @public
  */
 export interface TimePosition {
     /**
@@ -33,7 +33,7 @@ export type TimeUpdate = TimePosition & {
 };
 /**
  * A level of quality within a media source.
- * @beta
+ * @public
  */
 export interface QualityLevel {
     /**
@@ -55,7 +55,7 @@ export interface QualityLevel {
 }
 /**
  * Codes of errors occurring within the playback component.
- * @beta
+ * @public
  */
 export declare enum PlaybackErrorCode {
     /**
@@ -73,17 +73,17 @@ export declare enum PlaybackErrorCode {
 }
 /**
  * Levels of severity of errors. Non-fatal errors usually can be ignored.
- * @beta
+ * @public
  */
 export type ErrorLevel = 'FATAL' | 'WARN' | 'INFO';
 /**
  * Subsystems of a player component.
- * @beta
+ * @public
  */
 export type PlayerComponentType = 'container' | 'core' | 'playback';
 /**
  * An error occurred during the playback.
- * @beta
+ * @public
  */
 export interface PlaybackError {
     /**
@@ -120,6 +120,7 @@ export interface PlaybackError {
     UI?: {
         title: string;
         message: string;
+        icon?: string;
     };
 }
 //# sourceMappingURL=playback.types.d.ts.map

package/lib/playback.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playback.types.d.ts","sourceRoot":"","sources":["../src/playback.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG;IACtC,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,OAAO,kBAAkB;IACzB;;OAEG;IACH,sBAAsB,6BAA6B;IACnD;;OAEG;IACH,uBAAuB,+BAA+B;CACvD;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;AAElD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,CAAA;AAEnE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAA;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAA;IAE1B;;OAEG;IACH,EAAE,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF"}
+{"version":3,"file":"playback.types.d.ts","sourceRoot":"","sources":["../src/playback.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;IAClB;;OAEG;IACH,KAAK,EAAE,SAAS,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,YAAY,GAAG;IACtC,iBAAiB,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,OAAO,kBAAkB;IACzB;;OAEG;IACH,sBAAsB,6BAA6B;IACnD;;OAEG;IACH,uBAAuB,+BAA+B;CACvD;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;AAElD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,CAAA;AAEnE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAA;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;IACjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,EAAE,mBAAmB,CAAA;IAE1B;;OAEG;IACH,EAAE,CAAC,EAAE;QACH,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;CACF"}

package/lib/playback.types.js

@@ -1,6 +1,6 @@
 /**
  * Codes of errors occurring within the playback component.
- * @beta
+ * @public
  */
 export var PlaybackErrorCode;
 (function (PlaybackErrorCode) {

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

@@ -2,7 +2,7 @@ import { UICorePlugin } from '@clappr/core';
 import { AudioTrackLoadedData, AudioTrackSwitchedData, Events as HlsEvents } from 'hls.js';
 import '../../../assets/audio-selector/style.scss';
 /**
- * Adds an audio track selector to the media control UI.
+ * `PLUGIN` that adds an audio track selector to the media control UI.
  * @beta
  */
 export declare class AudioSelector extends UICorePlugin {

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

@@ -9,7 +9,7 @@ const VERSION = '0.0.1';
 // const T = 'plugins.audio_selector';
 const AUTO = 0;
 /**
- * Adds an audio track selector to the media control UI.
+ * `PLUGIN` that adds an audio track selector to the media control UI.
  * @beta
  */
 export class AudioSelector extends UICorePlugin {

package/lib/plugins/big-mute-button/BigMuteButton.d.ts

@@ -1,7 +1,7 @@
 import { UICorePlugin } from '@clappr/core';
 import '../../../assets/big-mute-button/big-mute-button.scss';
 /**
- * Displays a big mute button over the video when it's muted.
+ * `PLUGIN` that displays a big mute button over the video when it's muted.
  * Once pressed, it unmutes the video.
  * @beta
  */

package/lib/plugins/big-mute-button/BigMuteButton.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BigMuteButton.d.ts","sourceRoot":"","sources":["../../../src/plugins/big-mute-button/BigMuteButton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAS,MAAM,cAAc,CAAA;AAQpE,OAAO,sDAAsD,CAAA;AAM7D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,qBAAqB,CAAQ;IAErC,OAAO,CAAC,YAAY,CAAQ;IAE5B,OAAO,CAAC,oBAAoB,CAA2B;IAEvD,OAAO,CAAC,cAAc,CAA2B;IAEjD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IAenB,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,YAAY;IAmBpB;;OAEG;IACM,MAAM;IAuBf,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;CAS9B"}
+{"version":3,"file":"BigMuteButton.d.ts","sourceRoot":"","sources":["../../../src/plugins/big-mute-button/BigMuteButton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,YAAY,EAAS,MAAM,cAAc,CAAA;AAQpE,OAAO,sDAAsD,CAAA;AAM7D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,OAAO,CAAC,qBAAqB,CAAQ;IAErC,OAAO,CAAC,YAAY,CAAQ;IAE5B,OAAO,CAAC,oBAAoB,CAA2B;IAEvD,OAAO,CAAC,cAAc,CAA2B;IAEjD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAEvD;;OAEG;IACH,IAAa,MAAM;;;MAKlB;IAED;;OAEG;IACM,UAAU;IAcnB,OAAO,CAAC,WAAW;IAkBnB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,YAAY;IAmBpB;;OAEG;IACM,MAAM;IAuBf,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;CAS9B"}

package/lib/plugins/big-mute-button/BigMuteButton.js

@@ -7,7 +7,7 @@ import '../../../assets/big-mute-button/big-mute-button.scss';
 const T = 'plugins.big_mute_button';
 // TODO rewrite as a container plugin
 /**
- * Displays a big mute button over the video when it's muted.
+ * `PLUGIN` that displays a big mute button over the video when it's muted.
  * Once pressed, it unmutes the video.
  * @beta
  */
@@ -42,7 +42,6 @@ export class BigMuteButton extends UICorePlugin {
      * @internal
      */
     bindEvents() {
-        super.bindEvents();
         this.listenTo(this.core, Events.CORE_READY, this.onCoreReady);
         this.listenTo(this.core, 'core:advertisement:start', this.onStartAd);
         this.listenTo(this.core, 'core:advertisement:finish', this.onFinishAd);

package/lib/plugins/bottom-gear/BottomGear.d.ts

@@ -8,7 +8,7 @@ import { ZeptoResult } from '../../types.js';
  */
 export type GearItemElement = 'quality' | 'rate' | 'nerd';
 /**
- * Adds the gear button that triggers extra options menu on the right side of the {@link MediaControl | media control} UI
+ * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI
  * @beta
  * @remarks
  * The plugins provides a base for attaching custom settings UI in the gear menu

package/lib/plugins/bottom-gear/BottomGear.js

@@ -11,7 +11,7 @@ import { MediaControlEvents } from '../media-control/MediaControl';
 const VERSION = '2.19.12';
 const T = 'plugins.bottom_gear';
 /**
- * Adds the gear button that triggers extra options menu on the right side of the {@link MediaControl | media control} UI
+ * `PLUGIN` that adds the gear button with an extra options menu on the right side of the {@link MediaControl | media control} UI
  * @beta
  * @remarks
  * The plugins provides a base for attaching custom settings UI in the gear menu

package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.d.ts

@@ -1,7 +1,7 @@
 import { UICorePlugin, Core } from '@clappr/core';
 import '../../../assets/clappr-nerd-stats/clappr-nerd-stats.scss';
 /**
- * PLUGIN that displays useful network-related statistics.
+ * `PLUGIN` that displays useful network-related statistics.
  * @beta
  *
  * @remarks

package/lib/plugins/clappr-nerd-stats/ClapprNerdStats.js

@@ -81,7 +81,7 @@ const drawSummary = (customMetrics, vodContainer, liveContainer) => {
 };
 // const T = 'plugins.clappr_nerd_stats';
 /**
- * PLUGIN that displays useful network-related statistics.
+ * `PLUGIN` that displays useful network-related statistics.
  * @beta
  *
  * @remarks

package/lib/plugins/clappr-stats/ClapprStats.d.ts

@@ -1,7 +1,7 @@
 import { Container, ContainerPlugin } from '@clappr/core';
 import type { Metrics, MetricsUpdateFn } from './types.js';
 /**
- * PLIGIN that collects useful statistics about playback performance.
+ * `PLUGIN` that collects useful statistics about playback performance.
  * @beta
  * @remarks
  * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.

package/lib/plugins/clappr-stats/ClapprStats.js

@@ -6,7 +6,7 @@ import { newMetrics } from './utils.js';
 // TODO: fix
 const updateMetrics = () => { };
 /**
- * PLIGIN that collects useful statistics about playback performance.
+ * `PLUGIN` that collects useful statistics about playback performance.
  * @beta
  * @remarks
  * This plugin does not render anything and is supposed to be extended or used together with other plugins that actually render something.

package/lib/plugins/click-to-pause/ClickToPause.d.ts

@@ -1,6 +1,6 @@
 import { ContainerPlugin } from '@clappr/core';
 /**
- * Adds a behavior of toggling the playback state on click over the container
+ * `PLUGIN` that adds a behavior of toggling the playback state on click over the container
  * @beta
  */
 export declare class ClickToPause extends ContainerPlugin {

package/lib/plugins/click-to-pause/ClickToPause.js

@@ -6,7 +6,7 @@ import { trace } from '@gcorevideo/utils';
 import { CLAPPR_VERSION } from '../../build.js';
 const T = 'plugins.click_to_pause_custom';
 /**
- * Adds a behavior of toggling the playback state on click over the container
+ * `PLUGIN` that adds a behavior of toggling the playback state on click over the container
  * @beta
  */
 export class ClickToPause extends ContainerPlugin {

package/lib/plugins/clips/Clips.d.ts

@@ -11,7 +11,7 @@ export interface ClipsPluginSettings {
     text: string;
 }
 /**
- * PLUGIN that shows text over the seekbar to indicate the current clip.
+ * `PLUGIN` that shows text over the seekbar to indicate the current clip.
  * @beta
  * @remarks
  * Depends on:

package/lib/plugins/clips/Clips.js

@@ -3,7 +3,7 @@ import { strtimeToMiliseconds } from '../utils.js';
 import '../../../assets/clips/clips.scss';
 import assert from 'assert';
 /**
- * PLUGIN that shows text over the seekbar to indicate the current clip.
+ * `PLUGIN` that shows text over the seekbar to indicate the current clip.
  * @beta
  * @remarks
  * Depends on:

package/lib/plugins/context-menu/ContextMenu.d.ts

@@ -1,7 +1,7 @@
 import { Container, UIContainerPlugin } from '@clappr/core';
 import '../../../assets/context-menu/context_menu.scss';
 /**
- * The plugin adds a context menu to the player.
+ * Context menu plugin settings
  * @beta
  */
 export interface ContextMenuPluginSettings {
@@ -10,7 +10,7 @@ export interface ContextMenuPluginSettings {
     preventShowContextMenu?: boolean;
 }
 /**
- * Displays a small context menu when clicked on the player container.
+ * `PLUGIN` that displays a small context menu when clicked on the player container.
  * @beta
  * @remarks
  * Configuration options - {@link ContextMenuPluginSettings}

package/lib/plugins/context-menu/ContextMenu.js

@@ -4,7 +4,7 @@ import '../../../assets/context-menu/context_menu.scss';
 import templateHtml from '../../../assets/context-menu/context_menu.ejs';
 import { version } from '../../version.js';
 /**
- * Displays a small context menu when clicked on the player container.
+ * `PLUGIN` that displays a small context menu when clicked on the player container.
  * @beta
  * @remarks
  * Configuration options - {@link ContextMenuPluginSettings}

package/lib/plugins/dvr-controls/DvrControls.d.ts

@@ -1,7 +1,7 @@
-import { Core, UICorePlugin } from '@clappr/core';
+import { UICorePlugin } from '@clappr/core';
 import '../../../assets/dvr-controls/dvr_controls.scss';
 /**
- * PLUGIN that adds the DVR controls to the media control UI
+ * `PLUGIN` that adds the DVR controls to the media control UI
  *
  * @beta
  *
@@ -10,7 +10,9 @@ import '../../../assets/dvr-controls/dvr_controls.scss';
  *
  * - {@link MediaControl}
  *
- * The plugin renders live stream indicator and the DVR seek bar, if DVR is enabled, in the media control UI.
+ * The plugin renders live stream indicator.
+ * If DVR is enabled, the indicator shows whether the current position is at the live edge of the stream or not.
+ * In the latter case, the indicator can be clicked to seek to the live edge.
  */
 export declare class DvrControls extends UICorePlugin {
     private static readonly template;
@@ -37,11 +39,11 @@ export declare class DvrControls extends UICorePlugin {
         class: string;
         'data-dvr-controls': string;
     };
-    constructor(core: Core);
     /**
      * @internal
      */
     bindEvents(): void;
+    private onCoreReady;
     private bindContainerEvents;
     private onDvrChanged;
     private click;

package/lib/plugins/dvr-controls/DvrControls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DvrControls.d.ts","sourceRoot":"","sources":["../../../src/plugins/dvr-controls/DvrControls.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,YAAY,EAAY,MAAM,cAAc,CAAA;AAM7E,OAAO,gDAAgD,CAAA;AAKvD;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAEpD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACH,IAAa,UAAU;;;MAKtB;gBAEW,IAAI,EAAE,IAAI;IAKtB;;OAEG;IACM,UAAU;IAgBnB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,KAAK;IAab,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,YAAY;IAQpB;;OAEG;IACM,MAAM;CAuBhB"}
+{"version":3,"file":"DvrControls.d.ts","sourceRoot":"","sources":["../../../src/plugins/dvr-controls/DvrControls.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,YAAY,EAAY,MAAM,cAAc,CAAA;AAM7E,OAAO,gDAAgD,CAAA;AAMvD;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAY,SAAQ,YAAY;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAEpD;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,gBAAgB;;MAEnB;IAED;;OAEG;IACH,IAAa,MAAM;;MAIlB;IAED;;OAEG;IACH,IAAa,UAAU;;;MAKtB;IAED;;OAEG;IACM,UAAU;IAUnB,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,YAAY;IAKpB;;OAEG;IACM,MAAM;CAoBhB"}