livekit-client 1.15.12 → 2.0.1

package/src/index.ts

@@ -1,7 +1,7 @@
 import { LogLevel, getLogger, setLogExtension, setLogLevel } from './logger';
-import { DataPacket_Kind, DisconnectReason, VideoQuality } from './proto/livekit_models_pb';
+import { DataPacket_Kind, DisconnectReason } from './proto/livekit_models_pb';
 import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
-import Room, { ConnectionState, RoomState } from './room/Room';
+import Room, { ConnectionState } from './room/Room';
 import LocalParticipant from './room/participant/LocalParticipant';
 import Participant, { ConnectionQuality } from './room/participant/Participant';
 import type { ParticipantTrackPermission } from './room/participant/ParticipantTrackPermission';
@@ -58,7 +58,6 @@ export {
   getLogger,
   Room,
   ConnectionState,
-  RoomState,
   DataPacket_Kind,
   DisconnectReason,
   Participant,
@@ -73,7 +72,6 @@ export {
   RemoteVideoTrack,
   RemoteTrackPublication,
   TrackPublication,
-  VideoQuality,
   ConnectionQuality,
   DefaultReconnectPolicy,
   CriticalTimers,

package/src/options.ts

@@ -81,12 +81,11 @@ export interface InternalRoomOptions {
   expSignalLatency?: number;
 
   /**
-   * @internal
-   * @experimental
-   * experimental flag, mix all audio tracks in web audio
+   * mix all audio tracks in web audio, helps to tackle some audio auto playback issues
+   * allows for passing in your own AudioContext instance, too
    */
 
-  expWebAudioMix: boolean | WebAudioSettings;
+  webAudioMix: boolean | WebAudioSettings;
 
   /**
    * @experimental
@@ -116,12 +115,6 @@ export interface InternalRoomConnectOptions {
    */
   rtcConfig?: RTCConfiguration;
 
-  /**
-   * @deprecated
-   * publish only mode
-   */
-  publishOnly?: string;
-
   /** specifies how often an initial join connection is allowed to retry (only applicable if server is not reachable) */
   maxRetries: number;
 

package/src/proto/livekit_models_pb.ts

@@ -301,6 +301,16 @@ export enum DisconnectReason {
    * @generated from enum value: JOIN_FAILURE = 7;
    */
   JOIN_FAILURE = 7,
+
+  /**
+   * @generated from enum value: MIGRATION = 8;
+   */
+  MIGRATION = 8,
+
+  /**
+   * @generated from enum value: SIGNAL_CLOSE = 9;
+   */
+  SIGNAL_CLOSE = 9,
 }
 // Retrieve enum metadata with: proto3.getEnumType(DisconnectReason)
 proto3.util.setEnumType(DisconnectReason, "livekit.DisconnectReason", [
@@ -312,6 +322,8 @@ proto3.util.setEnumType(DisconnectReason, "livekit.DisconnectReason", [
   { no: 5, name: "ROOM_DELETED" },
   { no: 6, name: "STATE_MISMATCH" },
   { no: 7, name: "JOIN_FAILURE" },
+  { no: 8, name: "MIGRATION" },
+  { no: 9, name: "SIGNAL_CLOSE" },
 ]);
 
 /**
@@ -437,6 +449,11 @@ export class Room extends Message<Room> {
    */
   activeRecording = false;
 
+  /**
+   * @generated from field: livekit.TimedVersion version = 13;
+   */
+  version?: TimedVersion;
+
   constructor(data?: PartialMessage<Room>) {
     super();
     proto3.util.initPartial(data, this);
@@ -456,6 +473,7 @@ export class Room extends Message<Room> {
     { no: 9, name: "num_participants", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
     { no: 11, name: "num_publishers", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
     { no: 10, name: "active_recording", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 13, name: "version", kind: "message", T: TimedVersion },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Room {
@@ -726,6 +744,11 @@ export class ParticipantInfo extends Message<ParticipantInfo> {
    */
   isPublisher = false;
 
+  /**
+   * @generated from field: livekit.ParticipantInfo.Kind kind = 14;
+   */
+  kind = ParticipantInfo_Kind.STANDARD;
+
   constructor(data?: PartialMessage<ParticipantInfo>) {
     super();
     proto3.util.initPartial(data, this);
@@ -745,6 +768,7 @@ export class ParticipantInfo extends Message<ParticipantInfo> {
     { no: 11, name: "permission", kind: "message", T: ParticipantPermission },
     { no: 12, name: "region", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 13, name: "is_publisher", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 14, name: "kind", kind: "enum", T: proto3.getEnumType(ParticipantInfo_Kind) },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ParticipantInfo {
@@ -804,6 +828,54 @@ proto3.util.setEnumType(ParticipantInfo_State, "livekit.ParticipantInfo.State",
   { no: 3, name: "DISCONNECTED" },
 ]);
 
+/**
+ * @generated from enum livekit.ParticipantInfo.Kind
+ */
+export enum ParticipantInfo_Kind {
+  /**
+   * standard participants, e.g. web clients
+   *
+   * @generated from enum value: STANDARD = 0;
+   */
+  STANDARD = 0,
+
+  /**
+   * only ingests streams
+   *
+   * @generated from enum value: INGRESS = 1;
+   */
+  INGRESS = 1,
+
+  /**
+   * only consumes streams
+   *
+   * @generated from enum value: EGRESS = 2;
+   */
+  EGRESS = 2,
+
+  /**
+   * SIP participants
+   *
+   * @generated from enum value: SIP = 3;
+   */
+  SIP = 3,
+
+  /**
+   * LiveKit agents
+   *
+   * @generated from enum value: AGENT = 4;
+   */
+  AGENT = 4,
+}
+// Retrieve enum metadata with: proto3.getEnumType(ParticipantInfo_Kind)
+proto3.util.setEnumType(ParticipantInfo_Kind, "livekit.ParticipantInfo.Kind", [
+  { no: 0, name: "STANDARD" },
+  { no: 1, name: "INGRESS" },
+  { no: 2, name: "EGRESS" },
+  { no: 3, name: "SIP" },
+  { no: 4, name: "AGENT" },
+]);
+
 /**
  * @generated from message livekit.Encryption
  */
@@ -1020,6 +1092,11 @@ export class TrackInfo extends Message<TrackInfo> {
    */
   stream = "";
 
+  /**
+   * @generated from field: livekit.TimedVersion version = 18;
+   */
+  version?: TimedVersion;
+
   constructor(data?: PartialMessage<TrackInfo>) {
     super();
     proto3.util.initPartial(data, this);
@@ -1045,6 +1122,7 @@ export class TrackInfo extends Message<TrackInfo> {
     { no: 15, name: "disable_red", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
     { no: 16, name: "encryption", kind: "enum", T: proto3.getEnumType(Encryption_Type) },
     { no: 17, name: "stream", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 18, name: "version", kind: "message", T: TimedVersion },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TrackInfo {

package/src/proto/livekit_rtc_pb.ts

@@ -1208,6 +1208,7 @@ export class LeaveRequest extends Message<LeaveRequest> {
   /**
    * 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;
    */
@@ -1218,6 +1219,16 @@ export class LeaveRequest extends Message<LeaveRequest> {
    */
   reason = DisconnectReason.UNKNOWN_REASON;
 
+  /**
+   * @generated from field: livekit.LeaveRequest.Action action = 3;
+   */
+  action = LeaveRequest_Action.DISCONNECT;
+
+  /**
+   * @generated from field: livekit.RegionSettings regions = 4;
+   */
+  regions?: RegionSettings;
+
   constructor(data?: PartialMessage<LeaveRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -1228,6 +1239,8 @@ export class LeaveRequest extends Message<LeaveRequest> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "can_reconnect", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
     { no: 2, 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 },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): LeaveRequest {
@@ -1247,6 +1260,40 @@ export class LeaveRequest extends Message<LeaveRequest> {
   }
 }
 
+/**
+ * indicates action clients should take on receiving this message
+ *
+ * @generated from enum livekit.LeaveRequest.Action
+ */
+export enum LeaveRequest_Action {
+  /**
+   * should disconnect
+   *
+   * @generated from enum value: DISCONNECT = 0;
+   */
+  DISCONNECT = 0,
+
+  /**
+   * should attempt a resume with `reconnect=1` in join URL
+   *
+   * @generated from enum value: RESUME = 1;
+   */
+  RESUME = 1,
+
+  /**
+   * should attempt a reconnect, i. e. no `reconnect=1`
+   *
+   * @generated from enum value: RECONNECT = 2;
+   */
+  RECONNECT = 2,
+}
+// 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
  *
@@ -1947,6 +1994,11 @@ export class SyncState extends Message<SyncState> {
    */
   offer?: SessionDescription;
 
+  /**
+   * @generated from field: repeated string track_sids_disabled = 6;
+   */
+  trackSidsDisabled: string[] = [];
+
   constructor(data?: PartialMessage<SyncState>) {
     super();
     proto3.util.initPartial(data, this);
@@ -1960,6 +2012,7 @@ export class SyncState extends Message<SyncState> {
     { no: 3, name: "publish_tracks", kind: "message", T: TrackPublishedResponse, repeated: true },
     { no: 4, name: "data_channels", kind: "message", T: DataChannelInfo, repeated: true },
     { no: 5, name: "offer", kind: "message", T: SessionDescription },
+    { no: 6, name: "track_sids_disabled", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SyncState {

package/src/room/PCTransport.ts

@@ -5,7 +5,7 @@ import { debounce } from 'ts-debounce';
 import log, { LoggerNames, getLogger } from '../logger';
 import { NegotiationError, UnexpectedConnectionState } from './errors';
 import type { LoggerOptions } from './types';
-import { ddExtensionURI, isChromiumBased, isSVCCodec } from './utils';
+import { ddExtensionURI, isSVCCodec } from './utils';
 
 /** @internal */
 interface TrackBitrateInfo {
@@ -42,8 +42,6 @@ export default class PCTransport extends EventEmitter {
 
   private config?: RTCConfiguration;
 
-  private mediaConstraints: Record<string, unknown>;
-
   private log = log;
 
   private loggerOptions: LoggerOptions;
@@ -76,24 +74,16 @@ export default class PCTransport extends EventEmitter {
 
   onTrack?: (ev: RTCTrackEvent) => void;
 
-  constructor(
-    config?: RTCConfiguration,
-    mediaConstraints: Record<string, unknown> = {},
-    loggerOptions: LoggerOptions = {},
-  ) {
+  constructor(config?: RTCConfiguration, loggerOptions: LoggerOptions = {}) {
     super();
     this.log = getLogger(loggerOptions.loggerName ?? LoggerNames.PCTransport);
     this.loggerOptions = loggerOptions;
     this.config = config;
-    this.mediaConstraints = mediaConstraints;
     this._pc = this.createPC();
   }
 
   private 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) => {
       if (!ev.candidate) return;

package/src/room/PCTransportManager.ts

@@ -71,9 +71,8 @@ export class PCTransportManager {
 
     this.isPublisherConnectionRequired = !subscriberPrimary;
     this.isSubscriberConnectionRequired = subscriberPrimary;
-    const googConstraints = { optional: [{ googDscp: true }] };
-    this.publisher = new PCTransport(rtcConfig, googConstraints, loggerOptions);
-    this.subscriber = new PCTransport(rtcConfig, undefined, loggerOptions);
+    this.publisher = new PCTransport(rtcConfig, loggerOptions);
+    this.subscriber = new PCTransport(rtcConfig, loggerOptions);
 
     this.publisher.onConnectionStateChange = this.updateState;
     this.subscriber.onConnectionStateChange = this.updateState;

package/src/room/RTCEngine.ts

@@ -106,6 +106,10 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     return this._isClosed;
   }
 
+  get pendingReconnect() {
+    return !!this.reconnectTimeout;
+  }
+
   private lossyDC?: RTCDataChannel;
 
   // @ts-ignore noUnusedLocals
@@ -838,7 +842,8 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.regionUrlProvider.updateToken(this.token);
     }
     this.reconnectTimeout = CriticalTimers.setTimeout(
-      () => this.attemptReconnect(disconnectReason),
+      () =>
+        this.attemptReconnect(disconnectReason).finally(() => (this.reconnectTimeout = undefined)),
       delay,
     );
   };
@@ -1266,11 +1271,15 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     */
     const autoSubscribe = this.signalOpts?.autoSubscribe ?? true;
     const trackSids = new Array<string>();
+    const trackSidsDisabled = new Array<string>();
 
     remoteTracks.forEach((track) => {
       if (track.isDesired !== autoSubscribe) {
         trackSids.push(track.trackSid);
       }
+      if (!track.isEnabled) {
+        trackSidsDisabled.push(track.trackSid);
+      }
     });
 
     this.client.sendSyncState(
@@ -1294,6 +1303,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
         }),
         publishTracks: getTrackPublicationInfo(localTracks),
         dataChannels: this.dataChannelsInfo(),
+        trackSidsDisabled,
       }),
     );
   }