@stream-io/video-client 1.41.1 → 1.41.3

package/dist/src/stats/SfuStatsReporter.d.ts

@@ -29,6 +29,7 @@ export declare class SfuStatsReporter {
     private readonly unifiedSessionId;
     private intervalId;
     private timeoutId;
+    private reportCount;
     private unsubscribeDevicePermissionsSubscription?;
     private unsubscribeListDevicesSubscription?;
     private readonly sdkName;
@@ -41,8 +42,8 @@ export declare class SfuStatsReporter {
     sendReconnectionTime: (strategy: WebsocketReconnectStrategy, timeSeconds: number) => void;
     private sendTelemetryData;
     private run;
+    private scheduleNextReport;
     start: () => void;
     stop: () => void;
     flush: () => void;
-    scheduleOne: (timeout: number) => void;
 }

package/dist/src/stats/types.d.ts

@@ -1,4 +1,9 @@
 import { TrackType } from '../gen/video/sfu/models/models';
+export type CameraStats = {
+    frameHeight?: number;
+    frameWidth?: number;
+    frameRate?: number;
+};
 export type BaseStats = {
     audioLevel?: number;
     bytesSent?: number;
@@ -19,6 +24,7 @@ export type BaseStats = {
     concealmentEvents?: number;
     packetsReceived?: number;
     packetsLost?: number;
+    camera?: CameraStats;
 };
 export type StatsReport = {
     rawStats?: RTCStatsReport;
@@ -47,6 +53,7 @@ export type AggregatedStatsReport = {
     highestFrameWidth: number;
     highestFrameHeight: number;
     highestFramesPerSecond: number;
+    camera?: CameraStats;
     codec: string;
     codecPerTrackType: Partial<Record<TrackType, string>>;
     timestamp: number;
@@ -108,6 +115,9 @@ export interface RTCMediaSourceStats {
     kind: string;
     trackIdentifier: string;
     audioLevel?: number;
+    framesPerSecond?: number;
+    width?: number;
+    height?: number;
 }
 export type RTCCodecStats = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.41.1",
+  "version": "1.41.3",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "browser": "dist/index.browser.es.js",

package/src/Call.ts

@@ -638,6 +638,8 @@ export class Call {
       this.statsReporter?.stop();
       this.statsReporter = undefined;
 
+      const leaveReason = message ?? reason ?? 'user is leaving the call';
+      this.tracer.trace('call.leaveReason', leaveReason);
       this.sfuStatsReporter?.flush();
       this.sfuStatsReporter?.stop();
       this.sfuStatsReporter = undefined;
@@ -648,9 +650,7 @@ export class Call {
       this.publisher?.dispose();
       this.publisher = undefined;
 
-      await this.sfuClient?.leaveAndClose(
-        message ?? reason ?? 'user is leaving the call',
-      );
+      await this.sfuClient?.leaveAndClose(leaveReason);
       this.sfuClient = undefined;
       this.dynascaleManager.setSfuClient(undefined);
       await this.dynascaleManager.dispose();
@@ -854,6 +854,7 @@ export class Call {
    * Unless you are implementing a custom "ringing" flow, you should not use this method.
    */
   accept = async () => {
+    this.tracer.trace('call.accept', '');
     return this.streamClient.post<AcceptCallResponse>(
       `${this.streamClientBasePath}/accept`,
     );
@@ -871,6 +872,7 @@ export class Call {
   reject = async (
     reason: RejectReason = 'decline',
   ): Promise<RejectCallResponse> => {
+    this.tracer.trace('call.reject', reason);
     return this.streamClient.post<RejectCallResponse, RejectCallRequest>(
       `${this.streamClientBasePath}/reject`,
       { reason: reason },
@@ -1834,12 +1836,6 @@ export class Call {
       }
     }
 
-    if (track.kind === 'video') {
-      // schedules calibration report - the SFU will use the performance stats
-      // to adjust the quality thresholds as early as possible
-      this.sfuStatsReporter?.scheduleOne(3000);
-    }
-
     await this.updateLocalStreamState(mediaStream, ...trackTypes);
   };
 

package/src/devices/SpeakerManager.ts

@@ -91,11 +91,7 @@ export class SpeakerManager {
    * @returns an Observable that will be updated if a device is connected or disconnected
    */
   listDevices() {
-    if (isReactNative()) {
-      throw new Error(
-        'This feature is not supported in React Native. Please visit https://getstream.io/video/docs/reactnative/core/camera-and-microphone/#speaker-management for more details',
-      );
-    }
+    assertUnsupportedInReactNative();
     return getAudioOutputDevices(this.call.tracer);
   }
 
@@ -107,11 +103,7 @@ export class SpeakerManager {
    * @param deviceId empty string means the system default
    */
   select(deviceId: string) {
-    if (isReactNative()) {
-      throw new Error(
-        'This feature is not supported in React Native. Please visit https://getstream.io/video/docs/reactnative/core/camera-and-microphone/#speaker-management for more details',
-      );
-    }
+    assertUnsupportedInReactNative();
     this.state.setDevice(deviceId);
   }
 
@@ -133,11 +125,7 @@ export class SpeakerManager {
    * Note: This method is not supported in React Native
    */
   setVolume(volume: number) {
-    if (isReactNative()) {
-      throw new Error(
-        'This feature is not supported in React Native. Please visit https://getstream.io/video/docs/reactnative/core/camera-and-microphone/#speaker-management for more details',
-      );
-    }
+    assertUnsupportedInReactNative();
     if (volume && (volume < 0 || volume > 1)) {
       throw new Error('Volume must be between 0 and 1');
     }
@@ -165,3 +153,11 @@ export class SpeakerManager {
     });
   }
 }
+
+const assertUnsupportedInReactNative = () => {
+  if (isReactNative()) {
+    throw new Error(
+      'Unsupported in React Native. See: https://getstream.io/video/docs/react-native/guides/camera-and-microphone/#speaker-management',
+    );
+  }
+};

package/src/stats/CallStateStatsReporter.ts

@@ -2,6 +2,7 @@ import type {
   AggregatedStatsReport,
   AudioAggregatedStats,
   BaseStats,
+  CameraStats,
   ParticipantsStatsReport,
   RTCCodecStats,
   RTCMediaSourceStats,
@@ -237,6 +238,17 @@ export type StatsTransformOpts = {
   publisher: Publisher | undefined;
 };
 
+/**
+ * Extracts camera statistics from a media source.
+ *
+ * @param mediaSource the media source stats to extract camera info from.
+ */
+const getCameraStats = (mediaSource: RTCMediaSourceStats): CameraStats => ({
+  frameRate: mediaSource.framesPerSecond,
+  frameWidth: mediaSource.width,
+  frameHeight: mediaSource.height,
+});
+
 /**
  * Transforms raw RTC stats into a slimmer and uniform across browsers format.
  *
@@ -280,6 +292,7 @@ const transform = (
 
       let trackType: TrackType | undefined;
       let audioLevel: number | undefined;
+      let camera: CameraStats | undefined;
       let concealedSamples: number | undefined;
       let concealmentEvents: number | undefined;
       let packetsReceived: number | undefined;
@@ -300,6 +313,9 @@ const transform = (
           ) {
             audioLevel = mediaSource.audioLevel;
           }
+          if (trackKind === 'video') {
+            camera = getCameraStats(mediaSource);
+          }
         }
       } else if (kind === 'subscriber' && trackKind === 'audio') {
         const inboundStats = rtcStreamStats as RTCInboundRtpStreamStats;
@@ -333,6 +349,7 @@ const transform = (
         concealmentEvents,
         packetsReceived,
         packetsLost,
+        camera,
       };
     });
 
@@ -354,6 +371,7 @@ const getEmptyVideoStats = (stats?: StatsReport): AggregatedStatsReport => {
     highestFrameWidth: 0,
     highestFrameHeight: 0,
     highestFramesPerSecond: 0,
+    camera: {},
     codec: '',
     codecPerTrackType: {},
     timestamp: Date.now(),
@@ -404,6 +422,10 @@ const aggregate = (stats: StatsReport): AggregatedStatsReport => {
       maxArea = streamArea;
     }
 
+    if (stream.trackType === TrackType.VIDEO) {
+      acc.camera = stream.camera;
+    }
+
     qualityLimitationReasons.add(stream.qualityLimitationReason || '');
     return acc;
   }, aggregatedStats);

package/src/stats/SfuStatsReporter.ts

@@ -44,6 +44,7 @@ export class SfuStatsReporter {
 
   private intervalId: NodeJS.Timeout | undefined;
   private timeoutId: NodeJS.Timeout | undefined;
+  private reportCount: number = 0;
   private unsubscribeDevicePermissionsSubscription?: () => void;
   private unsubscribeListDevicesSubscription?: () => void;
   private readonly sdkName: string;
@@ -208,18 +209,33 @@ export class SfuStatsReporter {
     }
   };
 
+  private scheduleNextReport = () => {
+    const intervals = [1500, 3000, 3000, 5000];
+    if (this.reportCount < intervals.length) {
+      this.timeoutId = setTimeout(() => {
+        this.flush();
+        this.reportCount++;
+        this.scheduleNextReport();
+      }, intervals[this.reportCount]);
+    } else {
+      clearInterval(this.intervalId);
+      this.intervalId = setInterval(() => {
+        this.flush();
+      }, this.options.reporting_interval_ms);
+    }
+  };
+
   start = () => {
     if (this.options.reporting_interval_ms <= 0) return;
 
     this.observeDevice(this.microphone, 'mic');
     this.observeDevice(this.camera, 'camera');
 
+    this.reportCount = 0;
     clearInterval(this.intervalId);
-    this.intervalId = setInterval(() => {
-      this.run().catch((err) => {
-        this.logger.warn('Failed to report stats', err);
-      });
-    }, this.options.reporting_interval_ms);
+    clearTimeout(this.timeoutId);
+
+    this.scheduleNextReport();
   };
 
   stop = () => {
@@ -233,6 +249,7 @@ export class SfuStatsReporter {
     this.intervalId = undefined;
     clearTimeout(this.timeoutId);
     this.timeoutId = undefined;
+    this.reportCount = 0;
   };
 
   flush = () => {
@@ -240,13 +257,4 @@ export class SfuStatsReporter {
       this.logger.warn('Failed to flush report stats', err);
     });
   };
-
-  scheduleOne = (timeout: number) => {
-    clearTimeout(this.timeoutId);
-    this.timeoutId = setTimeout(() => {
-      this.run().catch((err) => {
-        this.logger.warn('Failed to report stats', err);
-      });
-    }, timeout);
-  };
 }

package/src/stats/types.ts

@@ -1,5 +1,11 @@
 import { TrackType } from '../gen/video/sfu/models/models';
 
+export type CameraStats = {
+  frameHeight?: number;
+  frameWidth?: number;
+  frameRate?: number;
+};
+
 export type BaseStats = {
   audioLevel?: number;
   bytesSent?: number;
@@ -20,6 +26,7 @@ export type BaseStats = {
   concealmentEvents?: number;
   packetsReceived?: number;
   packetsLost?: number;
+  camera?: CameraStats;
 };
 
 export type StatsReport = {
@@ -51,6 +58,7 @@ export type AggregatedStatsReport = {
   highestFrameWidth: number;
   highestFrameHeight: number;
   highestFramesPerSecond: number;
+  camera?: CameraStats;
   codec: string;
   codecPerTrackType: Partial<Record<TrackType, string>>;
   timestamp: number;
@@ -118,6 +126,9 @@ export interface RTCMediaSourceStats {
   kind: string;
   trackIdentifier: string;
   audioLevel?: number;
+  framesPerSecond?: number;
+  width?: number;
+  height?: number;
 }
 
 // shim for RTCCodecStats, not yet available in the standard types