livekit-client 2.1.1 → 2.1.3

package/dist/livekit-client.esm.mjs

@@ -3321,10 +3321,8 @@ function normalizeFieldInfos(fieldInfos, packedByDefault) {
     f.req = (_e = field.req) !== null && _e !== void 0 ? _e : false;
     f.opt = (_f = field.opt) !== null && _f !== void 0 ? _f : false;
     if (field.packed === undefined) {
-      if (packedByDefault) {
+      {
         f.packed = field.kind == "enum" || field.kind == "scalar" && field.T != ScalarType.BYTES && field.T != ScalarType.STRING;
-      } else {
-        f.packed = false;
       }
     }
     // We do not surface options at this time
@@ -3359,7 +3357,7 @@ function normalizeFieldInfos(fieldInfos, packedByDefault) {
  * Provides functionality for messages defined with the proto3 syntax.
  */
 const proto3 = makeProtoRuntime("proto3", fields => {
-  return new InternalFieldList(fields, source => normalizeFieldInfos(source, true));
+  return new InternalFieldList(fields, source => normalizeFieldInfos(source));
 },
 // TODO merge with proto2 and initExtensionField, also see initPartial, equals, clone
 target => {
@@ -3951,6 +3949,12 @@ const TrackInfo = /*@__PURE__*/proto3.makeMessageType("livekit.TrackInfo", () =>
   name: "version",
   kind: "message",
   T: TimedVersion
+}, {
+  no: 19,
+  name: "audio_features",
+  kind: "enum",
+  T: proto3.getEnumType(AudioTrackFeature),
+  repeated: true
 }]);
 
 /**
@@ -4024,6 +4028,12 @@ const DataPacket = /*@__PURE__*/proto3.makeMessageType("livekit.DataPacket", ()
   kind: "message",
   T: SipDTMF,
   oneof: "value"
+}, {
+  no: 7,
+  name: "transcription",
+  kind: "message",
+  T: Transcription,
+  oneof: "value"
 }]);
 
 /**
@@ -4104,6 +4114,24 @@ const UserPacket = /*@__PURE__*/proto3.makeMessageType("livekit.UserPacket", ()
   kind: "scalar",
   T: 9 /* ScalarType.STRING */,
   opt: true
+}, {
+  no: 8,
+  name: "id",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */,
+  opt: true
+}, {
+  no: 9,
+  name: "start_time",
+  kind: "scalar",
+  T: 4 /* ScalarType.UINT64 */,
+  opt: true
+}, {
+  no: 10,
+  name: "end_time",
+  kind: "scalar",
+  T: 4 /* ScalarType.UINT64 */,
+  opt: true
 }]);
 
 /**
@@ -4121,6 +4149,62 @@ const SipDTMF = /*@__PURE__*/proto3.makeMessageType("livekit.SipDTMF", () => [{
   T: 9 /* ScalarType.STRING */
 }]);
 
+/**
+ * @generated from message livekit.Transcription
+ */
+const Transcription = /*@__PURE__*/proto3.makeMessageType("livekit.Transcription", () => [{
+  no: 2,
+  name: "participant_identity",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
+}, {
+  no: 3,
+  name: "track_id",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
+}, {
+  no: 4,
+  name: "segments",
+  kind: "message",
+  T: TranscriptionSegment,
+  repeated: true
+}]);
+
+/**
+ * @generated from message livekit.TranscriptionSegment
+ */
+const TranscriptionSegment = /*@__PURE__*/proto3.makeMessageType("livekit.TranscriptionSegment", () => [{
+  no: 1,
+  name: "id",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
+}, {
+  no: 2,
+  name: "text",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
+}, {
+  no: 3,
+  name: "start_time",
+  kind: "scalar",
+  T: 4 /* ScalarType.UINT64 */
+}, {
+  no: 4,
+  name: "end_time",
+  kind: "scalar",
+  T: 4 /* ScalarType.UINT64 */
+}, {
+  no: 5,
+  name: "final",
+  kind: "scalar",
+  T: 8 /* ScalarType.BOOL */
+}, {
+  no: 6,
+  name: "language",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */
+}]);
+
 /**
  * @generated from message livekit.ParticipantTracks
  */
@@ -5052,6 +5136,7 @@ const LeaveRequest_Action = /*@__PURE__*/proto3.makeEnum("livekit.LeaveRequest.A
  * message to indicate published video track dimensions are changing
  *
  * @generated from message livekit.UpdateVideoLayers
+ * @deprecated
  */
 const UpdateVideoLayers = /*@__PURE__*/proto3.makeMessageType("livekit.UpdateVideoLayers", () => [{
   no: 1,
@@ -9949,6 +10034,11 @@ var RoomEvent;
    * args: (payload: Uint8Array, participant: [[Participant]], kind: [[DataPacket_Kind]], topic?: string)
    */
   RoomEvent["DataReceived"] = "dataReceived";
+  /**
+   * Transcription received from a participant's track.
+   * @beta
+   */
+  RoomEvent["TranscriptionReceived"] = "transcriptionReceived";
   /**
    * Connection quality was changed for a Participant. It'll receive updates
    * from the local participant, as well as any [[RemoteParticipant]]s that we are
@@ -10130,6 +10220,11 @@ var ParticipantEvent;
    * args: (payload: Uint8Array, kind: [[DataPacket_Kind]])
    */
   ParticipantEvent["DataReceived"] = "dataReceived";
+  /**
+   * Transcription received from this participant as data source.
+   * @beta
+   */
+  ParticipantEvent["TranscriptionReceived"] = "transcriptionReceived";
   /**
    * Has speaking status changed for the current participant
    *
@@ -10199,6 +10294,7 @@ var EngineEvent;
   EngineEvent["MediaTrackAdded"] = "mediaTrackAdded";
   EngineEvent["ActiveSpeakersUpdate"] = "activeSpeakersUpdate";
   EngineEvent["DataPacketReceived"] = "dataPacketReceived";
+  EngineEvent["TranscriptionReceived"] = "transcriptionReceived";
   EngineEvent["RTPVideoMapUpdate"] = "rtpVideoMapUpdate";
   EngineEvent["DCBufferStatusChanged"] = "dcBufferStatusChanged";
   EngineEvent["ParticipantUpdate"] = "participantUpdate";
@@ -10281,6 +10377,14 @@ var TrackEvent;
    * @internal
    */
   TrackEvent["AudioTrackFeatureUpdate"] = "audioTrackFeatureUpdate";
+  /**
+   * @beta
+   */
+  TrackEvent["TranscriptionReceived"] = "transcriptionReceived";
+  /**
+   * @experimental
+   */
+  TrackEvent["TimeSyncUpdate"] = "timeSyncUpdate";
 })(TrackEvent || (TrackEvent = {}));
 
 function r(r, e, n) {
@@ -10395,10 +10499,10 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.1.1";
+var version$1 = "2.1.3";
 
 const version = version$1;
-const protocolVersion = 12;
+const protocolVersion = 13;
 
 /**
  * Timers that can be overridden with platform specific implementations
@@ -10696,6 +10800,9 @@ class Track extends eventsExports.EventEmitter {
     if (this.monitorInterval) {
       clearInterval(this.monitorInterval);
     }
+    if (this.timeSyncHandle) {
+      cancelAnimationFrame(this.timeSyncHandle);
+    }
   }
   /** @internal */
   updateLoggerOptions(loggerOptions) {
@@ -11500,6 +11607,26 @@ function toHttpUrl(url) {
   }
   return url;
 }
+function extractTranscriptionSegments(transcription) {
+  return transcription.segments.map(_ref => {
+    let {
+      id,
+      text,
+      language,
+      startTime,
+      endTime,
+      final
+    } = _ref;
+    return {
+      id,
+      text,
+      startTime: Number.parseInt(startTime.toString()),
+      endTime: Number.parseInt(endTime.toString()),
+      final,
+      language
+    };
+  });
+}
 
 const defaultId = 'default';
 class DeviceManager {
@@ -12806,8 +12933,9 @@ class SignalClient {
     return this.sendRequest({
       case: 'leave',
       value: new LeaveRequest({
-        canReconnect: false,
-        reason: DisconnectReason.CLIENT_INITIATED
+        reason: DisconnectReason.CLIENT_INITIATED,
+        // server doesn't process this field, keeping it here to indicate the intent of a full disconnect
+        action: LeaveRequest_Action.DISCONNECT
       })
     });
   }
@@ -15788,7 +15916,7 @@ class RTCEngine extends eventsExports.EventEmitter {
       }();
     });
     this.handleDataMessage = message => __awaiter(this, void 0, void 0, function* () {
-      var _c, _d;
+      var _c, _d, _e;
       // make sure to respect incoming data message order by processing message events one after the other
       const unlock = yield this.dataProcessLock.lock();
       try {
@@ -15810,6 +15938,8 @@ class RTCEngine extends eventsExports.EventEmitter {
           this.emit(EngineEvent.ActiveSpeakersUpdate, dp.value.value.speakers);
         } else if (((_d = dp.value) === null || _d === void 0 ? void 0 : _d.case) === 'user') {
           this.emit(EngineEvent.DataPacketReceived, dp.value.value, dp.kind);
+        } else if (((_e = dp.value) === null || _e === void 0 ? void 0 : _e.case) === 'transcription') {
+          this.emit(EngineEvent.TranscriptionReceived, dp.value.value);
         }
       } finally {
         unlock();
@@ -16094,7 +16224,7 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
   configure(joinResponse) {
     return __awaiter(this, void 0, void 0, function* () {
-      var _a;
+      var _a, _b;
       // already configured
       if (this.pcManager && this.pcManager.currentState !== PCTransportState.NEW) {
         return;
@@ -16139,7 +16269,9 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.pcManager.onTrack = ev => {
         this.emit(EngineEvent.MediaTrackAdded, ev.track, ev.streams[0], ev.receiver);
       };
-      this.createDataChannels();
+      if (!supportOptionalDatachannel((_b = joinResponse.serverInfo) === null || _b === void 0 ? void 0 : _b.protocol)) {
+        this.createDataChannels();
+      }
     });
   }
   setupSignalClientCallbacks() {
@@ -16206,17 +16338,27 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.handleDisconnect('signal', ReconnectReason.RR_SIGNAL_DISCONNECTED);
     };
     this.client.onLeave = leave => {
-      if (leave === null || leave === void 0 ? void 0 : leave.canReconnect) {
-        this.fullReconnectOnNext = true;
-        // reconnect immediately instead of waiting for next attempt
-        this.handleDisconnect(leaveReconnect);
-      } else {
-        this.emit(EngineEvent.Disconnected, leave === null || leave === void 0 ? void 0 : leave.reason);
-        this.close();
-      }
       this.log.debug('client leave request', Object.assign(Object.assign({}, this.logContext), {
         reason: leave === null || leave === void 0 ? void 0 : leave.reason
       }));
+      if (leave.regions && this.regionUrlProvider) {
+        this.log.debug('updating regions', this.logContext);
+        this.regionUrlProvider.setServerReportedRegions(leave.regions);
+      }
+      switch (leave.action) {
+        case LeaveRequest_Action.DISCONNECT:
+          this.emit(EngineEvent.Disconnected, leave === null || leave === void 0 ? void 0 : leave.reason);
+          this.close();
+          break;
+        case LeaveRequest_Action.RECONNECT:
+          this.fullReconnectOnNext = true;
+          // reconnect immediately instead of waiting for next attempt
+          this.handleDisconnect(leaveReconnect);
+          break;
+        case LeaveRequest_Action.RESUME:
+          // reconnect immediately instead of waiting for next attempt
+          this.handleDisconnect(leaveReconnect);
+      }
     };
   }
   makeRTCConfiguration(serverResponse) {
@@ -16600,7 +16742,15 @@ class RTCEngine extends eventsExports.EventEmitter {
         if (!transport) {
           throw new ConnectionError("".concat(transportName, " connection not set"));
         }
-        if (!subscriber && !_this2.pcManager.publisher.isICEConnected && _this2.pcManager.publisher.getICEConnectionState() !== 'checking') {
+        let needNegotiation = false;
+        if (!subscriber && !_this2.dataChannelForKind(kind, subscriber)) {
+          _this2.createDataChannels();
+          needNegotiation = true;
+        }
+        if (!needNegotiation && !subscriber && !_this2.pcManager.publisher.isICEConnected && _this2.pcManager.publisher.getICEConnectionState() !== 'checking') {
+          needNegotiation = true;
+        }
+        if (needNegotiation) {
           // start negotiation
           _this2.negotiate();
         }
@@ -16653,6 +16803,10 @@ class RTCEngine extends eventsExports.EventEmitter {
           return;
         }
         this.pcManager.requirePublisher();
+        // don't negotiate without any transceivers or data channel, it will generate sdp without ice frag then negotiate failed
+        if (this.pcManager.publisher.getTransceivers().length == 0 && !this.lossyDC && !this.reliableDC) {
+          this.createDataChannels();
+        }
         const abortController = new AbortController();
         const handleClosed = () => {
           abortController.abort();
@@ -16793,6 +16947,9 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
 }
 class SignalReconnectError extends Error {}
+function supportOptionalDatachannel(protocol) {
+  return protocol !== undefined && protocol > 13;
+}
 
 class RegionUrlProvider {
   constructor(url, token) {
@@ -16851,6 +17008,10 @@ class RegionUrlProvider {
       }
     });
   }
+  setServerReportedRegions(regions) {
+    this.regionSettings = regions;
+    this.lastUpdateAt = Date.now();
+  }
 }
 function getCloudConfigUrl(serverUrl) {
   return "".concat(serverUrl.protocol.replace('ws', 'http'), "//").concat(serverUrl.host, "/settings");
@@ -16915,6 +17076,28 @@ class RemoteTrack extends Track {
     if (!this.monitorInterval) {
       this.monitorInterval = setInterval(() => this.monitorReceiver(), monitorFrequency);
     }
+    this.registerTimeSyncUpdate();
+  }
+  registerTimeSyncUpdate() {
+    const loop = () => {
+      var _a;
+      this.timeSyncHandle = requestAnimationFrame(() => loop());
+      const sources = (_a = this.receiver) === null || _a === void 0 ? void 0 : _a.getSynchronizationSources()[0];
+      if (sources) {
+        const {
+          timestamp,
+          rtpTimestamp
+        } = sources;
+        if (rtpTimestamp && this.rtpTimestamp !== rtpTimestamp) {
+          this.emit(TrackEvent.TimeSyncUpdate, {
+            timestamp,
+            rtpTimestamp
+          });
+          this.rtpTimestamp = rtpTimestamp;
+        }
+      }
+    };
+    loop();
   }
 }
 
@@ -20006,6 +20189,16 @@ class Room extends eventsExports.EventEmitter {
       // also emit on the participant
       participant === null || participant === void 0 ? void 0 : participant.emit(ParticipantEvent.DataReceived, userPacket.payload, kind);
     };
+    this.bufferedSegments = new Map();
+    this.handleTranscription = transcription => {
+      // find the participant
+      const participant = transcription.participantIdentity === this.localParticipant.identity ? this.localParticipant : this.remoteParticipants.get(transcription.participantIdentity);
+      const publication = participant === null || participant === void 0 ? void 0 : participant.trackPublications.get(transcription.trackId);
+      const segments = extractTranscriptionSegments(transcription);
+      publication === null || publication === void 0 ? void 0 : publication.emit(TrackEvent.TranscriptionReceived, segments);
+      participant === null || participant === void 0 ? void 0 : participant.emit(ParticipantEvent.TranscriptionReceived, segments, publication);
+      this.emit(RoomEvent.TranscriptionReceived, segments, participant, publication);
+    };
     this.handleAudioPlaybackStarted = () => {
       if (this.canPlaybackAudio) {
         return;
@@ -20231,7 +20424,7 @@ class Room extends eventsExports.EventEmitter {
       this.onTrackAdded(mediaTrack, stream, receiver);
     }).on(EngineEvent.Disconnected, reason => {
       this.handleDisconnect(this.options.stopLocalTrackOnUnpublish, reason);
-    }).on(EngineEvent.ActiveSpeakersUpdate, this.handleActiveSpeakersUpdate).on(EngineEvent.DataPacketReceived, this.handleDataPacket).on(EngineEvent.Resuming, () => {
+    }).on(EngineEvent.ActiveSpeakersUpdate, this.handleActiveSpeakersUpdate).on(EngineEvent.DataPacketReceived, this.handleDataPacket).on(EngineEvent.TranscriptionReceived, this.handleTranscription).on(EngineEvent.Resuming, () => {
       this.clearConnectionReconcile();
       this.isResuming = true;
       this.log.info('Resuming signal connection', this.logContext);
@@ -20417,7 +20610,7 @@ class Room extends eventsExports.EventEmitter {
             if (onLeave) {
               onLeave(new LeaveRequest({
                 reason: DisconnectReason.CLIENT_INITIATED,
-                canReconnect: true
+                action: LeaveRequest_Action.RECONNECT
               }));
             }
           });