@opentok/client 2.31.0-alpha.16 → 2.31.0-alpha.18

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.31.0 fdce7b294
+ * @license OpenTok.js 2.31.0 5c539da4c
  *
  * 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: Mon, 28 Jul 2025 16:40:47 GMT
+ * Date: Tue, 29 Jul 2025 09:25:53 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -8682,7 +8682,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.31.0","buildHash":"fdce7b294","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"});
+const builtInConfig = (0, _cloneDeep.default)({"version":"v2.31.0","buildHash":"5c539da4c","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"});
 const whitelistAllowedRuntimeProperties = (0, _pick.default)(['apiURL', 'assetURL', 'cdnURL', 'sessionInfoOverrides', 'loggingURL']);
 const liveConfigMap = {
   apiUrl: 'apiURL',
@@ -22258,7 +22258,7 @@ function PublisherFactory(_ref) {
      * </p>
      *
      * <p>
-     * <em>Note:</em> Video filters are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> Video filters are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -22528,7 +22528,7 @@ function PublisherFactory(_ref) {
      * </p>
      *
      * <p>
-     * <em>Note:</em> Audio filters are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> Audio filters are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -22809,7 +22809,7 @@ function PublisherFactory(_ref) {
      * </p>
      *
      * <p>
-     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -22968,7 +22968,7 @@ function PublisherFactory(_ref) {
      * connector, the previously set audio connector is removed.
      *
      * <p>
-     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -23277,28 +23277,24 @@ function PublisherFactory(_ref) {
     }();
 
     /**
-    * Returns the publisher's properties.videoMaxBitrate value.
-    *
-    * Get the customer's custom maximum bitrate value used to set the
-    * maxBitrate value for each of the encoding RTCP sender elements.
+    * Returns the custom maximum bitrate set for the Publisher.
     *
     * @return {Integer} One of the following values: 0, or any integer value
-    *   within 5000 and 10000000.
+    *   within 5,000 and 10,000,000.
     * @see <a href="#setMaxVideoBitrate">Publisher.setMaxVideoBitrate()</a>
+    * @see <a href="https://tokbox.com/developer/guides/publisher-max-bitrate/js">Publisher Max Bitrate</a>
     * @method #getMaxVideoBitrate
     * @memberOf Publisher
     */
     this.getMaxVideoBitrate = () => properties.videoMaxBitrate;
 
     /**
-    * Returns the publisher's properties.videoBitratePreset value.
-    *
-    * Get the customer's bitrate preset value used to set the maxBitrate
-    * value for each of the encoding RTCP sender elements.
+    * Returns the bitrate preset for the Publisher.
     *
     * @return {String} One of the following values:  'custom', 'extra_bw_saver',
     *   'bw_saver' or 'default'
     * @see <a href="#setVideoBitratePreset">Publisher.setVideoBitratePreset()</a>
+    * @see <a href="https://tokbox.com/developer/guides/publisher-max-bitrate/js">Publisher Max Bitrate</a>
     * @method #getVideoBitratePreset
     * @memberOf Publisher
     */
@@ -23384,26 +23380,21 @@ function PublisherFactory(_ref) {
     }();
 
     /**
-     * Sets the publisher's maxBitrate value/s that will be distributed to each of
-     * the encoding RTCP sender elements when the customer has set a valid integer value,
-     * i.e., a value that can be 0 or a value that is between 5000 and 10000000.
-     * <p>
-     * Use this method to change the video maximum bitrate dynamically.
-     * Set the initial video maxBitrate hit by setting an integer value
-     * <code>bitrateBps</code> value. If the values have been updated property, the
-     * publisher's properties.videoMaxBitrate and properties.videoBitratePreset
-     * will be updated accordingly, i.e., properties.videoMaxBitrate will be equal to
-     * bitrateBps and properties.videoBitratePreset will be equal to 'custom' only if
-     * bitrateBps is different to 0. Otherwise,  properties.videoBitratePreset will be
-     * equal to VideoBitratePreset.default.
-     * <a href="OT.html#initPublisher">OT.initPublisher()</a> method.
+     * Sets a custom maximum video bitrate for the publisher.
+     * Set this to a value between 5,000 and 10,000,000.
+     * Setting the value to 0 removes any previously set custom
+     * bitrate, reverting to the default behavior.
      * <p>
-     * At least, Chrome 129+, Safari 18.3+, Firefox 136+ support video maxBitrate.
+     * Setting the maximum bitrate is supported in the
+     * most recent versions of all supported browsers.
+     *
+     * @param {Integer} bitrateBps The video bitrate value -- between
+     * 5,000 and 10,000,000. Set to 0 to remove a custom bitrate
+     * setting and revert to the default behavior.
      *
-     * @param {Integer} bitrateBps
      * @see <a href="#getMaxVideoBitrate">Publisher.getMaxVideoBitrate()</a>
-     * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
-     * @see properties.videoMaxBitrate
+     * @see <a href="#setVideoBitratePreset">Publisher.setVideoBitratePreset()</a>
+     * @see <a href="https://tokbox.com/developer/guides/publisher-max-bitrate/js">Publisher Max Bitrate</a>
      * @method #setMaxVideoBitrate
      * @memberOf Publisher
      */
@@ -23450,24 +23441,19 @@ function PublisherFactory(_ref) {
     }();
 
     /**
-     * Sets the publisher's maxBitrate value/s that will be distributed to each of
-     * the encoding RTCP sender elements when the customer has set a valid bitrate
-     * preset value, i.e., 'default', 'bw_saver', or 'extra_bw_saver'.
-     * <p>
-     * Use this method to change the video maximum bitrate dynamically.
-     * Set the initial video maxBitrate hit by setting a valid bitrate preset value
-     * <code>preset</code> value. If the values have been updated property, the
-     * publisher's properties.videoMaxBitrate and properties.videoBitratePreset
-     * will be updated accordingly, i.e., properties.videoMaxBitrate will be equal to
-     * 0 and properties.videoBitratePreset will be equal to the introduced preset.
-     * <a href="OT.html#initPublisher">OT.initPublisher()</a> method.
+     * Sets the maximum video bitrate for the publisher to one of the
+     * following  presets: 'default', 'bw_saver', or 'extra_bw_saver'.
+     * For details, see the
+     * <a href="https://tokbox.com/developer/guides/publisher-max-bitrate/js">Publisher Max Bitrate</a>
+     * developer guide.
      * <p>
-     * At least, Chrome 129+, Safari 18.3+, Firefox 136+ support video maxBitrate.
+     * Setting the maximum bitrate is supported in the
+     * most recent versions of all supported browsers.
+     *
+     * @param {String} preset The preset to use: either 'default', 'bw_saver', or 'extra_bw_saver'.
      *
-     * @param {String} preset
      * @see <a href="#getVideoBitratePreset">Publisher.getVideoBitratePreset()</a>
-     * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
-     * @see properties.videoBitratePreset
+     * @see <a href="#setMaxVideoBitrate">Publisher.setMaxVideoBitrate()</a>
      * @method #setVideoBitratePreset
      * @memberOf Publisher
      */
@@ -24344,8 +24330,9 @@ const validPropertyNames = ['name', 'archiving'];
  * <code>OT.initPublisher()</code> method; otherwise, this property is undefined.
  *
  * @property {Boolean} hasCaptions Whether the stream has captions. This property can change if the
- * publisher turns on or off captions (by calling
- * <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a>). When this occurs, the
+ * publisher turns captions on or off (by calling the
+ * <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a>
+ * method). When this occurs, the
  * {@link Session} object dispatches a <code>streamPropertyChanged</code> event (see
  * {@link StreamPropertyChangedEvent}).
  *
@@ -40554,7 +40541,7 @@ function SubscriberFactory(_ref2) {
     * subscribing to captions (if it is currently being subscribed to) when the <code>value</code>
     * is <code>false</code>.
     * <p>
-    * The initial value can be set by specifying the <code>subscribeToCaptions</code>
+    * The initial value can be set by setting the <code>subscribeToCaptions</code>
     * property of the <code>options</code> parameter of the <a href="Session.html#subscribe">Session.subscribe()</a>
     * method. The default value is the <code>hasCaptions</code> property of the stream’s publisher at the time of
     * subscriber initialization (see the
@@ -40605,8 +40592,9 @@ function SubscriberFactory(_ref2) {
     }();
 
     /**
-     * Whether the subscriber is receiving captions. This property can change if the subscriber turns on
-     * or off captioning (by calling <code>Subscriber.subscribeToCaptions()</code>). The default value is
+     * Whether the subscriber is receiving captions. This property can change if the subscriber turns captioning on
+     * or off (by calling the <code>Subscriber.subscribeToCaptions()</code>
+     * method). The default value is
      * the <code>hasCaptions</code> property of the stream’s publisher at the time of subscriber initialization (see the
      * <a href="https://tokbox.com/developer/sdks/js/reference/Stream.html#properties">Stream.hasCaptions property</a>).
      * <p>
@@ -40710,7 +40698,7 @@ function SubscriberFactory(_ref2) {
      * connector, the previously set video connector is removed.
      *
      * <p>
-     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -40900,7 +40888,7 @@ function SubscriberFactory(_ref2) {
      * connector, the previously set audio connector is removed.
      *
      * <p>
-     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+     * <em>Note:</em> MediaProcessors are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
      * They are not supported in other (non-Chromium-based) browsers or on iOS.  You can check if the client
      * supports this feature by calling the
      * <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -42840,7 +42828,7 @@ function initPublisherFactory(deps) {
   *     </p>
   *   </li>
   * </ul>
-  *   <em>Note:</em> Audio filters are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+  *   <em>Note:</em> Audio filters are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
   *   They are not supported in other (non-Chromium-based) browsers or on iOS. You can check if the client
   *   supports this feature by calling the
   *   <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -43295,7 +43283,7 @@ function initPublisherFactory(deps) {
   *       </p>
   *     </li>
   *   </ul>
-  *   <em>Note:</em> Video filters are only supported in recent versions of Chrome, Electron, Opera, Edge and Samsung Internet.
+  *   <em>Note:</em> Video filters are only supported in recent versions of Chrome, Electron, Opera, Edge, and Samsung Internet.
   *   They are not supported in other (non-Chromium-based) browsers or on iOS. You can check if the client
   *   supports this feature by calling the
   *   <a href="OT.html#hasMediaProcessorSupport">OT.hasMediaProcessorSupport()</a> method.
@@ -84797,9 +84785,6 @@ function initSessionFactory(deps) {
   *   allowing the client to to remain connected during server rotation. The default value is <code>false</code>
   *   (session migration is not enabled). For more information, see
   *   <a href="https://tokbox.com/developer/guides/server-rotation/">Server Rotation and Session Migration</a>.
-  *   <p>
-  *   <i>This is a beta feature.</i>
-  *   </p>
   *   </li>
   * </ul>
   *