@gcorevideo/player 2.19.15 → 2.20.1

package/docs/api/player.statistics.md

@@ -1,141 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Statistics](./player.statistics.md)
-
-## Statistics class
-
-**Signature:**
-
-```typescript
-export declare class Statistics extends ContainerPlugin 
-```
-**Extends:** ContainerPlugin
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(container)](./player.statistics._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `Statistics` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[name](./player.statistics.name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[supportedVersion](./player.statistics.supportedversion.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ min: string; }
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[bindEvents()](./player.statistics.bindevents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>

package/docs/api/player.statistics.name.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Statistics](./player.statistics.md) &gt; [name](./player.statistics.name.md)
-
-## Statistics.name property
-
-**Signature:**
-
-```typescript
-get name(): string;
-```

package/docs/api/player.statistics.supportedversion.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [Statistics](./player.statistics.md) &gt; [supportedVersion](./player.statistics.supportedversion.md)
-
-## Statistics.supportedVersion property
-
-**Signature:**
-
-```typescript
-get supportedVersion(): {
-        min: string;
-    };
-```

package/docs/api/player.volumefade.bindevents.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [VolumeFade](./player.volumefade.md) &gt; [bindEvents](./player.volumefade.bindevents.md)
-
-## VolumeFade.bindEvents() 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.
-> 
-
-**Signature:**
-
-```typescript
-bindEvents(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/player.volumefade.unbindevents.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gcorevideo/player](./player.md) &gt; [VolumeFade](./player.volumefade.md) &gt; [unBindEvents](./player.volumefade.unbindevents.md)
-
-## VolumeFade.unBindEvents() 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.
-> 
-
-**Signature:**
-
-```typescript
-unBindEvents(): void;
-```
-**Returns:**
-
-void
-

package/src/plugins/statistics/Statistics.ts

@@ -1,207 +0,0 @@
-// An example implementation of client side performancestatistics
-import { Container, ContainerPlugin, Events, Playback } from '@clappr/core'
-import type { TimePosition, TimeValue } from '../../playback.types.js'
-import type { PlaybackType } from '../..//types'
-import { reportError } from '@gcorevideo/utils'
-import assert from 'assert'
-
-import { CLAPPR_VERSION } from '../../build.js'
-
-const CUSTOM_EVENTS_CONTAINER_START = 'container:start'
-
-const WATCH_CUTOFF = 5
-
-const HEATMAP_INTERVAL = 10
-
-type StatisticsEventData = Record<string, string | number | boolean>
-
-type StatisticsRecord = {
-  event: StatisticsEvent
-  type: PlaybackType
-} & StatisticsEventData
-
-export type PluginSettings = {
-  /**
-   * Sends the statistics record to the storage.
-   * The actual delivery is presumably async and batched.
-   * @param data - The statistics record to send.
-   */
-  send: (data: StatisticsRecord) => void
-}
-
-type StatisticsEvent = 'init' | 'start' | 'watch' | 'heatmap'
-
-// TODO rewrite as core plugin
-export class Statistics extends ContainerPlugin {
-  get name() {
-    return 'statistics_gplayer'
-  }
-
-  get supportedVersion() {
-    return { min: CLAPPR_VERSION }
-  }
-
-  private started = false
-
-  private timeStart = 0
-
-  private heatmapSent = false
-
-  private heatmapLastTime = 0
-
-  private watchSent = false
-
-  private bufTracking = false
-
-  private lags = 0
-
-  /**
-   * The time when buffering last started.
-   */
-  private bufLastStarted = 0
-
-  /**
-   * The accumulated buffering duration.
-   */
-  private bufAccDuration = 0
-
-  constructor(container: Container) {
-    super(container)
-    assert(
-      this.options.statistics &&
-        typeof this.options.statistics.send === 'function',
-      'Statistics plugin requires statistics options',
-    )
-  }
-
-  override bindEvents() {
-    // TODO remove this
-    this.listenToOnce(
-      this.container,
-      CUSTOM_EVENTS_CONTAINER_START,
-      this.onStart,
-    )
-
-    this.listenToOnce(this.container, Events.CONTAINER_READY, this.onReady)
-    this.listenTo(
-      this.container,
-      Events.CONTAINER_STATE_BUFFERING,
-      this.onBuffering,
-    )
-    this.listenTo(
-      this.container,
-      Events.CONTAINER_STATE_BUFFERFULL,
-      this.onBufferFull,
-    )
-    this.listenTo(
-      this.container.playback,
-      Events.PLAYBACK_TIMEUPDATE,
-      this.onTimeUpdateLive,
-    )
-    this.listenTo(
-      this.container.playback,
-      Events.PLAYBACK_LEVEL_SWITCH_START,
-      this.startLevelSwitch,
-    )
-    this.listenTo(
-      this.container.playback,
-      Events.PLAYBACK_LEVEL_SWITCH_END,
-      this.stopLevelSwitch,
-    )
-  }
-
-  private startLevelSwitch() {
-    this.bufTracking = false
-  }
-
-  private stopLevelSwitch() {
-    this.bufTracking = true
-  }
-
-  private onBuffering() {
-    if (this.bufTracking) {
-      this.bufLastStarted = performance.now()
-    }
-  }
-
-  private onBufferFull() {
-    if (this.bufTracking && this.bufLastStarted) {
-      this.bufAccDuration += performance.now() - this.bufLastStarted
-      this.lags++
-    }
-    this.bufTracking = true
-  }
-
-  private onReady() {
-    this.initEvent()
-    if (this.options.autoPlay) {
-      this.onStart()
-    }
-  }
-
-  private initEvent() {
-    this.sendMessage('init')
-  }
-
-  private sendMessage(state: StatisticsEvent) {
-    this.send(state, {
-      // embed_url: this.options.referer,
-      // user_agent: Browser.userAgent
-    })
-  }
-
-  private send(event: StatisticsEvent, data: StatisticsEventData = {}) {
-    ;(this.options.statistics as PluginSettings).send({
-      event,
-      type: this.container.getPlaybackType(),
-      ...data,
-    })
-  }
-
-  private sendHeatmap(time: TimeValue) {
-    const res: StatisticsEventData = {
-      buffering: Math.round(this.bufAccDuration),
-      lags: this.lags,
-    }
-
-    this.bufAccDuration = 0
-    this.lags = 0
-    if (this.container.getPlaybackType() === Playback.VOD) {
-      res.timestamp = time
-    }
-    this.send('heatmap', res)
-    this.heatmapSent = true
-    this.heatmapLastTime = time
-  }
-
-  private onTimeUpdateLive({ current }: TimePosition) {
-    // TODO check the `current` values for the live streams
-    if (!this.timeStart) {
-      this.timeStart = current
-    }
-    try {
-      const elapsed = current - this.timeStart
-      const heatmapElapsed = current - this.heatmapLastTime
-
-      // TODO check if the heatmap is only needed for the live streams
-      if (!this.heatmapSent || heatmapElapsed >= HEATMAP_INTERVAL) {
-        this.sendHeatmap(current)
-      }
-
-      if (!this.watchSent && elapsed >= WATCH_CUTOFF) {
-        this.watchSent = true
-        this.sendMessage('watch')
-      }
-    } catch (error) {
-      reportError(error)
-    }
-  }
-
-  private onStart() {
-    if (this.started) {
-      return
-    }
-    this.started = true
-    this.sendMessage('start')
-  }
-}