@opentok/client 2.30.1-alpha.3 → 2.30.1-alpha.4

package/dist/js/opentok.d.ts

@@ -183,6 +183,7 @@ declare namespace OT {
     creationTime: number;
     frameRate: number;
     hasAudio: boolean;
+    hasCaptions: boolean;
     hasVideo: boolean;
     initials: string;
     name: string;
@@ -521,6 +522,7 @@ declare namespace OT {
         stream: Stream;
       } & (
         { changedProperty: 'hasAudio'; oldValue: boolean; newValue: boolean; } |
+        { changedProperty: 'hasCaptions'; oldValue: boolean; newValue: boolean; } |
         { changedProperty: 'hasVideo'; oldValue: boolean; newValue: boolean; } |
         { changedProperty: 'videoDimensions'; oldValue: Dimensions; newValue: Dimensions; }
       )

package/dist/js/opentok.js

@@ -1,11 +1,11 @@
 /**
- * @license OpenTok.js 2.30.1 72c06c3d2
+ * @license OpenTok.js 2.30.1 b842fa8df
  *
  * 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: Wed, 21 May 2025 16:17:04 GMT
+ * Date: Wed, 28 May 2025 22:09:19 GMT
  */
 
 (function webpackUniversalModuleDefinition(root, factory) {
@@ -4169,7 +4169,7 @@ function EventsFactory(deps) {
    *
    * @class StreamPropertyChangedEvent
    * @property {String} changedProperty The property of the stream that changed. This value
-   * is either <code>"hasAudio"</code>, <code>"hasVideo"</code>, or <code>"videoDimensions"</code>.
+   * is either <code>"hasAudio"</code>, <code>"hasVideo"</code>, <code>"hasCaptions"</code>, or <code>"videoDimensions"</code>.
    * @property {Object} newValue The new value of the property (after the change).
    * @property {Object} oldValue The old value of the property (before the change).
    * @property {Stream} stream The Stream object for which a property has changed.
@@ -8672,7 +8672,7 @@ const logging = (0, _log.default)('StaticConfig');
 */
 
 /** @type builtInConfig */
-const builtInConfig = (0, _cloneDeep.default)({"version":"v2.30.1","buildHash":"72c06c3d2","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.30.1","buildHash":"b842fa8df","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',
@@ -19626,6 +19626,8 @@ function PublisherFactory(_ref) {
     * @see <a href="OT.html#initPublisher">OT.initPublisher()</a>
     * @see <a href="Subscriber.html#subscribeToCaptions">subscribeToCaptions()</a>
     * @see <a href="Subscriber.html#isSubscribedToCaptions">isSubscribedToCaptions()</a>
+    * @see <a href="Stream.html#hasCaptions">Stream.hasCaptions</a>
+    * @see StreamPropertyChangedEvent
     * @method #publishCaptions
     * @memberOf Publisher
     */
@@ -23993,6 +23995,12 @@ const validPropertyNames = ['name', 'archiving'];
  * the publisher of the stream specifies a frame rate when calling the
  * <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
+ * {@link Session} object dispatches a <code>streamPropertyChanged</code> event (see
+ * {@link StreamPropertyChangedEvent}).
+ *
  * @property {Boolean} hasAudio Whether the stream has audio. This property can change if the
  * publisher turns on or off audio (by calling
  * <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>). When this occurs, the
@@ -24056,7 +24064,13 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
     let _key = key;
     switch (_key) {
       case 'active':
-        _key = channel.type === 'audio' ? 'hasAudio' : 'hasVideo';
+        if (channel.type === 'audio') {
+          _key = 'hasAudio';
+        } else if (channel.type === 'video') {
+          _key = 'hasVideo';
+        } else if (channel.type === 'data' && channel.id === 'caption1') {
+          _key = 'hasCaptions';
+        }
         self[_key] = newValue;
         break;
       case 'disableWarning':
@@ -24130,11 +24144,13 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
 
   const audioChannel = this.getChannelsOfType('audio')[0];
   const videoChannel = this.getChannelsOfType('video')[0];
+  const captionChannel = this.getChannelsOfType('data').find(channel => channel.id === 'caption1');
 
   // @todo this should really be: "has at least one video/audio track" instead of
   // "the first video/audio track"
-  this.hasAudio = audioChannel != null && audioChannel.active;
-  this.hasVideo = videoChannel != null && videoChannel.active;
+  this.hasAudio = !!(audioChannel != null && audioChannel.active);
+  this.hasVideo = !!(videoChannel != null && videoChannel.active);
+  this.hasCaptions = !!(captionChannel != null && captionChannel.active);
   this.videoType = videoChannel && videoChannel.source;
   this.defaultFitMode = videoChannel && videoChannel.fitMode;
   this.videoDimensions = {};
@@ -24145,9 +24161,8 @@ function Stream(id, name, creationTime, connection, session, channel, initials)
     videoChannel.on('update', onChannelUpdate);
     this.frameRate = videoChannel.frameRate;
   }
-  if (audioChannel) {
-    audioChannel.on('update', onChannelUpdate);
-  }
+  audioChannel == null ? void 0 : audioChannel.on('update', onChannelUpdate);
+  captionChannel == null ? void 0 : captionChannel.on('update', onChannelUpdate);
   this.setChannelActiveState = function setChannelActiveState(_ref) {
     let channelType = _ref.channelType,
       activeState = _ref.activeState,
@@ -40031,6 +40046,7 @@ function SubscriberFactory(_ref2) {
     *
     * @see <a href="#isSubscribedToCaptions">isSubscribedToCaptions()</a>
     * @see <a href="#event:captionReceived">captionReceived</a> event
+    * @see <a href="StreamPropertyChangedEvent.html">StreamPropertyChangedEvent</a>
     *
     * @method #subscribeToCaptions
     * @memberOf Subscriber
@@ -46205,8 +46221,9 @@ function SessionFactory(deps) {
    * in the following conditions:
    * <p>
    * <ul>
-   *   <li> A stream has started or stopped publishing audio or video (see
-   *     <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a> and
+   *   <li> A stream has started or stopped publishing audio, captions, or video (see
+   *     <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>,
+   *     <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a> and
    *     <a href="Publisher.html#publishVideo">Publisher.publishVideo()</a>). Note
    *     that a subscriber's video can be disabled or enabled for reasons other than
    *     the publisher disabling or enabling it. A Subscriber object dispatches
@@ -46227,8 +46244,10 @@ function SessionFactory(deps) {
    * @memberof Session
    * @see StreamPropertyChangedEvent
    * @see <a href="Publisher.html#publishAudio">Publisher.publishAudio()</a>
+   * @see <a href="Publisher.html#publishCaptions">Publisher.publishCaptions()</a>
    * @see <a href="Publisher.html#publishVideo">Publisher.publishVideo()</a>
    * @see <a href="Stream.html#hasAudio">Stream.hasAudio</a>
+   * @see <a href="Stream.html#hasCaptions">Stream.hasCaptions</a>
    * @see <a href="Stream.html#hasVideo">Stream.hasVideo</a>
    * @see <a href="Stream.html#videoDimensions">Stream.videoDimensions</a>
    * @see <a href="Subscriber.html#event:videoDisabled">Subscriber videoDisabled event</a>