@pexip/peer-connection-stats 18.1.0 → 18.3.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 18.3.0
+
+### Minor Changes
+
+- 27d9dd7: Expose `quality` from `onRtcStats` signal.
+
+### Patch Changes
+
+- Updated dependencies [adc1a50]
+  - @pexip/utils@17.0.1
+  - @pexip/signal@16.9.0
+
+## 18.2.0
+
+### Minor Changes
+
+- 7f9df17: Expose `qualityLimitationDurations` and `qualityLimitationReason`.
+
+### Patch Changes
+
+- 709232f: Correct typedoc comment to fix the document generation.
+- Updated dependencies [6fddc11]
+  - @pexip/signal@16.9.0
+  - @pexip/utils@17.0.0
+
 ## 18.1.0
 
 ### Minor Changes

package/README.md

@@ -8,6 +8,6 @@ Helps with normalization of data from `RTCStats` and friends.
 
 Related documentation:
 
-- <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/RTCStats>
+- [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)

package/dist/statsCollector.d.ts

@@ -97,6 +97,7 @@ export declare const addDeltaStats: (newStats: NormalizedRTCStats, cache: CacheS
     timestamp?: number;
     totalPercentageLost?: number;
     timeToCaptureStats?: number;
+    quality?: Quality;
 } | {
     framesPerSecond?: number;
     resolution?: string;
@@ -116,6 +117,7 @@ export declare const addDeltaStats: (newStats: NormalizedRTCStats, cache: CacheS
     timestamp?: number;
     totalPercentageLost?: number;
     timeToCaptureStats?: number;
+    quality?: Quality;
     averageDecodeTime?: number;
 } | {
     framesPerSecond?: number;
@@ -136,9 +138,12 @@ export declare const addDeltaStats: (newStats: NormalizedRTCStats, cache: CacheS
     timestamp?: number;
     totalPercentageLost?: number;
     timeToCaptureStats?: number;
+    quality?: Quality;
     totalPacketSendDelay?: number;
     averagePacketSendDelay?: number;
     averageEncodeTime?: number;
+    qualityLimitationReason?: OutboundVideo["qualityLimitationReason"];
+    qualityLimitationDurations?: OutboundVideo["qualityLimitationDurations"];
 }, Quality, CallQualityStats];
 export declare const calculateQuality: (stats: number | [number, number]) => Quality;
 /**
@@ -148,6 +153,6 @@ export declare const calculateQuality: (stats: number | [number, number]) => Qua
  * @param signal - Signal which distributes stats
  * @param interval - how often signal with fire with new stats
  *
- * @returns \{function to reset stats window, cleanup func\}
+ * @returns {Object} function to reset stats window, cleanup func
  */
 export declare const createStatsCollector: ({ input, signals: { onCallQuality, onCallQualityStats, onRtcStats }, interval, }: StatsCollectorOptions) => StatsCollector;

package/dist/statsCollector.js

@@ -224,6 +224,8 @@ export const outboundVideo = (statsData) => {
         averageEncodeTime: statsData.framesEncoded && statsData.totalEncodeTime
             ? statsData.totalEncodeTime / statsData.framesEncoded
             : 0,
+        qualityLimitationReason: statsData.qualityLimitationReason,
+        qualityLimitationDurations: statsData.qualityLimitationDurations,
     };
 };
 const isInbound = (entry) => entry.type === 'inbound-rtp';
@@ -442,11 +444,9 @@ export const addDeltaStats = (newStats, cache) => {
         }
     });
     const callQualityStats = recordCallQualityStats(oldStats, deltaStats, cache.callQualityStats);
-    return [
-        deltaStats,
-        getQuality(callQualityStats ?? []).quality,
-        callQualityStats,
-    ];
+    const quality = getQuality(callQualityStats ?? []).quality;
+    deltaStats.quality = quality;
+    return [deltaStats, quality, callQualityStats];
 };
 // https://docs.pexip.com/admin/media_statistics.htm
 export const calculateQuality = (stats) => {
@@ -493,7 +493,7 @@ export const calculateQuality = (stats) => {
  * @param signal - Signal which distributes stats
  * @param interval - how often signal with fire with new stats
  *
- * @returns \{function to reset stats window, cleanup func\}
+ * @returns {Object} function to reset stats window, cleanup func
  */
 export const createStatsCollector = ({ input, signals: { onCallQuality, onCallQualityStats, onRtcStats }, interval = 1000, }) => {
     const newCache = () => ({

package/dist/statsCollector.types.d.ts

@@ -86,6 +86,10 @@ export interface OutboundVideo extends RTCStats {
     framesEncoded?: number;
     bitrateMean?: number;
     framerateMean?: number;
+    qualityLimitationReason?: 'cpu' | 'bandwidth' | 'other' | 'none';
+    qualityLimitationDurations?: {
+        [key in NonNullable<OutboundVideo['qualityLimitationReason']>]?: number;
+    };
 }
 export interface MediaSource extends RTCStats {
     type: 'media-source';
@@ -115,6 +119,7 @@ export interface Metrics {
     timestamp?: number;
     totalPercentageLost?: number;
     timeToCaptureStats?: number;
+    quality?: Quality;
 }
 export interface VideoMetrics extends Metrics {
     framesPerSecond?: number;
@@ -132,6 +137,8 @@ export type OutboundVideoMetrics = VideoMetrics & {
     totalPacketSendDelay?: number;
     averagePacketSendDelay?: number;
     averageEncodeTime?: number;
+    qualityLimitationReason?: OutboundVideo['qualityLimitationReason'];
+    qualityLimitationDurations?: OutboundVideo['qualityLimitationDurations'];
 };
 export type NormalizedRTCStats = InboundAudioMetrics | InboundVideoMetrics | OutboundAudioMetrics | OutboundVideoMetrics;
 export type PacketsStats = [number, number][];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pexip/peer-connection-stats",
-  "version": "18.1.0",
+  "version": "18.3.0",
   "description": "Normalizer of RTCStats and related",
   "homepage": "https://gitlab.com/pexip/zoo",
   "bugs": "https://gitlab.com/pexip/zoo/issues",
@@ -40,11 +40,11 @@
     "typecheck": "yarn tsc --noEmit -p ."
   },
   "dependencies": {
-    "@pexip/signal": "16.8.0",
-    "@pexip/utils": "17.0.0"
+    "@pexip/signal": "16.9.0",
+    "@pexip/utils": "17.0.1"
   },
   "devDependencies": {
-    "@pexip/bundler": "18.1.0",
+    "@pexip/bundler": "18.1.2",
     "@swc/core": "^1.10.12",
     "@swc/jest": "^0.2.37",
     "jest": "^29.5.12",