@unboundcx/video-sdk-client 2.0.4 → 2.0.6

package/managers/LocalMediaManager.js

@@ -366,6 +366,14 @@ export class LocalMediaManager extends EventEmitter {
 			// Get display media
 			// Note: Audio is only available when sharing a Chrome Tab or Window (not Screen)
 			// Chrome will show an audio checkbox for Tab and Window sharing if audio is requested
+			//
+			// Keep video constraints minimal — only the `cursor` hint. Some
+			// Chrome versions reject frameRate / width / height on
+			// getDisplayMedia and abort the capture with an opaque
+			// "Error starting tab capture", so we let the browser pick the
+			// source's native resolution + framerate. Bandwidth is bounded
+			// downstream by the encoder profile in MediasoupManager
+			// (single-layer, max 8 Mbps, maintain-resolution preference).
 			const constraints = {
 				video: {
 					cursor: 'always',

package/managers/MediasoupManager.js

@@ -509,6 +509,77 @@ export class MediasoupManager extends EventEmitter {
         const baseWidth = settings.width || 1920;
         const baseHeight = settings.height || 1080;
 
+        const isScreenShare = options.appData?.type === "screenShare";
+
+        // ───────────────────────────────────────────────────────────
+        // Screen-share encoder profile
+        //
+        // Screen content is fundamentally different from camera:
+        //   - Mostly static (text, UI, diagrams) with occasional motion
+        //   - Text legibility is binary — readable or not, no in-between
+        //   - Receivers either need to read it or they're zoomed out
+        //
+        // So: single high-quality layer (not 3-tier simulcast), much
+        // higher max bitrate per pixel, lower framerate target (the
+        // encoder handles this via degradationPreference + the actual
+        // capture frame rate, which Chrome lowers automatically for
+        // static content). Also set contentHint='detail' on the
+        // track itself so the encoder favours sharpness over motion.
+        // ───────────────────────────────────────────────────────────
+        if (isScreenShare) {
+          try {
+            track.contentHint = "detail";
+          } catch (err) {
+            this.logger.warn("Could not set contentHint on screenshare track:", err);
+          }
+          // If the captured source is bigger than 1920×1080 (4K monitor,
+          // Retina display, etc.) scale it down before encoding so we
+          // don't waste CPU on pixels nobody will see. Encode at the
+          // larger of the two dimension ratios so neither dimension
+          // exceeds 1920×1080.
+          const maxW = 1920;
+          const maxH = 1080;
+          const scaleDown = Math.max(
+            1.0,
+            baseWidth / maxW,
+            baseHeight / maxH,
+          );
+          const encWidth = Math.round(baseWidth / scaleDown);
+          const encHeight = Math.round(baseHeight / scaleDown);
+
+          // Bitrate budget tuned for text crispness: ~5 Mbps at 1080p,
+          // ~3 Mbps at 720p, scaled linearly for unusual sizes. Cap
+          // upper at 8 Mbps so a huge external monitor doesn't blow
+          // through user bandwidth.
+          const encPixels = encWidth * encHeight;
+          const bitrate = Math.min(
+            8_000_000,
+            Math.max(2_000_000, Math.round(encPixels * 2.5)),
+          );
+          produceOptions.encodings = [
+            {
+              rid: "h",
+              maxBitrate: bitrate,
+              scaleResolutionDownBy: scaleDown,
+            },
+          ];
+          // degradationPreference="maintain-resolution" tells WebRTC
+          // to drop framerate before resolution if bandwidth tightens
+          // — exactly what we want for text.
+          produceOptions.degradationPreference = "maintain-resolution";
+          this.logger.info("VIDEO_QUALITY :: screen-share encoder profile", {
+            sourceResolution: `${baseWidth}×${baseHeight}`,
+            encodedResolution: `${encWidth}×${encHeight}`,
+            scaleDown: scaleDown.toFixed(2),
+            bitrate: `${(bitrate / 1_000_000).toFixed(1)}Mbps`,
+            contentHint: track.contentHint,
+            degradationPreference: "maintain-resolution",
+          });
+          // Skip the camera simulcast branches below.
+          // (Falls through to the produceOptions logging.)
+          // No `return` — we still want to call transport.produce().
+        } else {
+
         // Check if user has set a max resolution preference
         const maxResolution = options.maxResolution || "1080p"; // Default to 1080p
 
@@ -584,6 +655,7 @@ export class MediasoupManager extends EventEmitter {
             bitrate: "800kbps",
           });
         }
+        } // end camera-profile else (matches `if (isScreenShare)`)
       }
 
       this.logger.info("Calling transport.produce with options:", {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@unboundcx/video-sdk-client",
-	"version": "2.0.4",
+	"version": "2.0.6",
 	"description": "Framework-agnostic WebRTC video meeting SDK powered by mediasoup",
 	"type": "module",
 	"main": "index.js",