livekit-client 2.13.5 → 2.13.7

package/dist/livekit-client.esm.mjs

@@ -5744,6 +5744,12 @@ const SessionDescription = /* @__PURE__ */proto3.makeMessageType("livekit.Sessio
   kind: "scalar",
   T: 9
   /* ScalarType.STRING */
+}, {
+  no: 3,
+  name: "id",
+  kind: "scalar",
+  T: 13
+  /* ScalarType.UINT32 */
 }]);
 const ParticipantUpdate = /* @__PURE__ */proto3.makeMessageType("livekit.ParticipantUpdate", () => [{
   no: 1,
@@ -11325,7 +11331,7 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.13.5";
+var version$1 = "2.13.7";
 
 const version = version$1;
 const protocolVersion = 16;
@@ -13244,10 +13250,7 @@ class SignalClient {
         sid,
         reconnectReason: reason
       }));
-      if (res instanceof ReconnectResponse) {
-        return res;
-      }
-      return;
+      return res;
     });
   }
   connect(url, token, opts, abortSignal) {
@@ -13425,23 +13428,23 @@ class SignalClient {
     });
   }
   // initial offer after joining
-  sendOffer(offer) {
+  sendOffer(offer, offerId) {
     this.log.debug('sending offer', Object.assign(Object.assign({}, this.logContext), {
       offerSdp: offer.sdp
     }));
     this.sendRequest({
       case: 'offer',
-      value: toProtoSessionDescription(offer)
+      value: toProtoSessionDescription(offer, offerId)
     });
   }
   // answer a server-initiated offer
-  sendAnswer(answer) {
+  sendAnswer(answer, offerId) {
     this.log.debug('sending answer', Object.assign(Object.assign({}, this.logContext), {
       answerSdp: answer.sdp
     }));
     return this.sendRequest({
       case: 'answer',
-      value: toProtoSessionDescription(answer)
+      value: toProtoSessionDescription(answer, offerId)
     });
   }
   sendIceCandidate(candidate, target) {
@@ -13617,12 +13620,12 @@ class SignalClient {
     if (msg.case === 'answer') {
       const sd = fromProtoSessionDescription(msg.value);
       if (this.onAnswer) {
-        this.onAnswer(sd);
+        this.onAnswer(sd, msg.value.id);
       }
     } else if (msg.case === 'offer') {
       const sd = fromProtoSessionDescription(msg.value);
       if (this.onOffer) {
-        this.onOffer(sd);
+        this.onOffer(sd, msg.value.id);
       }
     } else if (msg.case === 'trickle') {
       const candidate = JSON.parse(msg.value.candidateInit);
@@ -13793,10 +13796,11 @@ function fromProtoSessionDescription(sd) {
   }
   return rsd;
 }
-function toProtoSessionDescription(rsd) {
+function toProtoSessionDescription(rsd, id) {
   const sd = new SessionDescription({
     sdp: rsd.sdp,
-    type: rsd.type
+    type: rsd.type,
+    id
   });
   return sd;
 }
@@ -14741,6 +14745,7 @@ class PCTransport extends eventsExports.EventEmitter {
     super();
     this.log = livekitLogger;
     this.ddExtID = 0;
+    this.latestOfferId = 0;
     this.pendingCandidates = [];
     this.restartingIce = false;
     this.renegotiate = false;
@@ -14831,9 +14836,16 @@ class PCTransport extends eventsExports.EventEmitter {
       this.pendingCandidates.push(candidate);
     });
   }
-  setRemoteDescription(sd) {
+  setRemoteDescription(sd, offerId) {
     return __awaiter(this, void 0, void 0, function* () {
       var _a;
+      if (sd.type === 'answer' && this.latestOfferId > 0 && offerId > 0 && offerId !== this.latestOfferId) {
+        this.log.warn('ignoring answer for old offer', Object.assign(Object.assign({}, this.logContext), {
+          offerId,
+          latestOfferId: this.latestOfferId
+        }));
+        return false;
+      }
       let mungedSDP = undefined;
       if (sd.type === 'offer') {
         let {
@@ -14907,11 +14919,15 @@ class PCTransport extends eventsExports.EventEmitter {
           });
         }
       }
+      return true;
     });
   }
   createAndSendOffer(options) {
     return __awaiter(this, void 0, void 0, function* () {
       var _a;
+      // increase the offer id at the start to ensure the offer is always > 0 so that we can use 0 as a default value for legacy behavior
+      const offerId = this.latestOfferId + 1;
+      this.latestOfferId = offerId;
       if (this.onOffer === undefined) {
         return;
       }
@@ -14986,8 +15002,15 @@ class PCTransport extends eventsExports.EventEmitter {
           });
         }
       });
+      if (this.latestOfferId > offerId) {
+        this.log.warn('latestOfferId mismatch', Object.assign(Object.assign({}, this.logContext), {
+          latestOfferId: this.latestOfferId,
+          offerId
+        }));
+        return;
+      }
       yield this.setMungedSDP(offer, libExports.write(sdpParsed));
-      this.onOffer(offer);
+      this.onOffer(offer, this.latestOfferId);
     });
   }
   createAndSetAnswer() {
@@ -15382,9 +15405,9 @@ class PCTransportManager {
       var _a;
       (_a = this.onTrack) === null || _a === void 0 ? void 0 : _a.call(this, ev);
     };
-    this.publisher.onOffer = offer => {
+    this.publisher.onOffer = (offer, offerId) => {
       var _a;
-      (_a = this.onPublisherOffer) === null || _a === void 0 ? void 0 : _a.call(this, offer);
+      (_a = this.onPublisherOffer) === null || _a === void 0 ? void 0 : _a.call(this, offer, offerId);
     };
     this.state = PCTransportState.NEW;
     this.connectionLock = new _();
@@ -15407,8 +15430,8 @@ class PCTransportManager {
   createAndSendPublisherOffer(options) {
     return this.publisher.createAndSendOffer(options);
   }
-  setPublisherAnswer(sd) {
-    return this.publisher.setRemoteDescription(sd);
+  setPublisherAnswer(sd, offerId) {
+    return this.publisher.setRemoteDescription(sd, offerId);
   }
   removeTrack(sender) {
     return this.publisher.removeTrack(sender);
@@ -15454,7 +15477,7 @@ class PCTransportManager {
       }
     });
   }
-  createSubscriberAnswerFromOffer(sd) {
+  createSubscriberAnswerFromOffer(sd, offerId) {
     return __awaiter(this, void 0, void 0, function* () {
       this.log.debug('received server offer', Object.assign(Object.assign({}, this.logContext), {
         RTCSdpType: sd.type,
@@ -15463,7 +15486,10 @@ class PCTransportManager {
       }));
       const unlock = yield this.remoteOfferLock.lock();
       try {
-        yield this.subscriber.setRemoteDescription(sd);
+        const success = yield this.subscriber.setRemoteDescription(sd, offerId);
+        if (!success) {
+          return undefined;
+        }
         // answer the offer
         const answer = yield this.subscriber.createAndSetAnswer();
         return answer;
@@ -17403,44 +17429,13 @@ function setPublishingLayersForSender(sender, senderEncodings, qualities, sender
         return;
       }
       let hasChanged = false;
-      const browser = getBrowser();
-      const closableSpatial = (browser === null || browser === void 0 ? void 0 : browser.name) === 'Chrome' && compareVersions(browser === null || browser === void 0 ? void 0 : browser.version, '133') > 0;
+      /* disable closable spatial layer as it has video blur / frozen issue with current server / client
+      1. chrome 113: when switching to up layer with scalability Mode change, it will generate a
+            low resolution frame and recover very quickly, but noticable
+      2. livekit sfu: additional pli request cause video frozen for a few frames, also noticable */
+      const closableSpatial = false;
       /* @ts-ignore */
-      if (closableSpatial && encodings[0].scalabilityMode) {
-        // svc dynacast encodings
-        const encoding = encodings[0];
-        /* @ts-ignore */
-        const mode = new ScalabilityMode(encoding.scalabilityMode);
-        let maxQuality = VideoQuality$1.OFF;
-        qualities.forEach(q => {
-          if (q.enabled && (maxQuality === VideoQuality$1.OFF || q.quality > maxQuality)) {
-            maxQuality = q.quality;
-          }
-        });
-        if (maxQuality === VideoQuality$1.OFF) {
-          if (encoding.active) {
-            encoding.active = false;
-            hasChanged = true;
-          }
-        } else if (!encoding.active || mode.spatial !== maxQuality + 1) {
-          hasChanged = true;
-          encoding.active = true;
-          /* @ts-ignore */
-          const originalMode = new ScalabilityMode(senderEncodings[0].scalabilityMode);
-          mode.spatial = maxQuality + 1;
-          mode.suffix = originalMode.suffix;
-          if (mode.spatial === 1) {
-            // no suffix for L1Tx
-            mode.suffix = undefined;
-          }
-          /* @ts-ignore */
-          encoding.scalabilityMode = mode.toString();
-          encoding.scaleResolutionDownBy = Math.pow(2, 2 - maxQuality);
-          if (senderEncodings[0].maxBitrate) {
-            encoding.maxBitrate = senderEncodings[0].maxBitrate / (encoding.scaleResolutionDownBy * encoding.scaleResolutionDownBy);
-          }
-        }
-      } else {
+      if (closableSpatial && encodings[0].scalabilityMode) ; else {
         if (isSVC) {
           const hasEnabledEncoding = qualities.some(q => q.enabled);
           if (hasEnabledEncoding) {
@@ -17577,6 +17572,10 @@ class RTCEngine extends eventsExports.EventEmitter {
     this.rtcConfig = {};
     this.peerConnectionTimeout = roomConnectOptionDefaults.peerConnectionTimeout;
     this.fullReconnectOnNext = false;
+    /**
+     * @internal
+     */
+    this.latestRemoteOfferId = 0;
     this.subscriberPrimary = false;
     this.pcState = PCState.New;
     this._isClosed = true;
@@ -17953,8 +17952,8 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.pcManager.onIceCandidate = (candidate, target) => {
         this.client.sendIceCandidate(candidate, target);
       };
-      this.pcManager.onPublisherOffer = offer => {
-        this.client.sendOffer(offer);
+      this.pcManager.onPublisherOffer = (offer, offerId) => {
+        this.client.sendOffer(offer, offerId);
       };
       this.pcManager.onDataChannel = this.handleDataChannel;
       this.pcManager.onStateChange = (connectionState, publisherState, subscriberState) => __awaiter(this, void 0, void 0, function* () {
@@ -17993,14 +17992,14 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
   setupSignalClientCallbacks() {
     // configure signaling client
-    this.client.onAnswer = sd => __awaiter(this, void 0, void 0, function* () {
+    this.client.onAnswer = (sd, offerId) => __awaiter(this, void 0, void 0, function* () {
       if (!this.pcManager) {
         return;
       }
       this.log.debug('received server answer', Object.assign(Object.assign({}, this.logContext), {
         RTCSdpType: sd.type
       }));
-      yield this.pcManager.setPublisherAnswer(sd);
+      yield this.pcManager.setPublisherAnswer(sd, offerId);
     });
     // add candidate on trickle
     this.client.onTrickle = (candidate, target) => {
@@ -18014,12 +18013,15 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.pcManager.addIceCandidate(candidate, target);
     };
     // when server creates an offer for the client
-    this.client.onOffer = sd => __awaiter(this, void 0, void 0, function* () {
+    this.client.onOffer = (sd, offerId) => __awaiter(this, void 0, void 0, function* () {
+      this.latestRemoteOfferId = offerId;
       if (!this.pcManager) {
         return;
       }
-      const answer = yield this.pcManager.createSubscriberAnswerFromOffer(sd);
-      this.client.sendAnswer(answer);
+      const answer = yield this.pcManager.createSubscriberAnswerFromOffer(sd, offerId);
+      if (answer) {
+        this.client.sendAnswer(answer, offerId);
+      }
     });
     this.client.onLocalTrackPublished = res => {
       var _a;
@@ -24061,15 +24063,15 @@ class Room extends eventsExports.EventEmitter {
       var _this3 = this;
       let exact = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
       return function* () {
-        var _a, _b, _c, _d, _e, _f, _g;
-        var _h;
+        var _a, _b, _c, _d, _e, _f;
+        var _g;
         let success = true;
-        let needsUpdateWithoutTracks = false;
+        let shouldTriggerImmediateDeviceChange = false;
         const deviceConstraint = exact ? {
           exact: deviceId
         } : deviceId;
         if (kind === 'audioinput') {
-          needsUpdateWithoutTracks = _this3.localParticipant.audioTrackPublications.size === 0;
+          shouldTriggerImmediateDeviceChange = _this3.localParticipant.audioTrackPublications.size === 0;
           const prevDeviceId = (_a = _this3.getActiveDevice(kind)) !== null && _a !== void 0 ? _a : _this3.options.audioCaptureDefaults.deviceId;
           _this3.options.audioCaptureDefaults.deviceId = deviceConstraint;
           const tracks = Array.from(_this3.localParticipant.audioTrackPublications.values()).filter(track => track.source === Track.Source.Microphone);
@@ -24082,8 +24084,13 @@ class Room extends eventsExports.EventEmitter {
             _this3.options.audioCaptureDefaults.deviceId = prevDeviceId;
             throw e;
           }
+          const isMuted = tracks.some(t => {
+            var _a, _b;
+            return (_b = (_a = t.track) === null || _a === void 0 ? void 0 : _a.isMuted) !== null && _b !== void 0 ? _b : false;
+          });
+          if (success && isMuted) shouldTriggerImmediateDeviceChange = true;
         } else if (kind === 'videoinput') {
-          needsUpdateWithoutTracks = _this3.localParticipant.videoTrackPublications.size === 0;
+          shouldTriggerImmediateDeviceChange = _this3.localParticipant.videoTrackPublications.size === 0;
           const prevDeviceId = (_b = _this3.getActiveDevice(kind)) !== null && _b !== void 0 ? _b : _this3.options.videoCaptureDefaults.deviceId;
           _this3.options.videoCaptureDefaults.deviceId = deviceConstraint;
           const tracks = Array.from(_this3.localParticipant.videoTrackPublications.values()).filter(track => track.source === Track.Source.Camera);
@@ -24097,6 +24104,7 @@ class Room extends eventsExports.EventEmitter {
             throw e;
           }
         } else if (kind === 'audiooutput') {
+          shouldTriggerImmediateDeviceChange = true;
           if (!supportsSetSinkId() && !_this3.options.webAudioMix || _this3.options.webAudioMix && _this3.audioContext && !('setSinkId' in _this3.audioContext)) {
             throw new Error('cannot switch audio output, setSinkId not supported');
           }
@@ -24104,7 +24112,7 @@ class Room extends eventsExports.EventEmitter {
             // setting `default` for web audio output doesn't work, so we need to normalize the id before
             deviceId = (_c = yield DeviceManager.getInstance().normalizeDeviceId('audiooutput', deviceId)) !== null && _c !== void 0 ? _c : '';
           }
-          (_d = (_h = _this3.options).audioOutput) !== null && _d !== void 0 ? _d : _h.audioOutput = {};
+          (_d = (_g = _this3.options).audioOutput) !== null && _d !== void 0 ? _d : _g.audioOutput = {};
           const prevDeviceId = (_e = _this3.getActiveDevice(kind)) !== null && _e !== void 0 ? _e : _this3.options.audioOutput.deviceId;
           _this3.options.audioOutput.deviceId = deviceId;
           try {
@@ -24122,9 +24130,8 @@ class Room extends eventsExports.EventEmitter {
             throw e;
           }
         }
-        if (needsUpdateWithoutTracks || kind === 'audiooutput') {
-          // if there are not active tracks yet or we're switching audiooutput, we need to manually update the active device map here as changing audio output won't result in a track restart
-          _this3.localParticipant.activeDeviceMap.set(kind, kind === 'audiooutput' && ((_g = _this3.options.audioOutput) === null || _g === void 0 ? void 0 : _g.deviceId) || deviceId);
+        if (shouldTriggerImmediateDeviceChange) {
+          _this3.localParticipant.activeDeviceMap.set(kind, deviceId);
           _this3.emit(RoomEvent.ActiveDeviceChanged, kind, deviceId);
         }
         return success;
@@ -25249,6 +25256,7 @@ class PublishVideoCheck extends Checker {
         };
         video.play();
       });
+      stream.getTracks().forEach(t => t.stop());
       video.remove();
     });
   }