@opentok/client 2.27.7 → 2.28.0

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.27.7 7bb2355
+ * @license OpenTok.js 2.28.0 1ea3fa6
  *
  * Copyright (c) 2010-2024 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 Jun 2024 17:32:09 GMT
+ * Date: Wed, 26 Jun 2024 15:49:08 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -6754,7 +6754,23 @@ function EventsFactory(deps) {
     });
   };
 
-  // WILL NEED TO DOCUMENT THIS FOR BOTH SUB AND PUB
+  /**
+   * 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
+   * control all other aspects of the video API such as muting, disconnecting, and more.
+   *
+   * <p>Note that the audio will play through both the custom element and the Publisher or Subscriber widget.
+   * The custom elements should be muted to avoid echo.</p>
+   *
+   * @property {MediaStream} mediaStream The MediaStream object.
+   * @see <a href="Publisher.html#event:mediaStreamAvailable">Publisher mediaStreamAvailable
+   *   event</a>
+   * @see <a href="Subscriber.html#event:mediaStreamAvailable">Subscriber mediaStreamAvailable
+   *   event</a>
+   * @augments Event
+   */
   Events.MediaStreamAvailable = function MediaStreamAvailable(mediaStream) {
     return new _Event4.default('mediaStreamAvailable', false, {
       mediaStream
@@ -7929,7 +7945,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.27.7","buildHash":"7bb2355","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.0","buildHash":"1ea3fa6","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',
@@ -22218,6 +22234,15 @@ function PublisherFactory(_ref) {
   * @memberof Publisher
   */
 
+  /**
+  * This is a <b>beta</b> feature.
+  * Dispatched when the MediaStream is available.
+  * @see Event
+  * @name mediaStreamAvailable
+  * @event
+  * @memberof Publisher
+  */
+
   /**
   * Dispatched when the Allow/Deny box is closed. (This is the dialog box in which the
   * user can grant the app access to the camera and microphone.)
@@ -37088,6 +37113,15 @@ function SubscriberFactory(_ref2) {
     * @memberof Subscriber
     */
 
+    /**
+    * This is a <b>beta</b> feature.
+    * Dispatched when the MediaStream is available.
+    * @see Event
+    * @name mediaStreamAvailable
+    * @event
+    * @memberof Subscriber
+    */
+
     /**
     * Dispatched when the subscriber receives a caption from the transcription service.
     * You must first call the <a href="Subscriber.html#subscribeToCaptions">Subscriber.subscribeToCaptions()</a>