@stream-io/video-client 1.7.0 → 1.7.2

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.7.2](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.7.1...@stream-io/video-client-1.7.2) (2024-09-20)
+
+
+### Bug Fixes
+
+* overridable bitrate and bitrate downscale factor ([#1493](https://github.com/GetStream/stream-video-js/issues/1493)) ([cce5d8e](https://github.com/GetStream/stream-video-js/commit/cce5d8e641a9182a1779952e4e62aa16ec21ab92))
+
+## [1.7.1](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.7.0...@stream-io/video-client-1.7.1) (2024-09-20)
+
+
+### Bug Fixes
+
+* don't attempt to recover broken WebSockets when there isn't a network connection ([#1490](https://github.com/GetStream/stream-video-js/issues/1490)) ([d576f48](https://github.com/GetStream/stream-video-js/commit/d576f48c7f819d48008359a3c30fe5d1a3372145))
+
 ## [1.7.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.6.5...@stream-io/video-client-1.7.0) (2024-09-19)
 
 

package/dist/index.browser.es.js

@@ -3013,7 +3013,7 @@ const retryable = async (rpc, signal) => {
     return result;
 };
 
-const version = "1.7.0";
+const version = "1.7.2";
 const [major, minor, patch] = version.split('.');
 let sdkInfo = {
     type: SdkType.PLAIN_JAVASCRIPT,
@@ -3290,14 +3290,16 @@ const defaultBitratePerRid = {
  *
  * @param videoTrack the video track to find optimal layers for.
  * @param targetResolution the expected target resolution.
- * @param preferredBitrate the preferred bitrate for the video track.
+ * @param publishOptions the publish options for the track.
  */
-const findOptimalVideoLayers = (videoTrack, targetResolution = defaultTargetResolution, preferredBitrate) => {
+const findOptimalVideoLayers = (videoTrack, targetResolution = defaultTargetResolution, publishOptions) => {
     const optimalVideoLayers = [];
     const settings = videoTrack.getSettings();
     const { width: w = 0, height: h = 0 } = settings;
+    const { preferredBitrate, bitrateDownscaleFactor = 2 } = publishOptions || {};
     const maxBitrate = getComputedMaxBitrate(targetResolution, w, h, preferredBitrate);
     let downscaleFactor = 1;
+    let bitrateFactor = 1;
     ['f', 'h', 'q'].forEach((rid) => {
         // Reversing the order [f, h, q] to [q, h, f] as Chrome uses encoding index
         // when deciding which layer to disable when CPU or bandwidth is constrained.
@@ -3307,11 +3309,12 @@ const findOptimalVideoLayers = (videoTrack, targetResolution = defaultTargetReso
             rid,
             width: Math.round(w / downscaleFactor),
             height: Math.round(h / downscaleFactor),
-            maxBitrate: Math.round(maxBitrate / downscaleFactor) || defaultBitratePerRid[rid],
+            maxBitrate: Math.round(maxBitrate / bitrateFactor) || defaultBitratePerRid[rid],
             scaleResolutionDownBy: downscaleFactor,
             maxFramerate: 30,
         });
         downscaleFactor *= 2;
+        bitrateFactor *= bitrateDownscaleFactor;
     });
     // for simplicity, we start with all layers enabled, then this function
     // will clear/reassign the layers that are not needed
@@ -3371,7 +3374,8 @@ const withSimulcastConstraints = (settings, optimalVideoLayers) => {
         rid: ridMapping[index], // reassign rid
     }));
 };
-const findOptimalScreenSharingLayers = (videoTrack, preferences, defaultMaxBitrate = 3000000) => {
+const findOptimalScreenSharingLayers = (videoTrack, publishOptions, defaultMaxBitrate = 3000000) => {
+    const { screenShareSettings: preferences } = publishOptions || {};
     const settings = videoTrack.getSettings();
     return [
         {
@@ -5152,11 +5156,10 @@ class Publisher {
                 const targetResolution = settings?.video
                     .target_resolution;
                 const screenShareBitrate = settings?.screensharing.target_resolution?.bitrate;
-                const { preferredBitrate, preferredCodec, screenShareSettings } = opts;
                 const videoEncodings = trackType === TrackType.VIDEO
-                    ? findOptimalVideoLayers(track, targetResolution, preferredBitrate)
+                    ? findOptimalVideoLayers(track, targetResolution, opts)
                     : trackType === TrackType.SCREEN_SHARE
-                        ? findOptimalScreenSharingLayers(track, screenShareSettings, screenShareBitrate)
+                        ? findOptimalScreenSharingLayers(track, opts, screenShareBitrate)
                         : undefined;
                 // listen for 'ended' event on the track as it might be ended abruptly
                 // by an external factor as permission revokes, device disconnected, etc.
@@ -5176,6 +5179,7 @@ class Publisher {
                 this.transceiverInitOrder.push(trackType);
                 this.transceiverRegistry[trackType] = transceiver;
                 this.publishOptionsPerTrackType.set(trackType, opts);
+                const { preferredCodec } = opts;
                 const codec = isReactNative() && trackType === TrackType.VIDEO && !preferredCodec
                     ? getRNOptimalCodec()
                     : preferredCodec;
@@ -5494,9 +5498,9 @@ class Publisher {
                     const publishOpts = this.publishOptionsPerTrackType.get(trackType);
                     optimalLayers =
                         trackType === TrackType.VIDEO
-                            ? findOptimalVideoLayers(track, targetResolution, publishOpts?.preferredBitrate)
+                            ? findOptimalVideoLayers(track, targetResolution, publishOpts)
                             : trackType === TrackType.SCREEN_SHARE
-                                ? findOptimalScreenSharingLayers(track, publishOpts?.screenShareSettings)
+                                ? findOptimalScreenSharingLayers(track, publishOpts)
                                 : [];
                     this.trackLayersCache[trackType] = optimalLayers;
                 }
@@ -5887,7 +5891,7 @@ class StreamSfuClient {
     /**
      * Constructs a new SFU client.
      */
-    constructor({ dispatcher, credentials, sessionId, logTag, joinResponseTimeout = 5000, onSignalClose, }) {
+    constructor({ dispatcher, credentials, sessionId, logTag, joinResponseTimeout = 5000, onSignalClose, streamClient, }) {
         /**
          * A buffer for ICE Candidates that are received before
          * the Publisher and Subscriber Peer Connections are ready to handle them.
@@ -5936,6 +5940,7 @@ class StreamSfuClient {
         };
         this.restoreWebSocket = () => {
             withoutConcurrency(this.restoreWebSocketConcurrencyTag, async () => {
+                await this.networkAvailableTask?.promise;
                 this.logger('debug', 'Restoring SFU WS connection');
                 this.cleanUpWebSocket();
                 await sleep(500);
@@ -5959,6 +5964,7 @@ class StreamSfuClient {
         this.dispose = () => {
             this.logger('debug', 'Disposing SFU client');
             this.unsubscribeIceTrickle();
+            this.unsubscribeNetworkChanged();
             clearInterval(this.keepAliveInterval);
             clearTimeout(this.connectionCheckTimeout);
             clearTimeout(this.migrateAwayTimeout);
@@ -6144,6 +6150,16 @@ class StreamSfuClient {
         this.unsubscribeIceTrickle = dispatcher.on('iceTrickle', (iceTrickle) => {
             this.iceTrickleBuffer.push(iceTrickle);
         });
+        // listen to network changes to handle offline state
+        // we shouldn't attempt to recover websocket connection when offline
+        this.unsubscribeNetworkChanged = streamClient.on('network.changed', (e) => {
+            if (!e.online) {
+                this.networkAvailableTask = promiseWithResolvers();
+            }
+            else {
+                this.networkAvailableTask?.resolve();
+            }
+        });
         this.createWebSocket();
     }
     get isHealthy() {
@@ -8368,6 +8384,11 @@ class CameraManagerState extends InputMediaDeviceManagerState {
 }
 
 class CameraManager extends InputMediaDeviceManager {
+    /**
+     * Constructs a new CameraManager.
+     *
+     * @param call the call instance.
+     */
     constructor(call) {
         super(call, new CameraManagerState(), TrackType.VIDEO);
         this.targetResolution = {
@@ -8375,17 +8396,6 @@ class CameraManager extends InputMediaDeviceManager {
             height: 720,
         };
     }
-    /**
-     * The publish options for the camera.
-     *
-     * @internal internal use only, not part of the public API.
-     */
-    get publishOptions() {
-        return {
-            preferredCodec: this.preferredCodec,
-            preferredBitrate: this.preferredBitrate,
-        };
-    }
     /**
      * Select the camera direction.
      *
@@ -8440,16 +8450,33 @@ class CameraManager extends InputMediaDeviceManager {
      * @param codec the codec to use for encoding the video.
      */
     setPreferredCodec(codec) {
-        this.preferredCodec = codec;
+        this.updatePublishOptions({ preferredCodec: codec });
     }
     /**
-     * Sets the preferred bitrate for encoding the video.
+     * Updates the preferred publish options for the video stream.
      *
-     * @internal internal use only, not part of the public API.
-     * @param bitrate the bitrate to use for encoding the video.
+     * @internal
+     * @param options the options to use.
+     */
+    updatePublishOptions(options) {
+        this.publishOptions = { ...this.publishOptions, ...options };
+    }
+    /**
+     * Returns the capture resolution of the camera.
      */
-    setPreferredBitrate(bitrate) {
-        this.preferredBitrate = bitrate;
+    getCaptureResolution() {
+        const { mediaStream } = this.state;
+        if (!mediaStream)
+            return;
+        const [videoTrack] = mediaStream.getVideoTracks();
+        if (!videoTrack)
+            return;
+        const settings = videoTrack.getSettings();
+        return {
+            width: settings.width,
+            height: settings.height,
+            frameRate: settings.frameRate,
+        };
     }
     getDevices() {
         return getVideoDevices();
@@ -9435,6 +9462,7 @@ class Call {
                     logTag: String(this.sfuClientTag++),
                     dispatcher: this.dispatcher,
                     credentials: this.credentials,
+                    streamClient: this.streamClient,
                     // a new session_id is necessary for the REJOIN strategy.
                     // we use the previous session_id if available
                     sessionId: performingRejoin ? undefined : previousSessionId,
@@ -12310,7 +12338,7 @@ class StreamClient {
             });
         };
         this.getUserAgent = () => {
-            const version = "1.7.0";
+            const version = "1.7.2";
             return (this.userAgent ||
                 `stream-video-javascript-client-${this.node ? 'node' : 'browser'}-${version}`);
         };