livekit-client 2.12.0 → 2.13.1

package/dist/livekit-client.esm.mjs

@@ -7182,7 +7182,7 @@ let deprecationWarnings_ = true;
  */
 function extractVersion(uastring, expr, pos) {
   const match = uastring.match(expr);
-  return match && match.length >= pos && parseInt(match[pos], 10);
+  return match && match.length >= pos && parseFloat(match[pos], 10);
 }
 
 // Wraps the peerconnection event eventNameToWrap in a function
@@ -7327,19 +7327,21 @@ function detectBrowser(window) {
   if (navigator.mozGetUserMedia) {
     // Firefox.
     result.browser = 'firefox';
-    result.version = extractVersion(navigator.userAgent, /Firefox\/(\d+)\./, 1);
+    result.version = parseInt(extractVersion(navigator.userAgent, /Firefox\/(\d+)\./, 1));
   } else if (navigator.webkitGetUserMedia || window.isSecureContext === false && window.webkitRTCPeerConnection) {
     // Chrome, Chromium, Webview, Opera.
     // Version matches Chrome/WebRTC version.
     // Chrome 74 removed webkitGetUserMedia on http as well so we need the
     // more complicated fallback to webkitRTCPeerConnection.
     result.browser = 'chrome';
-    result.version = extractVersion(navigator.userAgent, /Chrom(e|ium)\/(\d+)\./, 2);
+    result.version = parseInt(extractVersion(navigator.userAgent, /Chrom(e|ium)\/(\d+)\./, 2));
   } else if (window.RTCPeerConnection && navigator.userAgent.match(/AppleWebKit\/(\d+)\./)) {
     // Safari.
     result.browser = 'safari';
-    result.version = extractVersion(navigator.userAgent, /AppleWebKit\/(\d+)\./, 1);
+    result.version = parseInt(extractVersion(navigator.userAgent, /AppleWebKit\/(\d+)\./, 1));
     result.supportsUnifiedPlan = window.RTCRtpTransceiver && 'currentDirection' in window.RTCRtpTransceiver.prototype;
+    // Only for internal usage.
+    result._safariVersion = extractVersion(navigator.userAgent, /Version\/(\d+(\.?\d+))/, 1);
   } else {
     // Default fallthrough: not supported.
     result.browser = 'Not a supported browser.';
@@ -9940,7 +9942,7 @@ function removeExtmapAllowMixed(window, browserDetails) {
   if (browserDetails.browser === 'chrome' && browserDetails.version >= 71) {
     return;
   }
-  if (browserDetails.browser === 'safari' && browserDetails.version >= 605) {
+  if (browserDetails.browser === 'safari' && browserDetails._safariVersion >= 13.1) {
     return;
   }
   const nativeSRD = window.RTCPeerConnection.prototype.setRemoteDescription;
@@ -10477,6 +10479,7 @@ var ConnectionErrorReason;
   ConnectionErrorReason[ConnectionErrorReason["InternalError"] = 2] = "InternalError";
   ConnectionErrorReason[ConnectionErrorReason["Cancelled"] = 3] = "Cancelled";
   ConnectionErrorReason[ConnectionErrorReason["LeaveRequest"] = 4] = "LeaveRequest";
+  ConnectionErrorReason[ConnectionErrorReason["Timeout"] = 5] = "Timeout";
 })(ConnectionErrorReason || (ConnectionErrorReason = {}));
 class ConnectionError extends LivekitError {
   constructor(message, reason, status, context) {
@@ -10763,6 +10766,12 @@ var RoomEvent;
    * args: (changedAttributes: [[Record<string, string]], participant: [[Participant]])
    */
   RoomEvent["ParticipantAttributesChanged"] = "participantAttributesChanged";
+  /**
+   * Emitted when the participant's state changes to ACTIVE and is ready to send/receive data messages
+   *
+   * args: (participant: [[Participant]])
+   */
+  RoomEvent["ParticipantActive"] = "participantActive";
   /**
    * Room metadata is a simple way for app-specific state to be pushed to
    * all users.
@@ -11057,6 +11066,10 @@ var ParticipantEvent;
   ParticipantEvent["LocalTrackSubscribed"] = "localTrackSubscribed";
   /** only emitted on local participant */
   ParticipantEvent["ChatMessage"] = "chatMessage";
+  /**
+   * Emitted when the participant's state changes to ACTIVE and is ready to send/receive data messages
+   */
+  ParticipantEvent["Active"] = "active";
 })(ParticipantEvent || (ParticipantEvent = {}));
 /** @internal */
 var EngineEvent;
@@ -11249,7 +11262,7 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.12.0";
+var version$1 = "2.13.1";
 
 const version = version$1;
 const protocolVersion = 16;
@@ -11859,10 +11872,21 @@ function isSafari() {
   var _a;
   return ((_a = getBrowser()) === null || _a === void 0 ? void 0 : _a.name) === 'Safari';
 }
+function isSafariBased() {
+  const b = getBrowser();
+  return (b === null || b === void 0 ? void 0 : b.name) === 'Safari' || (b === null || b === void 0 ? void 0 : b.os) === 'iOS';
+}
 function isSafari17() {
   const b = getBrowser();
   return (b === null || b === void 0 ? void 0 : b.name) === 'Safari' && b.version.startsWith('17.');
 }
+function isSafariSvcApi(browser) {
+  if (!browser) {
+    browser = getBrowser();
+  }
+  // Safari 18.4 requires legacy svc api and scaleResolutionDown to be set
+  return (browser === null || browser === void 0 ? void 0 : browser.name) === 'Safari' && compareVersions(browser.version, '18.3') > 0;
+}
 function isMobile() {
   var _a, _b;
   if (!isWeb()) return false;
@@ -16339,12 +16363,15 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
     // TODO: when we upstream libwebrtc, this will need additional verification
     isReactNative() || (browser === null || browser === void 0 ? void 0 : browser.name) === 'Chrome' && compareVersions(browser === null || browser === void 0 ? void 0 : browser.version, '113') < 0) {
       const bitratesRatio = sm.suffix == 'h' ? 2 : 3;
+      // safari 18.4 uses a different svc API that requires scaleResolutionDownBy to be set.
+      const requireScale = isSafariSvcApi(browser);
       for (let i = 0; i < sm.spatial; i += 1) {
         // in legacy SVC, scaleResolutionDownBy cannot be set
         encodings.push({
           rid: videoRids[2 - i],
           maxBitrate: videoEncoding.maxBitrate / Math.pow(bitratesRatio, i),
-          maxFramerate: original.encoding.maxFramerate
+          maxFramerate: original.encoding.maxFramerate,
+          scaleResolutionDownBy: requireScale ? Math.pow(2, i) : undefined
         });
       }
       // legacy SVC, scalabilityMode is set only on the first encoding
@@ -16851,7 +16878,7 @@ class LocalVideoTrack extends LocalTrack {
       }));
     }
     this.log.debug("setting publishing quality. max quality ".concat(maxQuality), this.logContext);
-    this.setPublishingLayers(qualities);
+    this.setPublishingLayers(isSVCCodec(this.codec), qualities);
   }
   restartTrack(options) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -16986,7 +17013,7 @@ class LocalVideoTrack extends LocalTrack {
       }));
       // only enable simulcast codec for preference codec setted
       if (!this.codec && codecs.length > 0) {
-        yield this.setPublishingLayers(codecs[0].qualities);
+        yield this.setPublishingLayers(isSVCCodec(codecs[0].codec), codecs[0].qualities);
         return [];
       }
       this.subscribedCodecs = codecs;
@@ -16997,7 +17024,7 @@ class LocalVideoTrack extends LocalTrack {
           _a = false;
           const codec = _d;
           if (!this.codec || this.codec === codec.codec) {
-            yield this.setPublishingLayers(codec.qualities);
+            yield this.setPublishingLayers(isSVCCodec(codec.codec), codec.qualities);
           } else {
             const simulcastCodecInfo = this.simulcastCodecs.get(codec.codec);
             this.log.debug("try setPublishingCodec for ".concat(codec.codec), Object.assign(Object.assign({}, this.logContext), {
@@ -17012,7 +17039,7 @@ class LocalVideoTrack extends LocalTrack {
               }
             } else if (simulcastCodecInfo.encodings) {
               this.log.debug("try setPublishingLayersForSender ".concat(codec.codec), this.logContext);
-              yield setPublishingLayersForSender(simulcastCodecInfo.sender, simulcastCodecInfo.encodings, codec.qualities, this.senderLock, this.log, this.logContext);
+              yield setPublishingLayersForSender(simulcastCodecInfo.sender, simulcastCodecInfo.encodings, codec.qualities, this.senderLock, isSVCCodec(codec.codec), this.log, this.logContext);
             }
           }
         }
@@ -17034,7 +17061,7 @@ class LocalVideoTrack extends LocalTrack {
    * @internal
    * Sets layers that should be publishing
    */
-  setPublishingLayers(qualities) {
+  setPublishingLayers(isSvc, qualities) {
     return __awaiter(this, void 0, void 0, function* () {
       this.log.debug('setting publishing layers', Object.assign(Object.assign({}, this.logContext), {
         qualities
@@ -17042,7 +17069,7 @@ class LocalVideoTrack extends LocalTrack {
       if (!this.sender || !this.encodings) {
         return;
       }
-      yield setPublishingLayersForSender(this.sender, this.encodings, qualities, this.senderLock, this.log, this.logContext);
+      yield setPublishingLayersForSender(this.sender, this.encodings, qualities, this.senderLock, isSvc, this.log, this.logContext);
     });
   }
   handleAppVisibilityChanged() {
@@ -17060,7 +17087,7 @@ class LocalVideoTrack extends LocalTrack {
     });
   }
 }
-function setPublishingLayersForSender(sender, senderEncodings, qualities, senderLock, log, logContext) {
+function setPublishingLayersForSender(sender, senderEncodings, qualities, senderLock, isSVC, log, logContext) {
   return __awaiter(this, void 0, void 0, function* () {
     const unlock = yield senderLock.lock();
     log.debug('setPublishingLayersForSender', Object.assign(Object.assign({}, logContext), {
@@ -17122,6 +17149,12 @@ function setPublishingLayersForSender(sender, senderEncodings, qualities, sender
           }
         }
       } else {
+        if (isSVC) {
+          const hasEnabledEncoding = qualities.some(q => q.enabled);
+          if (hasEnabledEncoding) {
+            qualities.forEach(q => q.enabled = true);
+          }
+        }
         // simulcast dynacast encodings
         encodings.forEach((encoding, idx) => {
           var _a;
@@ -17435,12 +17468,12 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
   /** @internal */
   get logContext() {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f;
     return {
       room: (_b = (_a = this.latestJoinResponse) === null || _a === void 0 ? void 0 : _a.room) === null || _b === void 0 ? void 0 : _b.name,
       roomID: (_d = (_c = this.latestJoinResponse) === null || _c === void 0 ? void 0 : _c.room) === null || _d === void 0 ? void 0 : _d.sid,
       participant: (_f = (_e = this.latestJoinResponse) === null || _e === void 0 ? void 0 : _e.participant) === null || _f === void 0 ? void 0 : _f.identity,
-      pID: (_h = (_g = this.latestJoinResponse) === null || _g === void 0 ? void 0 : _g.participant) === null || _h === void 0 ? void 0 : _h.sid
+      pID: this.participantSid
     };
   }
   join(url, token, opts, abortSignal) {
@@ -17541,7 +17574,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     return new Promise((resolve, reject) => {
       const publicationTimeout = setTimeout(() => {
         delete this.pendingTrackResolvers[req.cid];
-        reject(new ConnectionError('publication of local track timed out, no response from server', ConnectionErrorReason.InternalError));
+        reject(new ConnectionError('publication of local track timed out, no response from server', ConnectionErrorReason.Timeout));
       }, 10000);
       this.pendingTrackResolvers[req.cid] = {
         resolve: info => {
@@ -17717,6 +17750,9 @@ class RTCEngine extends eventsExports.EventEmitter {
     this.client.onRoomMoved = res => {
       var _a;
       this.participantSid = (_a = res.participant) === null || _a === void 0 ? void 0 : _a.sid;
+      if (this.latestJoinResponse) {
+        this.latestJoinResponse.room = res.room;
+      }
       this.emit(EngineEvent.RoomMoved, res);
     };
     this.client.onClose = () => {
@@ -17794,8 +17830,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     }
     // create data channels
     this.lossyDC = this.pcManager.createPublisherDataChannel(lossyDataChannel, {
-      // will drop older packets that arrive
-      ordered: true,
+      ordered: false,
       maxRetransmits: 0
     });
     this.reliableDC = this.pcManager.createPublisherDataChannel(reliableDataChannel, {
@@ -19576,16 +19611,17 @@ function createLocalTracks(options, loggerOptions) {
         }
       });
     }
-    // TODO if internal options don't have device Id specified, set it to 'default'
     if (internalOptions.audio === true || typeof internalOptions.audio === 'object' && !internalOptions.audio.deviceId) {
       internalOptions.audio = {
         deviceId: 'default'
       };
     }
-    if (internalOptions.video === true || typeof internalOptions.video === 'object' && !internalOptions.video.deviceId) {
+    if (internalOptions.video === true) {
       internalOptions.video = {
         deviceId: 'default'
       };
+    } else if (typeof internalOptions.video === 'object' && !internalOptions.video.deviceId) {
+      internalOptions.video.deviceId = 'default';
     }
     const opts = mergeDefaultOptions(internalOptions, audioDefaults, videoDefaults);
     const constraints = constraintsForOptions(opts);
@@ -19742,6 +19778,10 @@ class Participant extends eventsExports.EventEmitter {
     var _a;
     return ((_a = this.permissions) === null || _a === void 0 ? void 0 : _a.agent) || this.kind === ParticipantInfo_Kind.AGENT;
   }
+  get isActive() {
+    var _a;
+    return ((_a = this.participantInfo) === null || _a === void 0 ? void 0 : _a.state) === ParticipantInfo_State.ACTIVE;
+  }
   get kind() {
     return this._kind;
   }
@@ -19797,6 +19837,25 @@ class Participant extends eventsExports.EventEmitter {
       }
     }
   }
+  /**
+   * Waits until the participant is active and ready to receive data messages
+   * @returns a promise that resolves when the participant is active
+   */
+  waitUntilActive() {
+    if (this.isActive) {
+      return Promise.resolve();
+    }
+    if (this.activeFuture) {
+      return this.activeFuture.promise;
+    }
+    this.activeFuture = new Future();
+    this.once(ParticipantEvent.Active, () => {
+      var _a, _b;
+      (_b = (_a = this.activeFuture) === null || _a === void 0 ? void 0 : _a.resolve) === null || _b === void 0 ? void 0 : _b.call(_a);
+      this.activeFuture = undefined;
+    });
+    return this.activeFuture.promise;
+  }
   get connectionQuality() {
     return this._connectionQuality;
   }
@@ -19826,6 +19885,7 @@ class Participant extends eventsExports.EventEmitter {
   }
   /** @internal */
   updateInfo(info) {
+    var _a;
     // it's possible the update could be applied out of order due to await
     // during reconnect sequences. when that happens, it's possible for server
     // to have sent more recent version of participant info while JS is waiting
@@ -19840,14 +19900,14 @@ class Participant extends eventsExports.EventEmitter {
     this._setName(info.name);
     this._setMetadata(info.metadata);
     this._setAttributes(info.attributes);
+    if (info.state === ParticipantInfo_State.ACTIVE && ((_a = this.participantInfo) === null || _a === void 0 ? void 0 : _a.state) !== ParticipantInfo_State.ACTIVE) {
+      this.emit(ParticipantEvent.Active);
+    }
     if (info.permission) {
       this.setPermissions(info.permission);
     }
     // set this last so setMetadata can detect changes
     this.participantInfo = info;
-    this.log.trace('update participant info', Object.assign(Object.assign({}, this.logContext), {
-      info
-    }));
     return true;
   }
   /**
@@ -19911,6 +19971,16 @@ class Participant extends eventsExports.EventEmitter {
       this.emit(ParticipantEvent.ConnectionQualityChanged, this._connectionQuality);
     }
   }
+  /**
+   * @internal
+   */
+  setDisconnected() {
+    var _a, _b;
+    if (this.activeFuture) {
+      (_b = (_a = this.activeFuture).reject) === null || _b === void 0 ? void 0 : _b.call(_a, new Error('Participant disconnected'));
+      this.activeFuture = undefined;
+    }
+  }
   /**
    * @internal
    */
@@ -20064,7 +20134,7 @@ class LocalParticipant extends Participant {
     };
     this.handleSubscribedQualityUpdate = update => __awaiter(this, void 0, void 0, function* () {
       var _a, e_1, _b, _c;
-      var _d, _e;
+      var _d;
       if (!((_d = this.roomOptions) === null || _d === void 0 ? void 0 : _d.dynacast)) {
         return;
       }
@@ -20075,34 +20145,30 @@ class LocalParticipant extends Participant {
         }));
         return;
       }
-      if (update.subscribedCodecs.length > 0) {
-        if (!pub.videoTrack) {
-          return;
+      if (!pub.videoTrack) {
+        return;
+      }
+      const newCodecs = yield pub.videoTrack.setPublishingCodecs(update.subscribedCodecs);
+      try {
+        for (var _e = true, newCodecs_1 = __asyncValues(newCodecs), newCodecs_1_1; newCodecs_1_1 = yield newCodecs_1.next(), _a = newCodecs_1_1.done, !_a; _e = true) {
+          _c = newCodecs_1_1.value;
+          _e = false;
+          const codec = _c;
+          if (isBackupCodec(codec)) {
+            this.log.debug("publish ".concat(codec, " for ").concat(pub.videoTrack.sid), Object.assign(Object.assign({}, this.logContext), getLogContextFromTrack(pub)));
+            yield this.publishAdditionalCodecForTrack(pub.videoTrack, codec, pub.options);
+          }
         }
-        const newCodecs = yield pub.videoTrack.setPublishingCodecs(update.subscribedCodecs);
+      } catch (e_1_1) {
+        e_1 = {
+          error: e_1_1
+        };
+      } finally {
         try {
-          for (var _f = true, newCodecs_1 = __asyncValues(newCodecs), newCodecs_1_1; newCodecs_1_1 = yield newCodecs_1.next(), _a = newCodecs_1_1.done, !_a; _f = true) {
-            _c = newCodecs_1_1.value;
-            _f = false;
-            const codec = _c;
-            if (isBackupCodec(codec)) {
-              this.log.debug("publish ".concat(codec, " for ").concat(pub.videoTrack.sid), Object.assign(Object.assign({}, this.logContext), getLogContextFromTrack(pub)));
-              yield this.publishAdditionalCodecForTrack(pub.videoTrack, codec, pub.options);
-            }
-          }
-        } catch (e_1_1) {
-          e_1 = {
-            error: e_1_1
-          };
+          if (!_e && !_a && (_b = newCodecs_1.return)) yield _b.call(newCodecs_1);
         } finally {
-          try {
-            if (!_f && !_a && (_b = newCodecs_1.return)) yield _b.call(newCodecs_1);
-          } finally {
-            if (e_1) throw e_1.error;
-          }
+          if (e_1) throw e_1.error;
         }
-      } else if (update.subscribedQualities.length > 0) {
-        yield (_e = pub.videoTrack) === null || _e === void 0 ? void 0 : _e.setPublishingLayers(update.subscribedQualities);
       }
     });
     this.handleLocalTrackUnpublished = unpublished => {
@@ -20389,7 +20455,7 @@ class LocalParticipant extends Participant {
               tr.stop();
             });
             if (e instanceof Error) {
-              this.emit(ParticipantEvent.MediaDevicesError, e);
+              this.emit(ParticipantEvent.MediaDevicesError, e, sourceToKind(source));
             }
             this.pendingPublishing.delete(source);
             throw e;
@@ -20905,11 +20971,28 @@ class LocalParticipant extends Participant {
         yield this.engine.negotiate();
       });
       let ti;
+      const addTrackPromise = new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        try {
+          ti = yield this.engine.addTrack(req);
+          resolve(ti);
+        } catch (err) {
+          if (track.sender && ((_a = this.engine.pcManager) === null || _a === void 0 ? void 0 : _a.publisher)) {
+            this.engine.pcManager.publisher.removeTrack(track.sender);
+            yield this.engine.negotiate().catch(negotiateErr => {
+              this.log.error('failed to negotiate after removing track due to failed add track request', Object.assign(Object.assign(Object.assign({}, this.logContext), getLogContextFromTrack(track)), {
+                error: negotiateErr
+              }));
+            });
+          }
+          reject(err);
+        }
+      }));
       if (this.enabledPublishVideoCodecs.length > 0) {
-        const rets = yield Promise.all([this.engine.addTrack(req), negotiate()]);
+        const rets = yield Promise.all([addTrackPromise, negotiate()]);
         ti = rets[0];
       } else {
-        ti = yield this.engine.addTrack(req);
+        ti = yield addTrackPromise;
         // server might not support the codec the client has requested, in that case, fallback
         // to a supported codec
         let primaryCodecMime;
@@ -21437,6 +21520,7 @@ class LocalParticipant extends Participant {
         streamId,
         topic: info.topic,
         timestamp: numberToBigInt(Date.now()),
+        attributes: info.attributes,
         contentHeader: {
           case: 'byteHeader',
           value: new DataStream_ByteHeader({
@@ -22925,12 +23009,14 @@ class Room extends eventsExports.EventEmitter {
             continue;
           }
         }
-        if (kind === 'audioinput' && !isSafari() || kind === 'videoinput') {
+        if (kind === 'audioinput' && !isSafariBased() || kind === 'videoinput') {
           // airpods on Safari need special handling for audioinput as the track doesn't end as soon as you take them out
           continue;
         }
         // switch to first available device if previously active device is not available any more
-        if (devicesOfKind.length > 0 && !devicesOfKind.find(deviceInfo => deviceInfo.deviceId === this.getActiveDevice(kind))) {
+        if (devicesOfKind.length > 0 && !devicesOfKind.find(deviceInfo => deviceInfo.deviceId === this.getActiveDevice(kind)) && (
+        // avoid switching audio output on safari without explicit user action as it leads to slowed down audio playback
+        kind !== 'audiooutput' || !isSafariBased())) {
           yield this.switchActiveDevice(kind, devicesOfKind[0].deviceId);
         }
       }
@@ -23014,8 +23100,8 @@ class Room extends eventsExports.EventEmitter {
     this.onLocalConnectionQualityChanged = quality => {
       this.emit(RoomEvent.ConnectionQualityChanged, quality, this.localParticipant);
     };
-    this.onMediaDevicesError = e => {
-      this.emit(RoomEvent.MediaDevicesError, e);
+    this.onMediaDevicesError = (e, kind) => {
+      this.emit(RoomEvent.MediaDevicesError, e, kind);
     };
     this.onLocalParticipantPermissionsChanged = prevPermissions => {
       this.emit(RoomEvent.ParticipantPermissionsChanged, prevPermissions, this.localParticipant);
@@ -23741,6 +23827,7 @@ class Room extends eventsExports.EventEmitter {
       participant.unpublishTrack(publication.trackSid, true);
     });
     this.emit(RoomEvent.ParticipantDisconnected, participant);
+    participant.setDisconnected();
     (_a = this.localParticipant) === null || _a === void 0 ? void 0 : _a.handleParticipantDisconnected(participant.identity);
   }
   handleStreamHeader(streamHeader, participantIdentity) {
@@ -23947,6 +24034,8 @@ class Room extends eventsExports.EventEmitter {
       this.emit(RoomEvent.TrackSubscriptionFailed, trackSid, participant, error);
     }).on(ParticipantEvent.TrackSubscriptionPermissionChanged, (pub, status) => {
       this.emitWhenConnected(RoomEvent.TrackSubscriptionPermissionChanged, pub, status, participant);
+    }).on(ParticipantEvent.Active, () => {
+      this.emitWhenConnected(RoomEvent.ParticipantActive, participant);
     });
     // update info at the end after callbacks have been set up
     if (info) {