@stream-io/video-client 1.51.0 → 1.52.0

package/dist/index.cjs.js

@@ -1206,6 +1206,14 @@ var SdkType;
      * @generated from protobuf enum value: SDK_TYPE_PLAIN_JAVASCRIPT = 9;
      */
     SdkType[SdkType["PLAIN_JAVASCRIPT"] = 9] = "PLAIN_JAVASCRIPT";
+    /**
+     * @generated from protobuf enum value: SDK_TYPE_PYTHON = 10;
+     */
+    SdkType[SdkType["PYTHON"] = 10] = "PYTHON";
+    /**
+     * @generated from protobuf enum value: SDK_TYPE_VISION_AGENTS = 11;
+     */
+    SdkType[SdkType["VISION_AGENTS"] = 11] = "VISION_AGENTS";
 })(SdkType || (SdkType = {}));
 /**
  * @generated from protobuf enum stream.video.sfu.models.TrackUnpublishReason
@@ -1417,6 +1425,12 @@ var ClientCapability;
      * @generated from protobuf enum value: CLIENT_CAPABILITY_SUBSCRIBER_VIDEO_PAUSE = 1;
      */
     ClientCapability[ClientCapability["SUBSCRIBER_VIDEO_PAUSE"] = 1] = "SUBSCRIBER_VIDEO_PAUSE";
+    /**
+     * Instructs SFU that stats will be sent to the coordinator
+     *
+     * @generated from protobuf enum value: CLIENT_CAPABILITY_COORDINATOR_STATS = 2;
+     */
+    ClientCapability[ClientCapability["COORDINATOR_STATS"] = 2] = "COORDINATOR_STATS";
 })(ClientCapability || (ClientCapability = {}));
 /**
  * DegradationPreference represents the RTCDegradationPreference from WebRTC.
@@ -1882,6 +1896,12 @@ class ClientDetails$Type extends runtime.MessageType {
             { no: 2, name: 'os', kind: 'message', T: () => OS },
             { no: 3, name: 'browser', kind: 'message', T: () => Browser },
             { no: 4, name: 'device', kind: 'message', T: () => Device },
+            {
+                no: 5,
+                name: 'webrtc_version',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
         ]);
     }
 }
@@ -2154,6 +2174,171 @@ class PerformanceStats$Type extends runtime.MessageType {
  * @generated MessageType for protobuf message stream.video.sfu.models.PerformanceStats
  */
 const PerformanceStats = new PerformanceStats$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class RtpBase$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.models.RtpBase', [
+            { no: 1, name: 'ssrc', kind: 'scalar', T: 13 /*ScalarType.UINT32*/ },
+            { no: 2, name: 'kind', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 3,
+                name: 'timestamp_ms',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.RtpBase
+ */
+const RtpBase = new RtpBase$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class InboundRtp$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.models.InboundRtp', [
+            { no: 1, name: 'base', kind: 'message', T: () => RtpBase },
+            {
+                no: 2,
+                name: 'jitter_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 3,
+                name: 'packets_received',
+                kind: 'scalar',
+                T: 4 /*ScalarType.UINT64*/,
+            },
+            {
+                no: 4,
+                name: 'packets_lost',
+                kind: 'scalar',
+                T: 4 /*ScalarType.UINT64*/,
+            },
+            {
+                no: 5,
+                name: 'packet_loss_percent',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 10,
+                name: 'concealment_events',
+                kind: 'scalar',
+                T: 13 /*ScalarType.UINT32*/,
+            },
+            {
+                no: 11,
+                name: 'concealment_percent',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            { no: 20, name: 'fps', kind: 'scalar', T: 1 /*ScalarType.DOUBLE*/ },
+            {
+                no: 21,
+                name: 'freeze_duration_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 22,
+                name: 'avg_decode_time_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 23,
+                name: 'min_dimension_px',
+                kind: 'scalar',
+                T: 13 /*ScalarType.UINT32*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.InboundRtp
+ */
+const InboundRtp = new InboundRtp$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class OutboundRtp$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.models.OutboundRtp', [
+            { no: 1, name: 'base', kind: 'message', T: () => RtpBase },
+            { no: 10, name: 'fps', kind: 'scalar', T: 1 /*ScalarType.DOUBLE*/ },
+            {
+                no: 11,
+                name: 'avg_encode_time_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 12,
+                name: 'bitrate_bps',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 13,
+                name: 'min_dimension_px',
+                kind: 'scalar',
+                T: 13 /*ScalarType.UINT32*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.OutboundRtp
+ */
+const OutboundRtp = new OutboundRtp$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class RemoteInboundRtp$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.models.RemoteInboundRtp', [
+            { no: 1, name: 'base', kind: 'message', T: () => RtpBase },
+            {
+                no: 2,
+                name: 'jitter_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 3,
+                name: 'round_trip_time_s',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.RemoteInboundRtp
+ */
+const RemoteInboundRtp = new RemoteInboundRtp$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class RemoteOutboundRtp$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.models.RemoteOutboundRtp', [
+            { no: 1, name: 'base', kind: 'message', T: () => RtpBase },
+            {
+                no: 2,
+                name: 'jitter_seconds',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+            {
+                no: 3,
+                name: 'round_trip_time_s',
+                kind: 'scalar',
+                T: 1 /*ScalarType.DOUBLE*/,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.RemoteOutboundRtp
+ */
+const RemoteOutboundRtp = new RemoteOutboundRtp$Type();
 
 var models = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -2178,8 +2363,10 @@ var models = /*#__PURE__*/Object.freeze({
     get ErrorCode () { return ErrorCode; },
     get GoAwayReason () { return GoAwayReason; },
     ICETrickle: ICETrickle$1,
+    InboundRtp: InboundRtp,
     InputDevices: InputDevices,
     OS: OS,
+    OutboundRtp: OutboundRtp,
     Participant: Participant,
     ParticipantCount: ParticipantCount,
     get ParticipantSource () { return ParticipantSource; },
@@ -2188,6 +2375,9 @@ var models = /*#__PURE__*/Object.freeze({
     Pin: Pin,
     PublishOption: PublishOption,
     RTMPIngress: RTMPIngress,
+    RemoteInboundRtp: RemoteInboundRtp,
+    RemoteOutboundRtp: RemoteOutboundRtp,
+    RtpBase: RtpBase,
     Sdk: Sdk,
     get SdkType () { return SdkType; },
     StreamQuality: StreamQuality,
@@ -2305,6 +2495,62 @@ class Telemetry$Type extends runtime.MessageType {
  */
 const Telemetry = new Telemetry$Type();
 // @generated message type with reflection information, may provide speed optimized methods
+class SendMetricsRequest$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.SendMetricsRequest', [
+            { no: 1, name: 'session_id', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 2,
+                name: 'unified_session_id',
+                kind: 'scalar',
+                T: 9 /*ScalarType.STRING*/,
+            },
+            {
+                no: 3,
+                name: 'inbounds',
+                kind: 'message',
+                repeat: 2 /*RepeatType.UNPACKED*/,
+                T: () => InboundRtp,
+            },
+            {
+                no: 4,
+                name: 'outbounds',
+                kind: 'message',
+                repeat: 2 /*RepeatType.UNPACKED*/,
+                T: () => OutboundRtp,
+            },
+            {
+                no: 5,
+                name: 'remote_inbounds',
+                kind: 'message',
+                repeat: 2 /*RepeatType.UNPACKED*/,
+                T: () => RemoteInboundRtp,
+            },
+            {
+                no: 6,
+                name: 'remote_outbounds',
+                kind: 'message',
+                repeat: 2 /*RepeatType.UNPACKED*/,
+                T: () => RemoteOutboundRtp,
+            },
+        ]);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.SendMetricsRequest
+ */
+const SendMetricsRequest = new SendMetricsRequest$Type();
+// @generated message type with reflection information, may provide speed optimized methods
+class SendMetricsResponse$Type extends runtime.MessageType {
+    constructor() {
+        super('stream.video.sfu.signal.SendMetricsResponse', []);
+    }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.SendMetricsResponse
+ */
+const SendMetricsResponse = new SendMetricsResponse$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class SendStatsRequest$Type extends runtime.MessageType {
     constructor() {
         super('stream.video.sfu.signal.SendStatsRequest', [
@@ -2578,6 +2824,12 @@ class SendAnswerRequest$Type extends runtime.MessageType {
             },
             { no: 2, name: 'sdp', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
             { no: 3, name: 'session_id', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 4,
+                name: 'negotiation_id',
+                kind: 'scalar',
+                T: 13 /*ScalarType.UINT32*/,
+            },
         ]);
     }
 }
@@ -2685,6 +2937,12 @@ const SignalServer = new runtimeRpc.ServiceType('stream.video.sfu.signal.SignalS
         I: SendStatsRequest,
         O: SendStatsResponse,
     },
+    {
+        name: 'SendMetrics',
+        options: {},
+        I: SendMetricsRequest,
+        O: SendMetricsResponse,
+    },
     {
         name: 'StartNoiseCancellation',
         options: {},
@@ -3365,6 +3623,12 @@ class SubscriberOffer$Type extends runtime.MessageType {
         super('stream.video.sfu.event.SubscriberOffer', [
             { no: 1, name: 'ice_restart', kind: 'scalar', T: 8 /*ScalarType.BOOL*/ },
             { no: 2, name: 'sdp', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+            {
+                no: 3,
+                name: 'negotiation_id',
+                kind: 'scalar',
+                T: 13 /*ScalarType.UINT32*/,
+            },
         ]);
     }
 }
@@ -3823,18 +4087,25 @@ class SignalServerClient {
         const method = this.methods[6], opt = this._transport.mergeOptions(options);
         return runtimeRpc.stackIntercept('unary', this._transport, method, opt, input);
     }
+    /**
+     * @generated from protobuf rpc: SendMetrics(stream.video.sfu.signal.SendMetricsRequest) returns (stream.video.sfu.signal.SendMetricsResponse);
+     */
+    sendMetrics(input, options) {
+        const method = this.methods[7], opt = this._transport.mergeOptions(options);
+        return runtimeRpc.stackIntercept('unary', this._transport, method, opt, input);
+    }
     /**
      * @generated from protobuf rpc: StartNoiseCancellation(stream.video.sfu.signal.StartNoiseCancellationRequest) returns (stream.video.sfu.signal.StartNoiseCancellationResponse);
      */
     startNoiseCancellation(input, options) {
-        const method = this.methods[7], opt = this._transport.mergeOptions(options);
+        const method = this.methods[8], opt = this._transport.mergeOptions(options);
         return runtimeRpc.stackIntercept('unary', this._transport, method, opt, input);
     }
     /**
      * @generated from protobuf rpc: StopNoiseCancellation(stream.video.sfu.signal.StopNoiseCancellationRequest) returns (stream.video.sfu.signal.StopNoiseCancellationResponse);
      */
     stopNoiseCancellation(input, options) {
-        const method = this.methods[8], opt = this._transport.mergeOptions(options);
+        const method = this.methods[9], opt = this._transport.mergeOptions(options);
         return runtimeRpc.stackIntercept('unary', this._transport, method, opt, input);
     }
 }
@@ -5014,6 +5285,16 @@ const hasScreenShareAudio = (p) => p.publishedTracks.includes(TrackType.SCREEN_S
  * @param p the participant.
  */
 const isPinned = (p) => !!p.pin && (p.pin.isLocalPin || p.pin.pinnedAt > 0);
+/**
+ * Check if a participant has a track that is currently interrupted: the
+ * participant intends to publish it (it is in `publishedTracks`) but no
+ * media is flowing right now (it is in `interruptedTracks`).
+ *
+ * @param p the participant to check.
+ * @param trackType the track type to check.
+ */
+const hasInterruptedTrack = (p, trackType) => !!p.interruptedTracks?.includes(trackType) &&
+    p.publishedTracks.includes(trackType);
 /**
  * Check if a participant has a paused track of the specified type.
  *
@@ -6379,7 +6660,7 @@ const getSdkVersion = (sdk) => {
     return sdk ? `${sdk.major}.${sdk.minor}.${sdk.patch}` : '0.0.0-development';
 };
 
-const version = "1.51.0";
+const version = "1.52.0";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -6477,6 +6758,7 @@ const getClientDetails = async () => {
             sdk: sdkInfo,
             os: osInfo,
             device: deviceInfo,
+            webrtcVersion: webRtcInfo?.version || '',
         };
     }
     // @ts-expect-error - userAgentData is not yet in the TS types
@@ -6504,11 +6786,12 @@ const getClientDetails = async () => {
     // Eliminates the generic "Chromium" name and "Not)A_Brand" name from the list.
     // https://wicg.github.io/ua-client-hints/#create-arbitrary-brands-section
     const uaBrowser = userAgentData?.fullVersionList?.find((v) => !v.brand.includes('Chromium') && !v.brand.match(/[()\-./:;=?_]/g));
+    const browserVersion = uaBrowser?.version || browser.version || '';
     return {
         sdk: sdkInfo,
         browser: {
             name: uaBrowser?.brand || browser.name || navigator.userAgent,
-            version: uaBrowser?.version || browser.version || '',
+            version: browserVersion,
         },
         os: {
             name: userAgentData?.platform || os.name || '',
@@ -6521,6 +6804,7 @@ const getClientDetails = async () => {
                 .join(' '),
             version: '',
         },
+        webrtcVersion: browserVersion,
     };
 };
 
@@ -7184,7 +7468,7 @@ class StatsTracer {
     /**
      * Creates a new StatsTracer instance.
      */
-    constructor(pc, peerType, trackIdToTrackType) {
+    constructor(pc, peerType, trackIdToTrackType, statsTimestampDriftThresholdMs = 0) {
         this.previousStats = {};
         this.frameTimeHistory = [];
         this.fpsHistory = [];
@@ -7198,7 +7482,7 @@ class StatsTracer {
          */
         this.get = async () => {
             const stats = await this.pc.getStats();
-            const currentStats = toObject(stats);
+            const currentStats = toObjectWithCorrectedTimestamp(stats, Date.now(), this.driftThresholdMs);
             const performanceStats = this.withOverrides(this.peerType === PeerType.SUBSCRIBER
                 ? this.getDecodeStats(currentStats)
                 : this.getEncodeStats(currentStats));
@@ -7317,17 +7601,28 @@ class StatsTracer {
         this.pc = pc;
         this.peerType = peerType;
         this.trackIdToTrackType = trackIdToTrackType;
+        this.driftThresholdMs = statsTimestampDriftThresholdMs;
     }
 }
 /**
- * Convert the stat report to an object.
+ * Convert the stat report to an object, correcting clock drift along the way.
+ * Entries whose `timestamp` differs from `wallNow` by more than `thresholdMs`
+ * are replaced with a clone whose `timestamp` is set to `wallNow`. The platform
+ * clock backing `DOMHighResTimeStamp` can desynchronise from `Date.now()` after
+ * system sleep or clock-jump events (notably on Electron/Chromium), which
+ * corrupts the delta-compressed stats payload. A non-positive `thresholdMs`
+ * disables correction.
  *
  * @param report the stat report to convert.
+ * @param wallNow current wall-clock time used as the drift reference.
+ * @param thresholdMs maximum tolerated drift in milliseconds.
  */
-const toObject = (report) => {
+const toObjectWithCorrectedTimestamp = (report, wallNow, thresholdMs) => {
     const obj = {};
+    const correct = thresholdMs > 0;
     report.forEach((v, k) => {
-        obj[k] = v;
+        const drift = Math.abs(v.timestamp - wallNow);
+        obj[k] = correct && drift > thresholdMs ? { ...v, timestamp: wallNow } : v;
     });
     return obj;
 };
@@ -7459,7 +7754,7 @@ class BasePeerConnection {
     /**
      * Constructs a new `BasePeerConnection` instance.
      */
-    constructor(peerType, { sfuClient, connectionConfig, state, dispatcher, onReconnectionNeeded, onIceConnected, tag, enableTracing, clientPublishOptions, iceRestartDelay = 2500, }) {
+    constructor(peerType, { sfuClient, connectionConfig, state, dispatcher, onReconnectionNeeded, onIceConnected, tag, enableTracing, clientPublishOptions, iceRestartDelay = 2500, statsTimestampDriftThresholdMs = 0, }) {
         this.iceHasEverConnected = false;
         this.isIceRestarting = false;
         this.isDisposed = false;
@@ -7753,7 +8048,7 @@ class BasePeerConnection {
         this.onIceConnected = onIceConnected;
         this.logger = videoLoggerSystem.getLogger(peerType === PeerType.SUBSCRIBER ? 'Subscriber' : 'Publisher', { tags: [tag] });
         this.pc = this.createPeerConnection(connectionConfig);
-        this.stats = new StatsTracer(this.pc, peerType, this.trackIdToTrackType);
+        this.stats = new StatsTracer(this.pc, peerType, this.trackIdToTrackType, statsTimestampDriftThresholdMs);
         if (enableTracing) {
             this.tracer = new Tracer(`${tag}-${peerType === PeerType.SUBSCRIBER ? 'sub' : 'pub'}`);
             this.tracer.trace('create', {
@@ -8839,6 +9134,7 @@ class Subscriber extends BasePeerConnection {
             await this.sfuClient.sendAnswer({
                 peerType: PeerType.SUBSCRIBER,
                 sdp: answer.sdp || '',
+                negotiationId: subscriberOffer.negotiationId,
             });
             this.isIceRestarting = false;
         };
@@ -14384,7 +14680,7 @@ class Call {
          */
         this.initPublisherAndSubscriber = async (opts) => {
             const { sfuClient, connectionConfig, clientDetails, statsOptions, publishOptions, closePreviousInstances, unifiedSessionId, } = opts;
-            const { enable_rtc_stats: enableTracing } = statsOptions;
+            const { enable_rtc_stats: enableTracing, reporting_interval_ms: reportingIntervalMs, } = statsOptions;
             if (closePreviousInstances && this.subscriber) {
                 await this.subscriber.dispose();
             }
@@ -14395,6 +14691,7 @@ class Call {
                 connectionConfig,
                 tag: sfuClient.tag,
                 enableTracing,
+                statsTimestampDriftThresholdMs: reportingIntervalMs / 2,
                 clientPublishOptions: this.clientPublishOptions,
                 onReconnectionNeeded: (kind, reason, peerType) => {
                     this.reconnect(kind, reason).catch((err) => {
@@ -17036,7 +17333,7 @@ class StreamClient {
         this.getUserAgent = () => {
             if (!this.cachedUserAgent) {
                 const { clientAppIdentifier = {} } = this.options;
-                const { sdkName = 'js', sdkVersion = "1.51.0", ...extras } = clientAppIdentifier;
+                const { sdkName = 'js', sdkVersion = "1.52.0", ...extras } = clientAppIdentifier;
                 this.cachedUserAgent = [
                     `stream-video-${sdkName}-v${sdkVersion}`,
                     ...Object.entries(extras).map(([key, value]) => `${key}=${value}`),
@@ -17762,6 +18059,7 @@ exports.getVideoDevices = getVideoDevices;
 exports.getVideoStream = getVideoStream;
 exports.getWebRTCInfo = getWebRTCInfo;
 exports.hasAudio = hasAudio$1;
+exports.hasInterruptedTrack = hasInterruptedTrack;
 exports.hasPausedTrack = hasPausedTrack;
 exports.hasScreenShare = hasScreenShare;
 exports.hasScreenShareAudio = hasScreenShareAudio;