@opentok/client 2.28.6-alpha.1 → 2.28.6-alpha.10

package/dist/js/opentok.d.ts

@@ -577,6 +577,7 @@ declare namespace OT {
       iceConfig?: IceConfig;
       ipWhitelist?: boolean;
       encryptionSecret?: string;
+      singlePeerConnection?: boolean;
     }
   ): Session;
 

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.28.6 cfc9630
+ * @license OpenTok.js 2.28.6 79b0e69
  *
- * Copyright (c) 2010-2024 TokBox, Inc.
+ * 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: Thu, 12 Dec 2024 15:37:43 GMT
+ * Date: Thu, 09 Jan 2025 17:44:11 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -3738,32 +3738,43 @@ function EventsFactory(deps) {
   };
 
   /**
-   * The Session object dispatches a cpuPerformanceChanged event when the CPU performance state has been changed
-   * The event will only be dispatched on Chromium browsers (Chrome 125+, Edge 125+, and Opera 111+).
-   * Events will not be dispatched after disconnecting from a Session, but will resume after reconnecting.
-   * This is a <b>beta</b> feature.
+   * The Session object dispatches a <code>cpuPerformanceChanged</code> event
+   * when the CPU performance state changes.
+   * The event is only dispatched on Chromium browsers (Chrome 125+, Edge 125+, and Opera 111+).
+   * Events are not dispatched after disconnecting from a session, but they resume after reconnecting.
    *
-   * @property {cpuPerformanceState} cpuPerformanceState The new cpuPerformanceState. The cpuPerformanceState can
-   * be one the following: "nominal", "fair", "serious", or "critical";
+   * @property {String} cpuPerformanceState The new CPU performance state. The CPU performance state can
+   * be one the following: "nominal", "fair", "serious", or "critical".
+   * (See <a href="https://w3c.github.io/compute-pressure/#pressure-states">this W3C specification</a>.)
    *
+   * @see <a href="Session.html#event:cpuPerformanceChanged">Session cpuPerformanceChanged event</a>
+   * @class CpuPerformanceChangedEvent
+   * @augments Event
    */
-  Events.CpuPerformanceChanged = function CpuPerformanceChanged(cpuPerformanceState) {
+  Events.CpuPerformanceChangedEvent = function CpuPerformanceChangedEvent(cpuPerformanceState) {
     return new _Event4.default('cpuPerformanceChanged', false, {
       cpuPerformanceState
     });
   };
 
   /**
-   * The Subscriber object dispatches a qualityScoreChanged event when either the audio or video quality
-   * score has changed. The scores are a heuristic value representing the expected subscriber experience. The values
-   * range from 5 to 1, with the integer values corresponding to Excellent | Good | Fair | Poor | Bad.
-   * This is a <b>beta</b> feature.
+   * The Subscriber object dispatches a <code>qualityScoreChanged</code>
+   * event when either the audio or video quality score changes for the subscriber.
+   * The scores are a heuristic value representing the expected subscriber experience.
+   * The values are integers ranging from 1 to 5, with the values corresponding to
+   * bad, poor, fair, good, and excellent.
+   *
+   * @class QualityScoreChangedEvent
+   * @augments Event
+   * @see <a href="Subscriber.html#event:qualityScoreChanged">Subscriber qualityScoreChanged event</a>
    *
-   * @property {QualityScore} qualityScore most recent quality score. The event contains
-   * a qualityScore object with optional audio and video properties.
+   * @property {Object} qualityScore The current quality score for the subscriber.
+   * The event contains two properties: <code>audioQualityScore</code>
+   * and <code>videoQualityScore</code>. These properties are undefined if there
+   * is either no audio or no video.
    *
    */
-  Events.QualityScoreChanged = function qualityScoreChanged(qualityScore) {
+  Events.QualityScoreChangedEvent = function qualityScoreChanged(qualityScore) {
     return new _Event4.default('qualityScoreChanged', false, {
       qualityScore
     });
@@ -3798,7 +3809,6 @@ function EventsFactory(deps) {
   };
 
   /**
-   * This is a <b>beta</b> feature.
    * Defines an event object for the <code>mediaStreamAvailable</code> event dispatched by both
    * the Publisher and Subscriber objects. The Publisher and Subscriber objects both dispatch a <code>mediaStreamAvailable</code>
    * event when the MediaStream is available to be used in custom video elements. The Publisher and Subscriber objects should still be used to
@@ -3812,9 +3822,10 @@ function EventsFactory(deps) {
    *   event</a>
    * @see <a href="Subscriber.html#event:mediaStreamAvailable">Subscriber mediaStreamAvailable
    *   event</a>
+   * @class MediaStreamAvailableEvent
    * @augments Event
    */
-  Events.MediaStreamAvailable = function MediaStreamAvailable(mediaStream) {
+  Events.MediaStreamAvailableEvent = function MediaStreamAvailableEvent(mediaStream) {
     return new _Event4.default('mediaStreamAvailable', false, {
       mediaStream
     });
@@ -3896,9 +3907,7 @@ function EventsFactory(deps) {
    *       setting the <code>videoDisabledDisplayMode</code> property, or you can set the
    *       <code>videoDisabledDisplayMode</code> property when
    *       calling the <code>OT.initPublisher()</code> method and setting the <code>style</code> property
-   *       of the <code>properties</code> parameter.
-   *       <p>
-   *       This is a beta feature.</li>
+   *       of the <code>properties</code> parameter.</li>
    *     </ul>
    *   </li>
    *
@@ -3954,16 +3963,18 @@ function EventsFactory(deps) {
   };
 
   /**
-   * Dispatched when the audio input device is changed. This is a <b>beta</b> feature.
+   * Dispatched when the audio input device is changed.
    *
-   * @property {Object} device The audio input device. Contains a deviceId and label.
+   * <p> For more information, see <a href="https://tokbox.com/developer/guides/audio-video/js/#audioInputDeviceChanged">this documentation</a>.
+   * @property {Object} device The audio input device.
+   * This object has a <code>deviceId</code> property and a <code>label</code> property (both strings).
    *
    * @see <a href="Publisher.html#event:audioInputDeviceChanged">Publisher audioInputDeviceChanged event</a></p>
    * @see <a href="Publisher.html#setAudioSource">Publisher.setAudioSource()</a></p>
-   * @class AudioInputDeviceChanged
+   * @class AudioInputDeviceChangedEvent
    * @augments Event
    */
-  Events.AudioInputDeviceChanged = function AudioInputDeviceChanged(device) {
+  Events.AudioInputDeviceChangedEvent = function AudioInputDeviceChangedEvent(device) {
     return new _Event4.default(_eventNames.default.AUDIO_INPUT_DEVICE_CHANGED, false, {
       device
     });
@@ -8107,7 +8118,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.28.6","buildHash":"cfc9630","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.28.6","buildHash":"79b0e69","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',
@@ -18690,7 +18701,7 @@ function PublisherFactory(_ref) {
           }
         });
         widgetView.on('videoElementCreated', element => {
-          this.dispatchEvent(new Events.MediaStreamAvailable(webRTCStream));
+          this.dispatchEvent(new Events.MediaStreamAvailableEvent(webRTCStream));
           const event = new Events.VideoElementCreatedEvent(element);
           this.dispatchEvent(event);
         });
@@ -19435,7 +19446,7 @@ function PublisherFactory(_ref) {
     * @param {function} callback (Optional) A function that takes in an <code><a href="Error.html">Error</a></code>
     * parameter. Upon successful completion of the method, this <code>error</code> parameter is undefined.
     * An error results if the publisher has no devices to provide the media stream or if the user media
-    * request is not supported. <i>Note:</i> this is a beta feature.
+    * request is not supported.
     *
     * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
     * @see <a href="Stream.html#hasVideo">Stream.hasVideo</a>
@@ -21721,7 +21732,7 @@ function PublisherFactory(_ref) {
     this.getVideoFilter = () => {
       logAnalyticsEvent('getVideoFilter', 'Attempt');
       logAnalyticsEvent('getVideoFilter', 'Success');
-      return currentVideoFilter || null;
+      return currentVideoFilter !== undefined ? currentVideoFilter : null;
     };
 
     /**
@@ -22467,7 +22478,6 @@ function PublisherFactory(_ref) {
   * app from having access to the camera and microphone.
   * <p>
   * This event is also dispatched if the user removes the permissions after previously granting them.
-  * This is a beta feature.
   * <p>
   * <i>Note:</i> On macOS 10.15+ (Catalina), to publish a screen-sharing stream
   * the user must grant the browser access to the screen in macOS System Preferences &gt;
@@ -22490,7 +22500,6 @@ function PublisherFactory(_ref) {
   */
 
   /**
-  * This is a <b>beta</b> feature.
   * Dispatched when the MediaStream is available.
   * @see Event
   * @name mediaStreamAvailable
@@ -22510,11 +22519,8 @@ function PublisherFactory(_ref) {
   /**
    * Dispatched when the audio input device is changed.
    *
-   * <p>
-   * This is a beta feature.
-   *
    * @see Event
-   * @see AudioInputDeviceChanged
+   * @see AudioInputDeviceChangedEvent
    * @name audioInputDeviceChanged
    * @event
    * @memberof Publisher
@@ -22622,8 +22628,6 @@ function PublisherFactory(_ref) {
    *   <a href="OT.html#initPublisher">OT.initPublisher()</a>.)</li>
    *
    * </ul>
-   * <p>
-   * This is a beta feature.
    *
    * @see Event
    * @see <a href="Publisher.html#event:videoDisableWarning">videoDisableWarning</a> event
@@ -22645,8 +22649,6 @@ function PublisherFactory(_ref) {
    * <code>videoDisabledDisplayMode</code> property when calling the
    * <code>OT.initPublisher()</code> method and setting the <code>style</code> property
    * of the <code>properties</code> parameter.
-   * <p>
-   * This is a beta feature.
    *
    * @see Event
    * @see <a href="Publisher.html#event:videoDisabled">videoDisabled</a> event
@@ -22660,8 +22662,6 @@ function PublisherFactory(_ref) {
    * Dispatched when the Publisher determines that the stream quality has improved
    * to the point at which the video being disabled is not an immediate risk. This event is
    * dispatched after the Publisher object dispatches a <code>videoDisableWarning</code> event.
-   * <p>
-   * This is a beta feature.
    *
    * @see Event
    * @see <a href="Publisher.html#event:videoDisableWarning">videoDisableWarning</a> event
@@ -22696,9 +22696,6 @@ function PublisherFactory(_ref) {
    * Dispatched when the Publisher resumes sending video to the publisher
    * after video was previously disabled.
    *
-   * <p>
-   * This is a beta feature.
-   *
    * @see Event
    * @see <a href="Publisher.html#event:videoDisabled">videoDisabled</a> event
    * @name videoEnabled
@@ -52825,8 +52822,9 @@ function Analytics(_ref) {
           logging.debug('Failed to send ClientEvent, moving on to the next item.');
         }
         onComplete(err || undefined);
-        callback();
       });
+      // Invoke the callback here to move on to the next item in the queue
+      callback();
     });
   };
   const shouldThrottleError = (code, type, partnerId) => {
@@ -59462,7 +59460,7 @@ function SubscriberFactory(_ref2) {
               _session2 = _session, sessionInfo = _session2.sessionInfo;
               if (!_exposedWebRTCStream) {
                 _exposedWebRTCStream = new MediaStream(webRTCStream);
-                _this.dispatchEvent(new Events.MediaStreamAvailable(_exposedWebRTCStream));
+                _this.dispatchEvent(new Events.MediaStreamAvailableEvent(_exposedWebRTCStream));
               }
               _webRTCStream = webRTCStream;
 
@@ -62241,7 +62239,6 @@ function SubscriberFactory(_ref2) {
     */
 
     /**
-    * This is a <b>beta</b> feature.
     * Dispatched when the MediaStream is available.
     * @see Event
     * @name mediaStreamAvailable
@@ -62393,11 +62390,11 @@ function SubscriberFactory(_ref2) {
     * Dispatched when either the audio or video quality
     * score has changed. The scores are a heuristic value representing the expected subscriber experience. The values
     * range from 5 to 1, with the integer values corresponding to Excellent | Good | Fair | Poor | Bad.
-    * This is a <b>beta</b> feature.
-     * @name qualityScoreChanged
+    *
+    * @name qualityScoreChanged
     * @event
     * @memberof Subscriber
-    * @see qualityScoreChangedEvent
+    * @see QualityScoreChangedEvent
     */
     return this;
   };
@@ -63534,8 +63531,6 @@ function initPublisherFactory(deps) {
   *     <a href="Publisher.html#event:videoDisableWarning">videoDisableWarning</a>,
   *     <a href="Publisher.html#event:videoDisableWarningLifted">videoDisableWarningLifted</a>, and
   *     <a href="Publisher.html#event:videoEnabled">videoEnabled</a> events.
-  *     <p>
-  *     This is a beta feature.
   *     </li>
   *
   *     <li><code>subscriber</code> (Boolean) &mdash; Whether the stream will use the
@@ -63955,8 +63950,6 @@ function initPublisherFactory(deps) {
   *       displayed video is disabled or at risk of being disabled due to poor stream quality),
   *       <code>"off"</code> (do not display the icons), and <code>"on"</code> (display the
   *       icons). The default setting is <code>"auto"</code>.
-  *       <p>
-  *       This is a beta feature.
   *       </li>
   *   </ul>
   * </li>
@@ -64422,7 +64415,7 @@ function SessionFactory(deps) {
       cpuPressureMonitor.initMonitoring(PressureObserver);
       cpuPressureMonitor.startMonitoring();
       cpuPressureMonitor.on('pressureMonitorEvent', newState => {
-        this.dispatchEvent(new Events.CpuPerformanceChanged(newState));
+        this.dispatchEvent(new Events.CpuPerformanceChangedEvent(newState));
       });
     }
 
@@ -67263,6 +67256,16 @@ function SessionFactory(deps) {
    * of streams in a session</a>
    */
 
+  /**
+   * The CPU performance state has changed. This can be set to
+   * one the following: "nominal", "fair", "serious", or "critical".
+   *
+   * @name cpuPerformanceChanged
+   * @event
+   * @memberof Session
+   * @see CpuPerformanceChangedEvent
+   */
+
   /**
    * The client has connected to a Vonage Video API session. This event is dispatched asynchronously
    * in response to a successful call to the <code>connect()</code> method of a Session
@@ -67280,7 +67283,7 @@ function SessionFactory(deps) {
   /**
    * The client has disconnected from the session. This event may be dispatched asynchronously
    * in response to a successful call to the <code>disconnect()</code> method of the Session object.
-   * The event may also be dispatched if a session connection is lost inadvertantly, as in the case
+   * The event may also be dispatched if a session connection is lost inadvertently, as in the case
    * of a lost network connection.
    * <p>
    * The default behavior is that all Subscriber objects are unsubscribed and removed from the
@@ -67429,7 +67432,7 @@ function SessionFactory(deps) {
    *   console.log("Signal data: " + event.data);
    * });
    * </pre>
-   * <p>You can register for signals of a specfied type by adding an event handler for the
+   * <p>You can register for signals of a specified type by adding an event handler for the
    * <code>signal:type</code> event (replacing <code>type</code> with the actual type string
    * to filter on).
    *
@@ -67453,7 +67456,7 @@ function SessionFactory(deps) {
    *   </li>
    * </ul>
    * <p>
-   * You can register for signals of a specfied type by adding an event handler for the
+   * You can register for signals of a specified type by adding an event handler for the
    * <code>signal:type</code> event (replacing <code>type</code> with the actual type string
    * to filter on). For example, the following code adds an event handler for signals of
    * type "foo":
@@ -69714,12 +69717,13 @@ OT.ArchiveEvent = Events.ArchiveEvent;
 OT.ArchiveUpdatedEvent = Events.ArchiveUpdatedEvent;
 OT.AudioLevelTransformer = _audio_level_transformer.default;
 OT.AudioLevelUpdatedEvent = Events.AudioLevelUpdatedEvent;
-OT.AudioInputDeviceChanged = Events.AudioInputDeviceChanged;
+OT.AudioInputDeviceChangedEvent = Events.AudioInputDeviceChangedEvent;
 OT.Capabilities = _capabilities.default;
 OT.Chrome = _chrome.default;
 OT.Connection = _connection.default;
 OT.ConnectionCapabilities = OT.Connection.Capabilities;
 OT.ConnectionEvent = Events.ConnectionEvent;
+OT.CpuPerformanceChangedEvent = Events.CpuPerformanceChangedEvent;
 Object.keys(_logLevels.default).forEach(name => {
   OT[name.toUpperCase()] = _logLevels.default[name].priority;
 });
@@ -69757,6 +69761,7 @@ OT.HAS_REQUIREMENTS = 1;
 OT.IntervalRunner = _interval_runner.default;
 OT.IssueReportedEvent = Events.IssueReportedEvent;
 OT.MediaStoppedEvent = Events.MediaStoppedEvent;
+OT.MediaStreamAvailableEvent = Events.MediaStreamAvailableEvent;
 OT.Microphone = Microphone;
 OT.NOT_HAS_REQUIREMENTS = 0;
 OT.PeerConnection = PeerConnection;
@@ -95416,7 +95421,7 @@ const createMOSScoreHelper = () => ({
               if (previousVideoScore !== currentVideoScore || previousAudioScore !== currentAudioScore) {
                 // Don't emit an empty object
                 if (Object.keys(qualityScore).length > 0) {
-                  subscriber.dispatchEvent(new Events.QualityScoreChanged(qualityScore));
+                  subscriber.dispatchEvent(new Events.QualityScoreChangedEvent(qualityScore));
                 }
               }
               previousAudioScore = currentAudioScore;
@@ -97812,7 +97817,7 @@ var _default = function _default(deps) {
               _context.next = 9;
               return publisher.setAudioSource(device.deviceId);
             case 9:
-              publisher.dispatchEvent(Events.AudioInputDeviceChanged(device));
+              publisher.dispatchEvent(Events.AudioInputDeviceChangedEvent(device));
             case 10:
             case "end":
               return _context.stop();
@@ -105224,6 +105229,12 @@ function initSessionFactory(deps) {
   *   end-to-end encryption feature. See <a href="https://tokbox.com/developer/guides/end-to-end-encryption/">
   *   the developer guide</a>.
   *   </li>
+  *   <li><code>singlePeerConnection</code> &mdash; (Boolean) Enables the Single Peer Connection (SPC) feature.
+  *   SPC is a feature that encapsulates all subscriber connections to a single peer
+  *    connection. The benefits of enabling SPC include reduced OS resource consumption and improved rate control.
+  *    SPC is disabled by default. When disabled, the session will use Multiple Peer Connection (MPC), where a
+  *    separate peer connection is established between each endpoint.
+  *   </li>
   * </ul>
   *
   * @returns {Session} The session object through which all further interactions with