@opentok/client 2.33.0-alpha.5 → 2.33.0-alpha.6

package/dist/js/opentok.d.ts

@@ -450,6 +450,8 @@ declare namespace OT {
     videoHeight(): number | undefined;
     setVideoMediaProcessorConnector(connector: MediaProcessorConnector | null): Promise<void>;
     setAudioMediaProcessorConnector(connector: MediaProcessorConnector | null): Promise<void>;
+    setPreferredFrameRate(frameRate: number): Promise<void>;
+    setPreferredResolution(resolution: Dimensions): Promise<void>;
   }
 
   export function getUserMedia(

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.33.0 0f415e1d5
+ * @license OpenTok.js 2.33.0 fd056a26b
  *
  * Copyright (c) 2010-2025 TokBox, Inc.
  * Subject to the applicable Software Development Kit (SDK) License Agreement:
  * https://www.vonage.com/legal/communications-apis/terms-of-use/
  *
- * Date: Fri, 21 Nov 2025 12:46:54 GMT
+ * Date: Fri, 21 Nov 2025 13:28:25 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -8603,7 +8603,7 @@ function staticConfigFactory(_temp) {
     _ref$axios = _ref.axios,
     axios = _ref$axios === void 0 ? _axios.default : _ref$axios,
     _ref$properties = _ref.properties,
-    properties = _ref$properties === void 0 ? {"version":"v2.33.0","buildHash":"0f415e1d5","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com","vonageApiURL":""} : _ref$properties;
+    properties = _ref$properties === void 0 ? {"version":"v2.33.0","buildHash":"fd056a26b","minimumVersion":{"firefox":52,"chrome":49},"debug":false,"websiteURL":"http://www.tokbox.com","configURL":"https://config.opentok.com","ipWhitelistConfigURL":"","cdnURL":"","loggingURL":"https://hlg.tokbox.com/prod","apiURL":"https://anvil.opentok.com","vonageApiURL":""} : _ref$properties;
   /** @type builtInConfig */
   const builtInConfig = (0, _cloneDeep.default)(properties);
   /**
@@ -18051,6 +18051,10 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 const defaultWidgetView = (0, _widget_view.default)();
 const _allDeviceHelpers = (0, _deviceHelpers.default)(),
   getInputMediaDevices = _allDeviceHelpers.getInputMediaDevices;
+const publisherDefaultResolution = {
+  width: 640,
+  height: 480
+};
 function PublisherFactory(_ref) {
   if (_ref === void 0) {
     _ref = {};
@@ -18217,6 +18221,9 @@ function PublisherFactory(_ref) {
     let _migrationTimeoutId;
     let _previousPeerConnection;
     let _videoMaxBitrateSetting;
+    let _preferredWidth;
+    let _preferredHeight;
+    let _preferredFrameRate;
     let _peerId;
     let _raptorUri;
     let publisherSenderStats;
@@ -18629,8 +18636,8 @@ function PublisherFactory(_ref) {
       // Values order are:
       //   - Defined by the user.
       //   - Default: VGA (640x480).
-      let width = ((_properties$videoDime = properties.videoDimensions) == null ? void 0 : _properties$videoDime.width) || 640;
-      let height = ((_properties$videoDime2 = properties.videoDimensions) == null ? void 0 : _properties$videoDime2.height) || 480;
+      let width = ((_properties$videoDime = properties.videoDimensions) == null ? void 0 : _properties$videoDime.width) || publisherDefaultResolution.width;
+      let height = ((_properties$videoDime2 = properties.videoDimensions) == null ? void 0 : _properties$videoDime2.height) || publisherDefaultResolution.height;
       if (properties.publishVideo) {
         var _widgetView2;
         // When video is on, we get the real video dimensions. If undefined, we will take the
@@ -24055,6 +24062,82 @@ function PublisherFactory(_ref) {
         return _ref62.apply(this, arguments);
       };
     }();
+    const applyVideoConstraints = () => {
+      const constraints = {
+        width: {
+          ideal: _preferredWidth
+        },
+        height: {
+          ideal: _preferredHeight
+        },
+        frameRate: {
+          ideal: _preferredFrameRate
+        }
+      };
+      return webRTCStream.getVideoTracks().at(0).applyConstraints(constraints);
+    };
+
+    /**
+     * @brief Sets the preferred video resolution.
+     *
+     * This function sets the preferred resolution for the video publisher.
+     * It validates that the input is an object with positive integer width and height properties,
+     * and verifies the resolution is not greater than the initial publishing resolution.
+     * If successful, applies the new constraints to the video track.
+     *
+     * @param {Object} preferredResolution - The desired resolution.
+     * @param {number} preferredResolution.width - Preferred video width (pixels).
+     * @param {number} preferredResolution.height - Preferred video height (pixels).
+     *
+     * @throws {Error} If not called on a video publisher, if the dimensions are invalid,
+     *                 or if the resolution exceeds the initial resolution.
+     *
+     * @returns {Promise} Resolves when video constraints are successfully applied.
+     */
+    this.setPreferredResolution = preferredResolution => {
+      var _webRTCStream, _webRTCStream$getVide6, _properties$videoDime3, _properties$videoDime4;
+      if (!properties.publishVideo || !((_webRTCStream = webRTCStream) != null && (_webRTCStream$getVide6 = _webRTCStream.getVideoTracks()) != null && _webRTCStream$getVide6.length)) {
+        throw new Error('setPreferredResolution needs to be called on a video publisher');
+      }
+      if (!preferredResolution || !Number.isInteger(preferredResolution.width) || preferredResolution.width <= 0 || !Number.isInteger(preferredResolution.height) || preferredResolution.height <= 0) {
+        throw new Error('preferredResolution must be an object with positive integer width and height properties');
+      }
+      const startingWidth = ((_properties$videoDime3 = properties.videoDimensions) == null ? void 0 : _properties$videoDime3.width) || publisherDefaultResolution.width;
+      const startingHeight = ((_properties$videoDime4 = properties.videoDimensions) == null ? void 0 : _properties$videoDime4.height) || publisherDefaultResolution.height;
+      const startingArea = startingWidth * startingHeight;
+      const preferredArea = preferredResolution.width * preferredResolution.height;
+      if (preferredArea > startingArea) {
+        throw new Error('preferredResolution cannot be higher than the initial ' + 'publishing resolution');
+      }
+      _preferredWidth = preferredResolution.width;
+      _preferredHeight = preferredResolution.height;
+      return applyVideoConstraints();
+    };
+
+    /**
+     * @brief Sets the preferred video frame rate.
+     *
+     * This function sets the desired frame rate for video publishing.
+     * The frame rate must be an integer ≥ 1.
+     * If successful, applies the new frame rate constraints to the video track.
+     *
+     * @param {number} frameRate - The preferred video frame rate.
+     *
+     * @throws {Error} If not called on a video publisher or if frameRate is invalid.
+     *
+     * @returns {Promise} Resolves when video constraints are successfully applied.
+     */
+    this.setPreferredFrameRate = frameRate => {
+      var _webRTCStream2, _webRTCStream2$getVid;
+      if (!properties.publishVideo || !((_webRTCStream2 = webRTCStream) != null && (_webRTCStream2$getVid = _webRTCStream2.getVideoTracks()) != null && _webRTCStream2$getVid.length)) {
+        throw new Error('setPreferredFrameRate needs to be called on a video publisher');
+      }
+      if (!Number.isInteger(frameRate) || frameRate < 1) {
+        throw new Error('Invalid frameRate: must be an integer ≥ 1');
+      }
+      _preferredFrameRate = frameRate;
+      return applyVideoConstraints();
+    };
 
     /**
      * Sets a custom maximum video bitrate for the publisher.