livekit-client 2.0.0 → 2.0.1

package/README.md

@@ -11,7 +11,9 @@
 # JavaScript/TypeScript client SDK for LiveKit
 
 <!--BEGIN_DESCRIPTION-->
+
 Use this SDK to add real-time video, audio and data features to your JavaScript/TypeScript app. By connecting to a self- or cloud-hosted <a href="https://livekit.io/">LiveKit</a> server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code.
+
 <!--END_DESCRIPTION-->
 
 ## Docs
@@ -20,6 +22,10 @@ Docs and guides at [https://docs.livekit.io](https://docs.livekit.io)
 
 [SDK reference](https://docs.livekit.io/client-sdk-js/)
 
+> [!NOTE]
+> This is v2 of `livekit-client`. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
+> Read the [migration guide](https://docs.livekit.io/guides/migrate-from-v1/) for a detailed overview of what has changed.
+
 ## Installation
 
 ### Yarn
@@ -323,7 +329,9 @@ If you are targeting legacy browsers, but still want adaptiveStream functionalit
 Also when targeting legacy browsers, older than the ones specified in our browserslist target, make sure to transpile the library code to your desired target and include required polyfills with babel and/or corejs.
 
 <!--BEGIN_REPO_NAV-->
+
 <br/><table>
+
 <thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
 <tbody>
 <tr><td>Real-time SDKs</td><td><a href="https://github.com/livekit/components-js">React Components</a> · <b>JavaScript</b> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/client-sdk-rust">Rust</a> · <a href="https://github.com/livekit/client-sdk-python">Python</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (web)</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity (beta)</a></td></tr><tr></tr>

package/dist/livekit-client.esm.mjs

@@ -3874,6 +3874,14 @@ var DisconnectReason;
    * @generated from enum value: JOIN_FAILURE = 7;
    */
   DisconnectReason[DisconnectReason["JOIN_FAILURE"] = 7] = "JOIN_FAILURE";
+  /**
+   * @generated from enum value: MIGRATION = 8;
+   */
+  DisconnectReason[DisconnectReason["MIGRATION"] = 8] = "MIGRATION";
+  /**
+   * @generated from enum value: SIGNAL_CLOSE = 9;
+   */
+  DisconnectReason[DisconnectReason["SIGNAL_CLOSE"] = 9] = "SIGNAL_CLOSE";
 })(DisconnectReason || (DisconnectReason = {}));
 // Retrieve enum metadata with: proto3.getEnumType(DisconnectReason)
 proto3.util.setEnumType(DisconnectReason, "livekit.DisconnectReason", [{
@@ -3900,6 +3908,12 @@ proto3.util.setEnumType(DisconnectReason, "livekit.DisconnectReason", [{
 }, {
   no: 7,
   name: "JOIN_FAILURE"
+}, {
+  no: 8,
+  name: "MIGRATION"
+}, {
+  no: 9,
+  name: "SIGNAL_CLOSE"
 }]);
 /**
  * @generated from enum livekit.ReconnectReason
@@ -10108,7 +10122,14 @@ var RoomEvent;
   RoomEvent["Reconnected"] = "reconnected";
   /**
    * When disconnected from room. This fires when room.disconnect() is called or
-   * when an unrecoverable connection issue had occured
+   * when an unrecoverable connection issue had occured.
+   *
+   * DisconnectReason can be used to determine why the participant was disconnected. Notable reasons are
+   * - DUPLICATE_IDENTITY: another client with the same identity has joined the room
+   * - PARTICIPANT_REMOVED: participant was removed by RemoveParticipant API
+   * - ROOM_DELETED: the room has ended via DeleteRoom API
+   *
+   * args: ([[DisconnectReason]])
    */
   RoomEvent["Disconnected"] = "disconnected";
   /**
@@ -10682,7 +10703,7 @@ function getMatch(exp, ua) {
   return match && match.length >= id && match[id] || '';
 }
 
-var version$1 = "2.0.0";
+var version$1 = "2.0.1";
 
 const version = version$1;
 const protocolVersion = 12;
@@ -11943,6 +11964,7 @@ class LeaveRequest extends Message {
     /**
      * sent when server initiates the disconnect due to server-restart
      * indicates clients should attempt full-reconnect sequence
+     * NOTE: `can_reconnect` obsoleted by `action` starting in protocol version 13
      *
      * @generated from field: bool can_reconnect = 1;
      */
@@ -11951,6 +11973,10 @@ class LeaveRequest extends Message {
      * @generated from field: livekit.DisconnectReason reason = 2;
      */
     this.reason = DisconnectReason.UNKNOWN_REASON;
+    /**
+     * @generated from field: livekit.LeaveRequest.Action action = 3;
+     */
+    this.action = LeaveRequest_Action.DISCONNECT;
     proto3.util.initPartial(data, this);
   }
   static fromBinary(bytes, options) {
@@ -11978,6 +12004,53 @@ LeaveRequest.fields = proto3.util.newFieldList(() => [{
   name: "reason",
   kind: "enum",
   T: proto3.getEnumType(DisconnectReason)
+}, {
+  no: 3,
+  name: "action",
+  kind: "enum",
+  T: proto3.getEnumType(LeaveRequest_Action)
+}, {
+  no: 4,
+  name: "regions",
+  kind: "message",
+  T: RegionSettings
+}]);
+/**
+ * indicates action clients should take on receiving this message
+ *
+ * @generated from enum livekit.LeaveRequest.Action
+ */
+var LeaveRequest_Action;
+(function (LeaveRequest_Action) {
+  /**
+   * should disconnect
+   *
+   * @generated from enum value: DISCONNECT = 0;
+   */
+  LeaveRequest_Action[LeaveRequest_Action["DISCONNECT"] = 0] = "DISCONNECT";
+  /**
+   * should attempt a resume with `reconnect=1` in join URL
+   *
+   * @generated from enum value: RESUME = 1;
+   */
+  LeaveRequest_Action[LeaveRequest_Action["RESUME"] = 1] = "RESUME";
+  /**
+   * should attempt a reconnect, i. e. no `reconnect=1`
+   *
+   * @generated from enum value: RECONNECT = 2;
+   */
+  LeaveRequest_Action[LeaveRequest_Action["RECONNECT"] = 2] = "RECONNECT";
+})(LeaveRequest_Action || (LeaveRequest_Action = {}));
+// Retrieve enum metadata with: proto3.getEnumType(LeaveRequest_Action)
+proto3.util.setEnumType(LeaveRequest_Action, "livekit.LeaveRequest.Action", [{
+  no: 0,
+  name: "DISCONNECT"
+}, {
+  no: 1,
+  name: "RESUME"
+}, {
+  no: 2,
+  name: "RECONNECT"
 }]);
 /**
  * message to indicate published video track dimensions are changing
@@ -12660,6 +12733,10 @@ class SyncState extends Message {
      * @generated from field: repeated livekit.DataChannelInfo data_channels = 4;
      */
     this.dataChannels = [];
+    /**
+     * @generated from field: repeated string track_sids_disabled = 6;
+     */
+    this.trackSidsDisabled = [];
     proto3.util.initPartial(data, this);
   }
   static fromBinary(bytes, options) {
@@ -12704,6 +12781,12 @@ SyncState.fields = proto3.util.newFieldList(() => [{
   name: "offer",
   kind: "message",
   T: SessionDescription
+}, {
+  no: 6,
+  name: "track_sids_disabled",
+  kind: "scalar",
+  T: 9 /* ScalarType.STRING */,
+  repeated: true
 }]);
 /**
  * @generated from message livekit.DataChannelInfo
@@ -13731,10 +13814,6 @@ function isFireFox() {
   var _a;
   return ((_a = getBrowser()) === null || _a === void 0 ? void 0 : _a.name) === 'Firefox';
 }
-function isChromiumBased() {
-  var _a;
-  return ((_a = getBrowser()) === null || _a === void 0 ? void 0 : _a.name) === 'Chrome';
-}
 function isSafari() {
   var _a;
   return ((_a = getBrowser()) === null || _a === void 0 ? void 0 : _a.name) === 'Safari';
@@ -16218,8 +16297,7 @@ class PCTransport extends eventsExports.EventEmitter {
     return this._pc;
   }
   constructor(config) {
-    let mediaConstraints = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    let loggerOptions = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+    let loggerOptions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     var _a;
     super();
     this.log = livekitLogger;
@@ -16263,13 +16341,10 @@ class PCTransport extends eventsExports.EventEmitter {
     this.log = getLogger((_a = loggerOptions.loggerName) !== null && _a !== void 0 ? _a : LoggerNames.PCTransport);
     this.loggerOptions = loggerOptions;
     this.config = config;
-    this.mediaConstraints = mediaConstraints;
     this._pc = this.createPC();
   }
   createPC() {
-    const pc = isChromiumBased() ?
-    // @ts-expect-error chrome allows additional media constraints to be passed into the RTCPeerConnection constructor
-    new RTCPeerConnection(this.config, this.mediaConstraints) : new RTCPeerConnection(this.config);
+    const pc = new RTCPeerConnection(this.config);
     pc.onicecandidate = ev => {
       var _a;
       if (!ev.candidate) return;
@@ -16812,12 +16887,7 @@ class PCTransportManager {
     this.loggerOptions = loggerOptions;
     this.isPublisherConnectionRequired = !subscriberPrimary;
     this.isSubscriberConnectionRequired = subscriberPrimary;
-    const googConstraints = {
-      optional: [{
-        googDscp: true
-      }]
-    };
-    this.publisher = new PCTransport(rtcConfig, googConstraints, loggerOptions);
+    this.publisher = new PCTransport(rtcConfig, loggerOptions);
     this.subscriber = new PCTransport(rtcConfig, loggerOptions);
     this.publisher.onConnectionStateChange = this.updateState;
     this.subscriber.onConnectionStateChange = this.updateState;
@@ -18056,10 +18126,14 @@ class RTCEngine extends eventsExports.EventEmitter {
     */
     const autoSubscribe = (_b = (_a = this.signalOpts) === null || _a === void 0 ? void 0 : _a.autoSubscribe) !== null && _b !== void 0 ? _b : true;
     const trackSids = new Array();
+    const trackSidsDisabled = new Array();
     remoteTracks.forEach(track => {
       if (track.isDesired !== autoSubscribe) {
         trackSids.push(track.trackSid);
       }
+      if (!track.isEnabled) {
+        trackSidsDisabled.push(track.trackSid);
+      }
     });
     this.client.sendSyncState(new SyncState({
       answer: previousAnswer ? toProtoSessionDescription({
@@ -18076,7 +18150,8 @@ class RTCEngine extends eventsExports.EventEmitter {
         participantTracks: []
       }),
       publishTracks: getTrackPublicationInfo(localTracks),
-      dataChannels: this.dataChannelsInfo()
+      dataChannels: this.dataChannelsInfo(),
+      trackSidsDisabled
     }));
   }
   /* @internal */