livekit-client 2.4.1 → 2.5.0

package/dist/livekit-client.esm.mjs

@@ -3527,6 +3527,9 @@ const DisconnectReason = /*@__PURE__*/proto3.makeEnum("livekit.DisconnectReason"
 }, {
   no: 9,
   name: "SIGNAL_CLOSE"
+}, {
+  no: 10,
+  name: "ROOM_CLOSED"
 }]);
 
 /**
@@ -3791,6 +3794,11 @@ const ParticipantInfo = /*@__PURE__*/proto3.makeMessageType("livekit.Participant
     kind: "scalar",
     T: 9 /* ScalarType.STRING */
   }
+}, {
+  no: 16,
+  name: "disconnect_reason",
+  kind: "enum",
+  T: proto3.getEnumType(DisconnectReason)
 }]);
 
 /**
@@ -4742,9 +4750,15 @@ const SignalResponse = /*@__PURE__*/proto3.makeMessageType("livekit.SignalRespon
   oneof: "message"
 }, {
   no: 22,
-  name: "error_response",
+  name: "request_response",
   kind: "message",
-  T: ErrorResponse,
+  T: RequestResponse,
+  oneof: "message"
+}, {
+  no: 23,
+  name: "track_subscribed",
+  kind: "message",
+  T: TrackSubscribed,
   oneof: "message"
 }]);
 
@@ -4858,6 +4872,11 @@ const TrickleRequest = /*@__PURE__*/proto3.makeMessageType("livekit.TrickleReque
   name: "target",
   kind: "enum",
   T: proto3.getEnumType(SignalTarget)
+}, {
+  no: 3,
+  name: "final",
+  kind: "scalar",
+  T: 8 /* ScalarType.BOOL */
 }]);
 
 /**
@@ -5615,9 +5634,9 @@ const SubscriptionResponse = /*@__PURE__*/proto3.makeMessageType("livekit.Subscr
 }]);
 
 /**
- * @generated from message livekit.ErrorResponse
+ * @generated from message livekit.RequestResponse
  */
-const ErrorResponse = /*@__PURE__*/proto3.makeMessageType("livekit.ErrorResponse", () => [{
+const RequestResponse = /*@__PURE__*/proto3.makeMessageType("livekit.RequestResponse", () => [{
   no: 1,
   name: "request_id",
   kind: "scalar",
@@ -5626,7 +5645,7 @@ const ErrorResponse = /*@__PURE__*/proto3.makeMessageType("livekit.ErrorResponse
   no: 2,
   name: "reason",
   kind: "enum",
-  T: proto3.getEnumType(ErrorResponse_Reason)
+  T: proto3.getEnumType(RequestResponse_Reason)
 }, {
   no: 3,
   name: "message",
@@ -5635,11 +5654,11 @@ const ErrorResponse = /*@__PURE__*/proto3.makeMessageType("livekit.ErrorResponse
 }]);
 
 /**
- * @generated from enum livekit.ErrorResponse.Reason
+ * @generated from enum livekit.RequestResponse.Reason
  */
-const ErrorResponse_Reason = /*@__PURE__*/proto3.makeEnum("livekit.ErrorResponse.Reason", [{
+const RequestResponse_Reason = /*@__PURE__*/proto3.makeEnum("livekit.RequestResponse.Reason", [{
   no: 0,
-  name: "UNKNOWN"
+  name: "OK"
 }, {
   no: 1,
   name: "NOT_FOUND"
@@ -5648,7 +5667,17 @@ const ErrorResponse_Reason = /*@__PURE__*/proto3.makeEnum("livekit.ErrorResponse
   name: "NOT_ALLOWED"
 }, {
   no: 3,
-  name: "INVALID_ARGUMENT"
+  name: "LIMIT_EXCEEDED"
+}]);
+
+/**
+ * @generated from message livekit.TrackSubscribed
+ */
+const TrackSubscribed = /*@__PURE__*/proto3.makeMessageType("livekit.TrackSubscribed", () => [{
+  no: 1,
+  name: "track_sid",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
 }]);
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
@@ -9818,8 +9847,7 @@ class PublishDataError extends LivekitError {
   }
 }
 class SignalRequestError extends LivekitError {
-  constructor(message) {
-    let reason = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : ErrorResponse_Reason.UNKNOWN;
+  constructor(message, reason) {
     super(15, message);
     this.reason = reason;
   }
@@ -10346,8 +10374,9 @@ var EngineEvent;
   EngineEvent["RemoteMute"] = "remoteMute";
   EngineEvent["SubscribedQualityUpdate"] = "subscribedQualityUpdate";
   EngineEvent["LocalTrackUnpublished"] = "localTrackUnpublished";
+  EngineEvent["LocalTrackSubscribed"] = "localTrackSubscribed";
   EngineEvent["Offline"] = "offline";
-  EngineEvent["SignalRequestError"] = "signalRequestError";
+  EngineEvent["SignalRequestResponse"] = "signalRequestResponse";
 })(EngineEvent || (EngineEvent = {}));
 var TrackEvent;
 (function (TrackEvent) {
@@ -10539,10 +10568,10 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.4.1";
+var version$1 = "2.5.0";
 
 const version = version$1;
-const protocolVersion = 13;
+const protocolVersion = 15;
 
 /**
  * Timers that can be overridden with platform specific implementations
@@ -12863,6 +12892,7 @@ class SignalClient {
       return function* () {
         const unlock = yield _this.closingLock.lock();
         try {
+          _this.clearPingInterval();
           if (updateState) {
             _this.state = SignalConnectionState.DISCONNECTING;
           }
@@ -12891,7 +12921,6 @@ class SignalClient {
           if (updateState) {
             _this.state = SignalConnectionState.DISCONNECTED;
           }
-          _this.clearPingInterval();
           unlock();
         }
       }();
@@ -13158,9 +13187,13 @@ class SignalClient {
       this.rtt = Date.now() - Number.parseInt(msg.value.lastPingTimestamp.toString());
       this.resetPingTimeout();
       pingHandled = true;
-    } else if (msg.case === 'errorResponse') {
-      if (this.onErrorResponse) {
-        this.onErrorResponse(msg.value);
+    } else if (msg.case === 'requestResponse') {
+      if (this.onRequestResponse) {
+        this.onRequestResponse(msg.value);
+      }
+    } else if (msg.case === 'trackSubscribed') {
+      if (this.onLocalTrackSubscribed) {
+        this.onLocalTrackSubscribed(msg.value.trackSid);
       }
     } else {
       this.log.debug('unsupported message', Object.assign(Object.assign({}, this.logContext), {
@@ -14195,6 +14228,9 @@ class PCTransport extends eventsExports.EventEmitter {
       // actually negotiate
       this.log.debug('starting to negotiate', this.logContext);
       const offer = yield this.pc.createOffer(options);
+      this.log.debug('original offer', Object.assign({
+        sdp: offer.sdp
+      }, this.logContext));
       const sdpParsed = parse((_a = offer.sdp) !== null && _a !== void 0 ? _a : '');
       sdpParsed.media.forEach(media => {
         if (media.type === 'audio') {
@@ -16211,7 +16247,7 @@ class RTCEngine extends eventsExports.EventEmitter {
     this.client.onSubscriptionPermissionUpdate = update => this.emit(EngineEvent.SubscriptionPermissionUpdate, update);
     this.client.onSpeakersChanged = update => this.emit(EngineEvent.SpeakersChanged, update);
     this.client.onStreamStateUpdate = update => this.emit(EngineEvent.StreamStateChanged, update);
-    this.client.onErrorResponse = error => this.emit(EngineEvent.SignalRequestError, error);
+    this.client.onRequestResponse = response => this.emit(EngineEvent.SignalRequestResponse, response);
   }
   /** @internal */
   get logContext() {
@@ -16477,6 +16513,9 @@ class RTCEngine extends eventsExports.EventEmitter {
     this.client.onLocalTrackUnpublished = response => {
       this.emit(EngineEvent.LocalTrackUnpublished, response);
     };
+    this.client.onLocalTrackSubscribed = trackSid => {
+      this.emit(EngineEvent.LocalTrackSubscribed, trackSid);
+    };
     this.client.onTokenRefresh = token => {
       this.token = token;
     };
@@ -17198,6 +17237,9 @@ class RemoteTrack extends Track {
     const onRemoveTrack = event => {
       if (event.track === this._mediaStreamTrack) {
         stream.removeEventListener('removetrack', onRemoveTrack);
+        if (this.receiver && 'playoutDelayHint' in this.receiver) {
+          this.receiver.playoutDelayHint = undefined;
+        }
         this.receiver = undefined;
         this._currentBitrate = 0;
         this.emit(TrackEvent.Ended, this);
@@ -17231,6 +17273,37 @@ class RemoteTrack extends Track {
       return statsReport;
     });
   }
+  /**
+   * Allows to set a playout delay (in seconds) for this track.
+   * A higher value allows for more buffering of the track in the browser
+   * and will result in a delay of media being played back of `delayInSeconds`
+   */
+  setPlayoutDelay(delayInSeconds) {
+    if (this.receiver) {
+      if ('playoutDelayHint' in this.receiver) {
+        this.receiver.playoutDelayHint = delayInSeconds;
+      } else {
+        this.log.warn('Playout delay not supported in this browser');
+      }
+    } else {
+      this.log.warn('Cannot set playout delay, track already ended');
+    }
+  }
+  /**
+   * Returns the current playout delay (in seconds) of this track.
+   */
+  getPlayoutDelay() {
+    if (this.receiver) {
+      if ('playoutDelayHint' in this.receiver) {
+        return this.receiver.playoutDelayHint;
+      } else {
+        this.log.warn('Playout delay not supported in this browser');
+      }
+    } else {
+      this.log.warn('Cannot get playout delay, track already ended');
+    }
+    return 0;
+  }
   /* @internal */
   startMonitor() {
     if (!this.monitorInterval) {
@@ -18261,15 +18334,17 @@ class LocalParticipant extends Participant {
         this.reconnectFuture = undefined;
       }
     };
-    this.handleSignalRequestError = error => {
+    this.handleSignalRequestResponse = response => {
       const {
         requestId,
         reason,
         message
-      } = error;
-      const failedRequest = this.pendingSignalRequests.get(requestId);
-      if (failedRequest) {
-        failedRequest.reject(new SignalRequestError(message, reason));
+      } = response;
+      const targetRequest = this.pendingSignalRequests.get(requestId);
+      if (targetRequest) {
+        if (reason !== RequestResponse_Reason.OK) {
+          targetRequest.reject(new SignalRequestError(message, reason));
+        }
         this.pendingSignalRequests.delete(requestId);
       }
     };
@@ -18453,7 +18528,7 @@ class LocalParticipant extends Participant {
         pub.unmute();
       }
     });
-    this.engine.on(EngineEvent.Connected, this.handleReconnected).on(EngineEvent.SignalRestarted, this.handleReconnected).on(EngineEvent.SignalResumed, this.handleReconnected).on(EngineEvent.Restarting, this.handleReconnecting).on(EngineEvent.Resuming, this.handleReconnecting).on(EngineEvent.LocalTrackUnpublished, this.handleLocalTrackUnpublished).on(EngineEvent.SubscribedQualityUpdate, this.handleSubscribedQualityUpdate).on(EngineEvent.Disconnected, this.handleDisconnected).on(EngineEvent.SignalRequestError, this.handleSignalRequestError);
+    this.engine.on(EngineEvent.Connected, this.handleReconnected).on(EngineEvent.SignalRestarted, this.handleReconnected).on(EngineEvent.SignalResumed, this.handleReconnected).on(EngineEvent.Restarting, this.handleReconnecting).on(EngineEvent.Resuming, this.handleReconnecting).on(EngineEvent.LocalTrackUnpublished, this.handleLocalTrackUnpublished).on(EngineEvent.SubscribedQualityUpdate, this.handleSubscribedQualityUpdate).on(EngineEvent.Disconnected, this.handleDisconnected).on(EngineEvent.SignalRequestResponse, this.handleSignalRequestResponse);
   }
   /**
    * Sets and updates the metadata of the local participant.
@@ -18532,7 +18607,7 @@ class LocalParticipant extends Participant {
               }
               yield sleep(50);
             }
-            reject(new SignalRequestError('Request to update local metadata timed out'));
+            reject(new SignalRequestError('Request to update local metadata timed out', 'TimeoutError'));
           } catch (e) {
             if (e instanceof Error) reject(e);
           }
@@ -19986,7 +20061,7 @@ class Room extends eventsExports.EventEmitter {
         });
       }
       const connectFn = (resolve, reject, regionUrl) => __awaiter(this, void 0, void 0, function* () {
-        var _a;
+        var _a, _b;
         if (this.abortController) {
           this.abortController.abort();
         }
@@ -20011,7 +20086,7 @@ class Room extends eventsExports.EventEmitter {
                 return;
               }
             }
-            if (nextUrl) {
+            if (nextUrl && !((_b = this.abortController) === null || _b === void 0 ? void 0 : _b.signal.aborted)) {
               this.log.info("Initial connection failed with ConnectionError: ".concat(e.message, ". Retrying with another region: ").concat(nextUrl), this.logContext);
               this.recreateEngine();
               yield connectFn(resolve, reject, nextUrl);
@@ -21468,7 +21543,7 @@ class Room extends eventsExports.EventEmitter {
             sid: Math.floor(Math.random() * 10000).toString(),
             type: TrackType.AUDIO
           });
-          p.addSubscribedMediaTrack(dummyVideo, videoTrack.sid, new MediaStream([dummyVideo]));
+          p.addSubscribedMediaTrack(dummyVideo, videoTrack.sid, new MediaStream([dummyVideo]), new RTCRtpReceiver());
           info.tracks = [...info.tracks, videoTrack];
         }
         if (participantOptions.audio) {
@@ -21478,7 +21553,7 @@ class Room extends eventsExports.EventEmitter {
             sid: Math.floor(Math.random() * 10000).toString(),
             type: TrackType.AUDIO
           });
-          p.addSubscribedMediaTrack(dummyTrack, audioTrack.sid, new MediaStream([dummyTrack]));
+          p.addSubscribedMediaTrack(dummyTrack, audioTrack.sid, new MediaStream([dummyTrack]), new RTCRtpReceiver());
           info.tracks = [...info.tracks, audioTrack];
         }
         p.updateInfo(info);
@@ -21774,7 +21849,7 @@ class PublishAudioCheck extends Checker {
       }
       let numPackets = 0;
       stats.forEach(stat => {
-        if (stat.type === 'outbound-rtp' && stat.mediaType === 'audio') {
+        if (stat.type === 'outbound-rtp' && (stat.kind === 'audio' || !stat.kind && stat.mediaType === 'audio')) {
           numPackets = stat.packetsSent;
         }
       });
@@ -21797,7 +21872,7 @@ class PublishVideoCheck extends Checker {
       const track = yield createLocalVideoTrack();
       room.localParticipant.publishTrack(track);
       // wait for a few seconds to publish
-      yield new Promise(resolve => setTimeout(resolve, 3000));
+      yield new Promise(resolve => setTimeout(resolve, 5000));
       // verify RTC stats that it's publishing
       const stats = yield (_a = track.sender) === null || _a === void 0 ? void 0 : _a.getStats();
       if (!stats) {
@@ -21805,8 +21880,8 @@ class PublishVideoCheck extends Checker {
       }
       let numPackets = 0;
       stats.forEach(stat => {
-        if (stat.type === 'outbound-rtp' && stat.mediaType === 'video') {
-          numPackets = stat.packetsSent;
+        if (stat.type === 'outbound-rtp' && (stat.kind === 'video' || !stat.kind && stat.mediaType === 'video')) {
+          numPackets += stat.packetsSent;
         }
       });
       if (numPackets === 0) {