@pexip/peer-connection-stats 18.5.2 → 18.5.4

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 18.5.4
+
+### Patch Changes
+
+- Updated dependencies [1fff975]
+- Updated dependencies [3963c2e]
+- Updated dependencies [762ebd2]
+- Updated dependencies [4d2da34]
+  - @pexip/utils@17.2.0
+  - @pexip/signal@16.9.4
+
+## 18.5.3
+
+### Patch Changes
+
+- 13e3722: Generate the package documentation in a folder called doc-dist
+- Updated dependencies [13e3722]
+  - @pexip/signal@16.9.3
+  - @pexip/utils@17.1.3
+
 ## 18.5.2
 
 ## 18.5.1

package/api-docs/README.mdx

@@ -0,0 +1,83 @@
+# `@pexip/peer-connection-stats`
+
+Helps with normalization of data from `RTCStats` and friends.
+
+## Install
+
+`npm install @pexip/peer-connection-stats`
+
+Related documentation:
+
+- [https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_Statistics_API](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_Statistics_API)
+- [https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport](https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport)
+- [https://developer.mozilla.org/en-US/docs/Web/API/RTCStats](https://developer.mozilla.org/en-US/docs/Web/API/RTCStats)
+
+## Enumerations
+
+| Enumeration | Description |
+| ------ | ------ |
+| [Quality](enumerations/Quality.mdx) | - |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [RTCStats](interfaces/RTCStats.mdx) | - |
+| [Remote](interfaces/Remote.mdx) | - |
+| [CandidatePair](interfaces/CandidatePair.mdx) | - |
+| [Transport](interfaces/Transport.mdx) | - |
+| [Codec](interfaces/Codec.mdx) | - |
+| [InboundAudio](interfaces/InboundAudio.mdx) | - |
+| [OutboundAudio](interfaces/OutboundAudio.mdx) | - |
+| [InboundVideo](interfaces/InboundVideo.mdx) | - |
+| [OutboundVideo](interfaces/OutboundVideo.mdx) | - |
+| [MediaSource](interfaces/MediaSource.mdx) | - |
+| [Track](interfaces/Track.mdx) | - |
+| [Stream](interfaces/Stream.mdx) | - |
+| [Metrics](interfaces/Metrics.mdx) | - |
+| [VideoMetrics](interfaces/VideoMetrics.mdx) | - |
+| [CacheStats](interfaces/CacheStats.mdx) | - |
+| [StatsSignals](interfaces/StatsSignals.mdx) | - |
+| [StatsCollectorOptions](interfaces/StatsCollectorOptions.mdx) | - |
+| [StatsCollector](interfaces/StatsCollector.mdx) | - |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [AnyStats](type-aliases/AnyStats.mdx) | - |
+| [InboundAudioMetrics](type-aliases/InboundAudioMetrics.mdx) | - |
+| [InboundVideoMetrics](type-aliases/InboundVideoMetrics.mdx) | - |
+| [OutboundAudioMetrics](type-aliases/OutboundAudioMetrics.mdx) | - |
+| [OutboundVideoMetrics](type-aliases/OutboundVideoMetrics.mdx) | - |
+| [NormalizedRTCStats](type-aliases/NormalizedRTCStats.mdx) | - |
+| [PacketsStats](type-aliases/PacketsStats.mdx) | - |
+| [AudioQualityStats](type-aliases/AudioQualityStats.mdx) | - |
+| [VideoQualityStats](type-aliases/VideoQualityStats.mdx) | - |
+| [FPSStats](type-aliases/FPSStats.mdx) | - |
+| [CallQualityStats](type-aliases/CallQualityStats.mdx) | - |
+| [CallPacketsStats](type-aliases/CallPacketsStats.mdx) | - |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [STATS\_SIZE](variables/STATS_SIZE.mdx) | - |
+| [FPS\_STATS\_SIZE](variables/FPS_STATS_SIZE.mdx) | - |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createResolver](functions/createResolver.mdx) | The WebRTC stats are given to us as a flat structure (an array of objects that contain id-fields pointing to other objects in the same array). |
+| [inboundAudio](functions/inboundAudio.mdx) | Normalize inbound audio stats |
+| [outboundAudio](functions/outboundAudio.mdx) | Normalize outbound audio stats |
+| [inboundVideo](functions/inboundVideo.mdx) | Normalize inbound video stats |
+| [outboundVideo](functions/outboundVideo.mdx) | Normalize outbound video stats |
+| [statsFrom](functions/statsFrom.mdx) | Normalize stats into inbound and outbound video and audio stats |
+| [statsFromRTCPeer](functions/statsFromRTCPeer.mdx) | Gets raw stats from peerConnection and normalized them |
+| [getQuality](functions/getQuality.mdx) | - |
+| [addDeltaStats](functions/addDeltaStats.mdx) | - |
+| [calculateQuality](functions/calculateQuality.mdx) | - |
+| [createStatsCollector](functions/createStatsCollector.mdx) | Creates stats collector |
+| [createStatsSignals](functions/createStatsSignals.mdx) | Create and return all required and optional (if specified with `more`), signals for infinity client to work |

package/api-docs/enumerations/Quality.mdx

@@ -0,0 +1,8 @@
+## Enumeration Members
+
+| Enumeration Member | Value |
+| ------ | ------ |
+| <a id="good"></a> `GOOD` | `0` |
+| <a id="ok"></a> `OK` | `1` |
+| <a id="bad"></a> `BAD` | `2` |
+| <a id="terrible"></a> `TERRIBLE` | `3` |

package/api-docs/functions/addDeltaStats.mdx

@@ -0,0 +1,152 @@
+```ts
+function addDeltaStats(newStats, cache): readonly [
+  | {
+  type: "inbound-rtp" | "outbound-rtp";
+  kind: "audio" | "video";
+  bitrate?: number;
+  bytesTransmitted?: number;
+  codec?: string;
+  jitter?: number;
+  packetsLost: number;
+  packetsTransmitted: number;
+  recentPercentageLost?: number;
+  roundTripTime?: number;
+  timestamp?: number;
+  totalPercentageLost?: number;
+  timeToCaptureStats?: number;
+  quality?: Quality;
+}
+  | {
+  type: "inbound-rtp" | "outbound-rtp";
+  kind: "audio" | "video";
+  bitrate?: number;
+  bytesTransmitted?: number;
+  codec?: string;
+  jitter?: number;
+  packetsLost: number;
+  packetsTransmitted: number;
+  recentPercentageLost?: number;
+  roundTripTime?: number;
+  timestamp?: number;
+  totalPercentageLost?: number;
+  timeToCaptureStats?: number;
+  quality?: Quality;
+  framesPerSecond?: number;
+  resolution?: string;
+  resolutionHeight?: number;
+  resolutionWidth?: number;
+  fpsVolatility?: number;
+  averageDecodeTime?: number;
+}
+  | {
+  type: "inbound-rtp" | "outbound-rtp";
+  kind: "audio" | "video";
+  bitrate?: number;
+  bytesTransmitted?: number;
+  codec?: string;
+  jitter?: number;
+  packetsLost: number;
+  packetsTransmitted: number;
+  recentPercentageLost?: number;
+  roundTripTime?: number;
+  timestamp?: number;
+  totalPercentageLost?: number;
+  timeToCaptureStats?: number;
+  quality?: Quality;
+  framesPerSecond?: number;
+  resolution?: string;
+  resolutionHeight?: number;
+  resolutionWidth?: number;
+  fpsVolatility?: number;
+  totalPacketSendDelay?: number;
+  averagePacketSendDelay?: number;
+  averageEncodeTime?: number;
+  qualityLimitationReason?: "cpu" | "bandwidth" | "other" | "none";
+  qualityLimitationDurations?: {
+     cpu?: number;
+     bandwidth?: number;
+     other?: number;
+     none?: number;
+  };
+}, Quality, CallQualityStats];
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `newStats` | [`NormalizedRTCStats`](../type-aliases/NormalizedRTCStats.mdx) |
+| `cache` | [`CacheStats`](../interfaces/CacheStats.mdx) |
+
+## Returns
+
+readonly \[
+  \| \{
+  `type`: `"inbound-rtp"` \| `"outbound-rtp"`;
+  `kind`: `"audio"` \| `"video"`;
+  `bitrate?`: `number`;
+  `bytesTransmitted?`: `number`;
+  `codec?`: `string`;
+  `jitter?`: `number`;
+  `packetsLost`: `number`;
+  `packetsTransmitted`: `number`;
+  `recentPercentageLost?`: `number`;
+  `roundTripTime?`: `number`;
+  `timestamp?`: `number`;
+  `totalPercentageLost?`: `number`;
+  `timeToCaptureStats?`: `number`;
+  `quality?`: [`Quality`](../enumerations/Quality.mdx);
+\}
+  \| \{
+  `type`: `"inbound-rtp"` \| `"outbound-rtp"`;
+  `kind`: `"audio"` \| `"video"`;
+  `bitrate?`: `number`;
+  `bytesTransmitted?`: `number`;
+  `codec?`: `string`;
+  `jitter?`: `number`;
+  `packetsLost`: `number`;
+  `packetsTransmitted`: `number`;
+  `recentPercentageLost?`: `number`;
+  `roundTripTime?`: `number`;
+  `timestamp?`: `number`;
+  `totalPercentageLost?`: `number`;
+  `timeToCaptureStats?`: `number`;
+  `quality?`: [`Quality`](../enumerations/Quality.mdx);
+  `framesPerSecond?`: `number`;
+  `resolution?`: `string`;
+  `resolutionHeight?`: `number`;
+  `resolutionWidth?`: `number`;
+  `fpsVolatility?`: `number`;
+  `averageDecodeTime?`: `number`;
+\}
+  \| \{
+  `type`: `"inbound-rtp"` \| `"outbound-rtp"`;
+  `kind`: `"audio"` \| `"video"`;
+  `bitrate?`: `number`;
+  `bytesTransmitted?`: `number`;
+  `codec?`: `string`;
+  `jitter?`: `number`;
+  `packetsLost`: `number`;
+  `packetsTransmitted`: `number`;
+  `recentPercentageLost?`: `number`;
+  `roundTripTime?`: `number`;
+  `timestamp?`: `number`;
+  `totalPercentageLost?`: `number`;
+  `timeToCaptureStats?`: `number`;
+  `quality?`: [`Quality`](../enumerations/Quality.mdx);
+  `framesPerSecond?`: `number`;
+  `resolution?`: `string`;
+  `resolutionHeight?`: `number`;
+  `resolutionWidth?`: `number`;
+  `fpsVolatility?`: `number`;
+  `totalPacketSendDelay?`: `number`;
+  `averagePacketSendDelay?`: `number`;
+  `averageEncodeTime?`: `number`;
+  `qualityLimitationReason?`: `"cpu"` \| `"bandwidth"` \| `"other"` \| `"none"`;
+  `qualityLimitationDurations?`: \{
+     `cpu?`: `number`;
+     `bandwidth?`: `number`;
+     `other?`: `number`;
+     `none?`: `number`;
+  \};
+\}, [`Quality`](../enumerations/Quality.mdx), [`CallQualityStats`](../type-aliases/CallQualityStats.mdx)\]

package/api-docs/functions/calculateQuality.mdx

@@ -0,0 +1,13 @@
+```ts
+function calculateQuality(stats): Quality;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `stats` | `number` \| \[`number`, `number`\] |
+
+## Returns
+
+[`Quality`](../enumerations/Quality.mdx)

package/api-docs/functions/createResolver.mdx

@@ -0,0 +1,26 @@
+```ts
+function createResolver(statsReport): object;
+```
+
+The WebRTC stats are given to us as a flat structure (an array of objects
+that contain id-fields pointing to other objects in the same array).
+
+This class takes such an array as input and can expand an entry so that
+references become nested objects.
+
+https://www.w3.org/TR/webrtc-stats/#summary
+https://www.w3.org/TR/webrtc-stats/#rtctatstype-*
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `statsReport` | [`AnyStats`](../type-aliases/AnyStats.mdx)[] |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `expand()` | \{ (`audioIn`): [`InboundAudio`](../interfaces/InboundAudio.mdx); (`audioOut`): [`OutboundAudio`](../interfaces/OutboundAudio.mdx); (`videoIn`): [`InboundVideo`](../interfaces/InboundVideo.mdx); (`videoOut`): [`OutboundVideo`](../interfaces/OutboundVideo.mdx); \} |

package/api-docs/functions/createStatsCollector.mdx

@@ -0,0 +1,17 @@
+```ts
+function createStatsCollector(input): StatsCollector;
+```
+
+Creates stats collector
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `input` | [`StatsCollectorOptions`](../interfaces/StatsCollectorOptions.mdx) | input to get stats from |
+
+## Returns
+
+[`StatsCollector`](../interfaces/StatsCollector.mdx)
+
+function to reset stats window, cleanup func

package/api-docs/functions/createStatsSignals.mdx

@@ -0,0 +1,26 @@
+```ts
+function createStatsSignals(scope): StatsSignals;
+```
+
+Create and return all required and optional (if specified with `more`),
+signals for infinity client to work
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `scope` | `string` | `''` | any scope prefix for the generated signal name, |
+
+## Returns
+
+[`StatsSignals`](../interfaces/StatsSignals.mdx)
+
+## See
+
+ - Signal
+ - InfinitySignalsOptional
+
+The following signals created by default
+- 'onConnected',
+- 'onAnswer',
+ - REQUIRED_STATS_SIGNAL_KEYS

package/api-docs/functions/getQuality.mdx

@@ -0,0 +1,19 @@
+```ts
+function getQuality(stats): object;
+```
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `stats` | [`CallQualityStats`](../type-aliases/CallQualityStats.mdx) |
+
+## Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `quality` | [`Quality`](../enumerations/Quality.mdx) |
+| `goodOrOkQuality` | `number` |
+| `qualityOverTime` | [`Quality`](../enumerations/Quality.mdx)[] |

package/api-docs/functions/inboundAudio.mdx

@@ -0,0 +1,21 @@
+```ts
+function inboundAudio(statsData): Metrics;
+```
+
+Normalize inbound audio stats
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `statsData` | [`InboundAudio`](../interfaces/InboundAudio.mdx) | Raw inbound audio stats |
+
+## Returns
+
+[`Metrics`](../interfaces/Metrics.mdx)
+
+normalized stats for inbound audio from PeerConnection
+
+## See
+
+InboundAudio

package/api-docs/functions/inboundVideo.mdx

@@ -0,0 +1,21 @@
+```ts
+function inboundVideo(statsData): InboundVideoMetrics;
+```
+
+Normalize inbound video stats
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `statsData` | [`InboundVideo`](../interfaces/InboundVideo.mdx) | Raw inbound video stats |
+
+## Returns
+
+[`InboundVideoMetrics`](../type-aliases/InboundVideoMetrics.mdx)
+
+normalized stats for inbound video from PeerConnection
+
+## See
+
+InboundVideo

package/api-docs/functions/outboundAudio.mdx

@@ -0,0 +1,21 @@
+```ts
+function outboundAudio(statsData): Metrics;
+```
+
+Normalize outbound audio stats
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `statsData` | [`OutboundAudio`](../interfaces/OutboundAudio.mdx) | Raw outbound audio stats |
+
+## Returns
+
+[`Metrics`](../interfaces/Metrics.mdx)
+
+normalized stats for outbound audio from PeerConnection
+
+## See
+
+OutboundAudio

package/api-docs/functions/outboundVideo.mdx

@@ -0,0 +1,21 @@
+```ts
+function outboundVideo(statsData): OutboundVideoMetrics;
+```
+
+Normalize outbound video stats
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `statsData` | [`OutboundVideo`](../interfaces/OutboundVideo.mdx) | Raw outbound video stats |
+
+## Returns
+
+[`OutboundVideoMetrics`](../type-aliases/OutboundVideoMetrics.mdx)
+
+normalized stats for outbound video from PeerConnection
+
+## See
+
+OutboundVideo

package/api-docs/functions/statsFrom.mdx

@@ -0,0 +1,17 @@
+```ts
+function statsFrom(statsReports): Metrics | undefined;
+```
+
+Normalize stats into inbound and outbound video and audio stats
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `statsReports` | [`AnyStats`](../type-aliases/AnyStats.mdx)[] | reports to for mapping |
+
+## Returns
+
+[`Metrics`](../interfaces/Metrics.mdx) \| `undefined`
+
+normalized stats for inbound, outbound audio and video

package/api-docs/functions/statsFromRTCPeer.mdx

@@ -0,0 +1,27 @@
+```ts
+function statsFromRTCPeer(rtcPeer): Promise<NormalizedRTCStats>;
+```
+
+Gets raw stats from peerConnection and normalized them
+
+https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_Statistics_API
+
+A RTCPeerConnection has getStats()
+- getStats() returns promise which resolve to a RTCStatsReport
+- RTCStatsReport behaves like an array of RTCStats objects, or more
+  specific RTCRtpStreamStats objects
+
+https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport
+https://developer.mozilla.org/en-US/docs/Web/API/RTCStats
+https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpStreamStats
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `rtcPeer` | \{ `getStats`: (`selector?`) => `Promise`\<`RTCStatsReport`\>; \} |
+| `rtcPeer.getStats` | (`selector?`) => `Promise`\<`RTCStatsReport`\> |
+
+## Returns
+
+`Promise`\<[`NormalizedRTCStats`](../type-aliases/NormalizedRTCStats.mdx)\>

package/api-docs/interfaces/CacheStats.mdx

@@ -0,0 +1,9 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="previous"></a> `previous?` | [`NormalizedRTCStats`](../type-aliases/NormalizedRTCStats.mdx) |
+| <a id="callpacketsstats"></a> `callPacketsStats` | [`PacketsStats`](../type-aliases/PacketsStats.mdx) |
+| <a id="callquality"></a> `callQuality` | [`Quality`](../enumerations/Quality.mdx) |
+| <a id="callqualitystats"></a> `callQualityStats` | [`CallQualityStats`](../type-aliases/CallQualityStats.mdx) |
+| <a id="fpsstats"></a> `fpsStats` | [`FPSStats`](../type-aliases/FPSStats.mdx) |

package/api-docs/interfaces/CandidatePair.mdx

@@ -0,0 +1,24 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` | - | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"candidate-pair"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="availableincomingbitrate"></a> `availableIncomingBitrate?` | `number` | - | - |
+| <a id="availableoutgoingbitrate"></a> `availableOutgoingBitrate?` | `number` | - | - |
+| <a id="currentroundtriptime"></a> `currentRoundTripTime?` | `number` | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |
+| <a id="localcandidate"></a> `localCandidate?` | `CandidatePair` | - | - |
+| <a id="remotecandidate"></a> `remoteCandidate?` | `CandidatePair` | - | - |

package/api-docs/interfaces/Codec.mdx

@@ -0,0 +1,19 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` | - | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"codec"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="mimetype"></a> `mimeType?` | `string` | - | - |

package/api-docs/interfaces/InboundAudio.mdx

@@ -0,0 +1,25 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"inbound-rtp"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"audio"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |
+| <a id="jitter"></a> `jitter?` | `number` | - | - |
+| <a id="packetsreceived"></a> `packetsReceived?` | `number` | - | - |
+| <a id="packetslost"></a> `packetsLost?` | `number` | - | - |
+| <a id="bytesreceived"></a> `bytesReceived?` | `number` | - | - |
+| <a id="track"></a> `track?` | [`Track`](Track.mdx) | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |
+| <a id="codec"></a> `codec?` | [`Codec`](Codec.mdx) | - | - |

package/api-docs/interfaces/InboundVideo.mdx

@@ -0,0 +1,30 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"inbound-rtp"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"video"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |
+| <a id="packetsreceived"></a> `packetsReceived?` | `number` | - | - |
+| <a id="packetslost"></a> `packetsLost?` | `number` | - | - |
+| <a id="bytesreceived"></a> `bytesReceived?` | `number` | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |
+| <a id="codec"></a> `codec?` | [`Codec`](Codec.mdx) | - | - |
+| <a id="framewidth"></a> `frameWidth?` | `number` | - | - |
+| <a id="frameheight"></a> `frameHeight?` | `number` | - | - |
+| <a id="framespersecond"></a> `framesPerSecond?` | `number` | - | - |
+| <a id="totaldecodetime"></a> `totalDecodeTime?` | `number` | - | - |
+| <a id="framesdecoded"></a> `framesDecoded?` | `number` | - | - |
+| <a id="bitratemean"></a> `bitrateMean?` | `number` | - | - |
+| <a id="frameratemean"></a> `framerateMean?` | `number` | - | - |

package/api-docs/interfaces/MediaSource.mdx

@@ -0,0 +1,18 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"media-source"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"audio"` \| `"video"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |

package/api-docs/interfaces/Metrics.mdx

@@ -0,0 +1,22 @@
+## Extended by
+
+- [`VideoMetrics`](VideoMetrics.mdx)
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="type"></a> `type` | `"inbound-rtp"` \| `"outbound-rtp"` |
+| <a id="kind"></a> `kind` | `"audio"` \| `"video"` |
+| <a id="bitrate"></a> `bitrate?` | `number` |
+| <a id="bytestransmitted"></a> `bytesTransmitted?` | `number` |
+| <a id="codec"></a> `codec?` | `string` |
+| <a id="jitter"></a> `jitter?` | `number` |
+| <a id="packetslost"></a> `packetsLost` | `number` |
+| <a id="packetstransmitted"></a> `packetsTransmitted` | `number` |
+| <a id="recentpercentagelost"></a> `recentPercentageLost?` | `number` |
+| <a id="roundtriptime"></a> `roundTripTime?` | `number` |
+| <a id="timestamp"></a> `timestamp?` | `number` |
+| <a id="totalpercentagelost"></a> `totalPercentageLost?` | `number` |
+| <a id="timetocapturestats"></a> `timeToCaptureStats?` | `number` |
+| <a id="quality"></a> `quality?` | [`Quality`](../enumerations/Quality.mdx) |

package/api-docs/interfaces/OutboundAudio.mdx

@@ -0,0 +1,23 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"outbound-rtp"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"audio"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |
+| <a id="packetssent"></a> `packetsSent?` | `number` | - | - |
+| <a id="bytessent"></a> `bytesSent?` | `number` | - | - |
+| <a id="remote"></a> `remote?` | [`Remote`](Remote.mdx) | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |
+| <a id="codec"></a> `codec?` | [`Codec`](Codec.mdx) | - | - |

package/api-docs/interfaces/OutboundVideo.mdx

@@ -0,0 +1,40 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"outbound-rtp"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"video"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |
+| <a id="packetssent"></a> `packetsSent?` | `number` | - | - |
+| <a id="packetslost"></a> `packetsLost?` | `number` | - | - |
+| <a id="bytessent"></a> `bytesSent?` | `number` | - | - |
+| <a id="totalpacketsenddelay"></a> `totalPacketSendDelay?` | `number` | - | - |
+| <a id="framewidth"></a> `frameWidth?` | `number` | - | - |
+| <a id="frameheight"></a> `frameHeight?` | `number` | - | - |
+| <a id="framespersecond"></a> `framesPerSecond?` | `number` | - | - |
+| <a id="codec"></a> `codec?` | [`Codec`](Codec.mdx) | - | - |
+| <a id="mediasource"></a> `mediaSource?` | [`MediaSource`](MediaSource.mdx) | - | - |
+| <a id="remote"></a> `remote?` | [`Remote`](Remote.mdx) | - | - |
+| <a id="track"></a> `track?` | [`Track`](Track.mdx) | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |
+| <a id="totalencodetime"></a> `totalEncodeTime?` | `number` | - | - |
+| <a id="framesencoded"></a> `framesEncoded?` | `number` | - | - |
+| <a id="bitratemean"></a> `bitrateMean?` | `number` | - | - |
+| <a id="frameratemean"></a> `framerateMean?` | `number` | - | - |
+| <a id="qualitylimitationreason"></a> `qualityLimitationReason?` | `"cpu"` \| `"bandwidth"` \| `"other"` \| `"none"` | - | - |
+| <a id="qualitylimitationdurations"></a> `qualityLimitationDurations?` | `object` | - | - |
+| `qualityLimitationDurations.cpu?` | `number` | - | - |
+| `qualityLimitationDurations.bandwidth?` | `number` | - | - |
+| `qualityLimitationDurations.other?` | `number` | - | - |
+| `qualityLimitationDurations.none?` | `number` | - | - |

package/api-docs/interfaces/RTCStats.mdx

@@ -0,0 +1,28 @@
+## Extended by
+
+- [`Remote`](Remote.mdx)
+- [`CandidatePair`](CandidatePair.mdx)
+- [`Transport`](Transport.mdx)
+- [`Codec`](Codec.mdx)
+- [`InboundAudio`](InboundAudio.mdx)
+- [`OutboundAudio`](OutboundAudio.mdx)
+- [`InboundVideo`](InboundVideo.mdx)
+- [`OutboundVideo`](OutboundVideo.mdx)
+- [`MediaSource`](MediaSource.mdx)
+- [`Track`](Track.mdx)
+- [`Stream`](Stream.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="id"></a> `id` | `string` |
+| <a id="type"></a> `type` | `string` |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` |
+| <a id="timestamp"></a> `timestamp?` | `number` |

package/api-docs/interfaces/Remote.mdx

@@ -0,0 +1,23 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` | - | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"remote-inbound-rtp"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="jitter"></a> `jitter?` | `number` | - | - |
+| <a id="packetslost"></a> `packetsLost?` | `number` | - | - |
+| <a id="roundtriptime"></a> `roundTripTime?` | `number` | - | - |
+| <a id="codec"></a> `codec?` | [`Codec`](Codec.mdx) | - | - |
+| <a id="transport"></a> `transport?` | [`Transport`](Transport.mdx) | - | - |

package/api-docs/interfaces/StatsCollector.mdx

@@ -0,0 +1,6 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="resetstats"></a> `resetStats` | () => () => `void` |
+| <a id="cleanup"></a> `cleanup` | () => `void` |

package/api-docs/interfaces/StatsCollectorOptions.mdx

@@ -0,0 +1,8 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="input"></a> `input` | `object` |
+| `input.getStats` | (`selector?`) => `Promise`\<`RTCStatsReport`\> |
+| <a id="signals"></a> `signals` | [`StatsSignals`](StatsSignals.mdx) |
+| <a id="interval"></a> `interval?` | `number` |

package/api-docs/interfaces/StatsSignals.mdx

@@ -0,0 +1,7 @@
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="onrtcstats"></a> `onRtcStats` | `Signal`\<[`NormalizedRTCStats`](../type-aliases/NormalizedRTCStats.mdx)\> |
+| <a id="oncallquality"></a> `onCallQuality` | `Signal`\<[`Quality`](../enumerations/Quality.mdx)\> |
+| <a id="oncallqualitystats"></a> `onCallQualityStats` | `Signal`\<[`CallQualityStats`](../type-aliases/CallQualityStats.mdx)\> |

package/api-docs/interfaces/Stream.mdx

@@ -0,0 +1,19 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` | - | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"stream"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="tracks"></a> `tracks?` | [`Track`](Track.mdx)[] | - | - |

package/api-docs/interfaces/Track.mdx

@@ -0,0 +1,19 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"track"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="kind"></a> `kind` | `"audio"` \| `"video"` | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) | - |
+| <a id="mediasource"></a> `mediaSource?` | [`MediaSource`](MediaSource.mdx) | - | - |

package/api-docs/interfaces/Transport.mdx

@@ -0,0 +1,19 @@
+## Extends
+
+- [`RTCStats`](RTCStats.mdx)
+
+## Indexable
+
+```ts
+[key: string]: unknown
+```
+
+## Properties
+
+| Property | Type | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ |
+| <a id="id"></a> `id` | `string` | - | [`RTCStats`](RTCStats.mdx).[`id`](RTCStats.mdx#id) |
+| <a id="kind"></a> `kind?` | `"audio"` \| `"video"` | - | [`RTCStats`](RTCStats.mdx).[`kind`](RTCStats.mdx#kind) |
+| <a id="timestamp"></a> `timestamp?` | `number` | - | [`RTCStats`](RTCStats.mdx).[`timestamp`](RTCStats.mdx#timestamp) |
+| <a id="type"></a> `type` | `"transport"` | [`RTCStats`](RTCStats.mdx).[`type`](RTCStats.mdx#type) | - |
+| <a id="selectedcandidatepair"></a> `selectedCandidatePair?` | [`CandidatePair`](CandidatePair.mdx) | - | - |

package/api-docs/interfaces/VideoMetrics.mdx

@@ -0,0 +1,27 @@
+## Extends
+
+- [`Metrics`](Metrics.mdx)
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| <a id="type"></a> `type` | `"inbound-rtp"` \| `"outbound-rtp"` | [`Metrics`](Metrics.mdx).[`type`](Metrics.mdx#type) |
+| <a id="kind"></a> `kind` | `"audio"` \| `"video"` | [`Metrics`](Metrics.mdx).[`kind`](Metrics.mdx#kind) |
+| <a id="bitrate"></a> `bitrate?` | `number` | [`Metrics`](Metrics.mdx).[`bitrate`](Metrics.mdx#bitrate) |
+| <a id="bytestransmitted"></a> `bytesTransmitted?` | `number` | [`Metrics`](Metrics.mdx).[`bytesTransmitted`](Metrics.mdx#bytestransmitted) |
+| <a id="codec"></a> `codec?` | `string` | [`Metrics`](Metrics.mdx).[`codec`](Metrics.mdx#codec) |
+| <a id="jitter"></a> `jitter?` | `number` | [`Metrics`](Metrics.mdx).[`jitter`](Metrics.mdx#jitter) |
+| <a id="packetslost"></a> `packetsLost` | `number` | [`Metrics`](Metrics.mdx).[`packetsLost`](Metrics.mdx#packetslost) |
+| <a id="packetstransmitted"></a> `packetsTransmitted` | `number` | [`Metrics`](Metrics.mdx).[`packetsTransmitted`](Metrics.mdx#packetstransmitted) |
+| <a id="recentpercentagelost"></a> `recentPercentageLost?` | `number` | [`Metrics`](Metrics.mdx).[`recentPercentageLost`](Metrics.mdx#recentpercentagelost) |
+| <a id="roundtriptime"></a> `roundTripTime?` | `number` | [`Metrics`](Metrics.mdx).[`roundTripTime`](Metrics.mdx#roundtriptime) |
+| <a id="timestamp"></a> `timestamp?` | `number` | [`Metrics`](Metrics.mdx).[`timestamp`](Metrics.mdx#timestamp) |
+| <a id="totalpercentagelost"></a> `totalPercentageLost?` | `number` | [`Metrics`](Metrics.mdx).[`totalPercentageLost`](Metrics.mdx#totalpercentagelost) |
+| <a id="timetocapturestats"></a> `timeToCaptureStats?` | `number` | [`Metrics`](Metrics.mdx).[`timeToCaptureStats`](Metrics.mdx#timetocapturestats) |
+| <a id="quality"></a> `quality?` | [`Quality`](../enumerations/Quality.mdx) | [`Metrics`](Metrics.mdx).[`quality`](Metrics.mdx#quality) |
+| <a id="framespersecond"></a> `framesPerSecond?` | `number` | - |
+| <a id="resolution"></a> `resolution?` | `string` | - |
+| <a id="resolutionheight"></a> `resolutionHeight?` | `number` | - |
+| <a id="resolutionwidth"></a> `resolutionWidth?` | `number` | - |
+| <a id="fpsvolatility"></a> `fpsVolatility?` | `number` | - |

package/api-docs/type-aliases/AnyStats.mdx

@@ -0,0 +1,14 @@
+```ts
+type AnyStats = 
+  | CandidatePair
+  | Codec
+  | InboundAudio
+  | InboundVideo
+  | OutboundAudio
+  | OutboundVideo
+  | RTCStats
+  | Remote
+  | Stream
+  | Track
+  | Transport;
+```

package/api-docs/type-aliases/AudioQualityStats.mdx

@@ -0,0 +1,3 @@
+```ts
+type AudioQualityStats = [number, number][];
+```

package/api-docs/type-aliases/CallPacketsStats.mdx

@@ -0,0 +1,3 @@
+```ts
+type CallPacketsStats = PacketsStats;
+```

package/api-docs/type-aliases/CallQualityStats.mdx

@@ -0,0 +1,5 @@
+```ts
+type CallQualityStats = 
+  | AudioQualityStats
+  | VideoQualityStats;
+```

package/api-docs/type-aliases/FPSStats.mdx

@@ -0,0 +1,3 @@
+```ts
+type FPSStats = number[];
+```

package/api-docs/type-aliases/InboundAudioMetrics.mdx

@@ -0,0 +1,3 @@
+```ts
+type InboundAudioMetrics = Metrics;
+```

package/api-docs/type-aliases/InboundVideoMetrics.mdx

@@ -0,0 +1,9 @@
+```ts
+type InboundVideoMetrics = VideoMetrics & object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `averageDecodeTime?` | `number` |

package/api-docs/type-aliases/NormalizedRTCStats.mdx

@@ -0,0 +1,7 @@
+```ts
+type NormalizedRTCStats = 
+  | InboundAudioMetrics
+  | InboundVideoMetrics
+  | OutboundAudioMetrics
+  | OutboundVideoMetrics;
+```

package/api-docs/type-aliases/OutboundAudioMetrics.mdx

@@ -0,0 +1,3 @@
+```ts
+type OutboundAudioMetrics = Metrics;
+```

package/api-docs/type-aliases/OutboundVideoMetrics.mdx

@@ -0,0 +1,13 @@
+```ts
+type OutboundVideoMetrics = VideoMetrics & object;
+```
+
+## Type Declaration
+
+| Name | Type |
+| ------ | ------ |
+| `totalPacketSendDelay?` | `number` |
+| `averagePacketSendDelay?` | `number` |
+| `averageEncodeTime?` | `number` |
+| `qualityLimitationReason?` | [`OutboundVideo`](../interfaces/OutboundVideo.mdx)\[`"qualityLimitationReason"`\] |
+| `qualityLimitationDurations?` | [`OutboundVideo`](../interfaces/OutboundVideo.mdx)\[`"qualityLimitationDurations"`\] |

package/api-docs/type-aliases/PacketsStats.mdx

@@ -0,0 +1,3 @@
+```ts
+type PacketsStats = [number, number][];
+```

package/api-docs/type-aliases/VideoQualityStats.mdx

@@ -0,0 +1,3 @@
+```ts
+type VideoQualityStats = number[];
+```

package/api-docs/variables/FPS_STATS_SIZE.mdx

@@ -0,0 +1,3 @@
+```ts
+const FPS_STATS_SIZE: 8 = 8;
+```

package/api-docs/variables/STATS_SIZE.mdx

@@ -0,0 +1,3 @@
+```ts
+const STATS_SIZE: 60 = 60;
+```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pexip/peer-connection-stats",
-  "version": "18.5.2",
+  "version": "18.5.4",
   "description": "Normalizer of RTCStats and related",
-  "homepage": "https://gitlab.com/pexip/zoo",
+  "homepage": "https://developer.pexip.com",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
   "repository": {
     "type": "git",
@@ -23,33 +23,40 @@
       "import": "./dist/*.js"
     }
   },
+  "directories": {
+    "doc": "api-docs"
+  },
   "files": [
-    "dist"
+    "dist",
+    "api-docs"
   ],
   "scripts": {
     "build": "pexip-bundler build",
     "build:sourcemap": "pexip-bundler build --sourcemap",
-    "clean": "rm -fr dist",
+    "clean": "rm -fr dist api-docs",
     "dev": "pexip-bundler dev",
-    "prepack": "yarn clean && yarn build",
+    "prepack": "yarn clean && yarn build && yarn docs",
     "test": "jest",
     "tsc": "tsc --noEmit",
     "check-format": "prettier --ignore-path=../../.prettierignore --check .",
     "format": "prettier --ignore-path=../../.prettierignore --write .",
     "lint": "yarn run -T biome lint",
-    "typecheck": "yarn tsc --noEmit -p ."
+    "typecheck": "yarn tsc --noEmit -p .",
+    "docs": "typedoc"
   },
   "dependencies": {
-    "@pexip/signal": "16.9.2",
-    "@pexip/utils": "17.1.2"
+    "@pexip/signal": "16.9.4",
+    "@pexip/utils": "17.2.0"
   },
   "devDependencies": {
-    "@pexip/bundler": "18.1.2",
+    "@pexip/bundler": "18.2.0",
     "@swc/core": "^1.10.12",
     "@swc/jest": "^0.2.39",
     "jest": "^29.5.12",
     "jest-junit": "^16.0.0",
     "prettier": "^3.2.5",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "~5.7.3"
   },
   "publishConfig": {