livekit-client 1.15.10 → 2.0.0

package/dist/ts4.2/src/room/participant/RemoteParticipant.d.ts

@@ -8,9 +8,9 @@ import type { LoggerOptions } from '../types';
 import Participant from './Participant';
 import type { ParticipantEventCallbacks } from './Participant';
 export default class RemoteParticipant extends Participant {
-    audioTracks: Map<string, RemoteTrackPublication>;
-    videoTracks: Map<string, RemoteTrackPublication>;
-    tracks: Map<string, RemoteTrackPublication>;
+    audioTrackPublications: Map<string, RemoteTrackPublication>;
+    videoTrackPublications: Map<string, RemoteTrackPublication>;
+    trackPublications: Map<string, RemoteTrackPublication>;
     signalClient: SignalClient;
     private volumeMap;
     private audioOutput?;
@@ -19,8 +19,8 @@ export default class RemoteParticipant extends Participant {
     /** @internal */
     constructor(signalClient: SignalClient, sid: string, identity?: string, name?: string, metadata?: string, loggerOptions?: LoggerOptions);
     protected addTrackPublication(publication: RemoteTrackPublication): void;
-    getTrack(source: Track.Source): RemoteTrackPublication | undefined;
-    getTrackByName(name: string): RemoteTrackPublication | undefined;
+    getTrackPublication(source: Track.Source): RemoteTrackPublication | undefined;
+    getTrackPublicationByName(name: string): RemoteTrackPublication | undefined;
     /**
      * sets the volume on the participant's audio track
      * by default, this affects the microphone publication
@@ -36,7 +36,10 @@ export default class RemoteParticipant extends Participant {
     addSubscribedMediaTrack(mediaTrack: MediaStreamTrack, sid: Track.SID, mediaStream: MediaStream, receiver?: RTCRtpReceiver, adaptiveStreamSettings?: AdaptiveStreamSettings, triesLeft?: number): RemoteTrackPublication | undefined;
     /** @internal */
     get hasMetadata(): boolean;
-    getTrackPublication(sid: Track.SID): RemoteTrackPublication | undefined;
+    /**
+     * @internal
+     */
+    getTrackPublicationBySid(sid: Track.SID): RemoteTrackPublication | undefined;
     /** @internal */
     updateInfo(info: ParticipantInfo): boolean;
     /** @internal */

package/dist/ts4.2/src/room/timers.d.ts

@@ -1,13 +1,12 @@
-/// <reference types="node" />
 /**
  * Timers that can be overridden with platform specific implementations
  * that ensure that they are fired. These should be used when it is critical
  * that the timer fires on time.
  */
 export default class CriticalTimers {
-    static setTimeout: (callback: (args: void) => void, ms?: number | undefined) => NodeJS.Timeout;
-    static setInterval: (callback: (args: void) => void, ms?: number | undefined) => NodeJS.Timeout;
-    static clearTimeout: (timeoutId: string | number | NodeJS.Timeout | undefined) => void;
-    static clearInterval: (intervalId: string | number | NodeJS.Timeout | undefined) => void;
+    static setTimeout: (handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]) => number;
+    static setInterval: (handler: TimerHandler, timeout?: number | undefined, ...arguments: any[]) => number;
+    static clearTimeout: (id: number | undefined) => void;
+    static clearInterval: (id: number | undefined) => void;
 }
 //# sourceMappingURL=timers.d.ts.map

package/dist/ts4.2/src/room/track/LocalVideoTrack.d.ts

@@ -1,10 +1,10 @@
 import type { SignalClient } from '../../api/SignalClient';
-import { VideoLayer, VideoQuality } from '../../proto/livekit_models_pb';
+import { VideoLayer } from '../../proto/livekit_models_pb';
 import { SubscribedCodec, SubscribedQuality } from '../../proto/livekit_rtc_pb';
 import type { VideoSenderStats } from '../stats';
 import type { LoggerOptions } from '../types';
 import LocalTrack from './LocalTrack';
-import { Track } from './Track';
+import { Track, VideoQuality } from './Track';
 import type { VideoCaptureOptions, VideoCodec } from './options';
 import type { TrackProcessor } from './processor/types';
 export declare class SimulcastTrackInfo {
@@ -41,7 +41,7 @@ export default class LocalVideoTrack extends LocalTrack {
     setDeviceId(deviceId: ConstrainDOMString): Promise<boolean>;
     restartTrack(options?: VideoCaptureOptions): Promise<void>;
     setProcessor(processor: TrackProcessor<Track.Kind>, showProcessedStreamLocally?: boolean): Promise<void>;
-    addSimulcastTrack(codec: VideoCodec, encodings?: RTCRtpEncodingParameters[]): SimulcastTrackInfo;
+    addSimulcastTrack(codec: VideoCodec, encodings?: RTCRtpEncodingParameters[]): SimulcastTrackInfo | undefined;
     setSimulcastTrackSender(codec: VideoCodec, sender: RTCRtpSender): void;
     /**
      * @internal

package/dist/ts4.2/src/room/track/RemoteTrackPublication.d.ts

@@ -1,7 +1,7 @@
-import { SubscriptionError, TrackInfo, VideoQuality } from '../../proto/livekit_models_pb';
+import { SubscriptionError, TrackInfo } from '../../proto/livekit_models_pb';
 import type { LoggerOptions } from '../types';
 import type RemoteTrack from './RemoteTrack';
-import { Track } from './Track';
+import { Track, VideoQuality } from './Track';
 import { TrackPublication } from './TrackPublication';
 export default class RemoteTrackPublication extends TrackPublication {
     track?: RemoteTrack;

package/dist/ts4.2/src/room/track/Track.d.ts

@@ -4,6 +4,11 @@ import { StructuredLogger } from '../../logger';
 import { TrackSource, TrackType } from '../../proto/livekit_models_pb';
 import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc_pb';
 import type { LoggerOptions } from '../types';
+export declare enum VideoQuality {
+    LOW = 0,
+    MEDIUM = 1,
+    HIGH = 2
+}
 declare const Track_base: new () => TypedEventEmitter<TrackEventCallbacks>;
 export declare abstract class Track extends Track_base {
     kind: Track.Kind;

package/dist/ts4.2/src/room/track/options.d.ts

@@ -28,11 +28,6 @@ export interface TrackPublishDefaults {
      * as backup. (TBD)
      */
     videoCodec?: VideoCodec;
-    /**
-     * max audio bitrate, defaults to [[AudioPresets.music]]
-     * @deprecated use `audioPreset` instead
-     */
-    audioBitrate?: number;
     /**
      * which audio preset should be used for publishing (audio) tracks
      * defaults to [[AudioPresets.music]]

package/dist/ts4.2/src/room/types.d.ts

@@ -1,4 +1,3 @@
-import type RemoteParticipant from './participant/RemoteParticipant';
 export type SimulationOptions = {
     publish?: {
         audio?: boolean;
@@ -13,8 +12,17 @@ export type SimulationOptions = {
     };
 };
 export type DataPublishOptions = {
-    /** the participants who will receive the message, will be sent to every one if empty */
-    destination?: RemoteParticipant[] | string[];
+    /**
+     * whether to send this as reliable or lossy.
+     * For data that you need delivery guarantee (such as chat messages), use Reliable.
+     * For data that should arrive as quickly as possible, but you are ok with dropped
+     * packets, use Lossy.
+     */
+    reliable?: boolean;
+    /**
+     * the identities of participants who will receive the message, will be sent to every one if empty
+     */
+    destinationIdentities?: string[];
     /** the topic under which the message gets published */
     topic?: string;
 };

package/dist/ts4.2/src/version.d.ts

@@ -1,3 +1,3 @@
 export declare const version: string;
-export declare const protocolVersion = 11;
+export declare const protocolVersion = 12;
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.15.10",
+  "version": "2.0.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -46,8 +46,8 @@
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "7.23.7",
-    "@babel/preset-env": "7.23.7",
+    "@babel/core": "7.23.9",
+    "@babel/preset-env": "7.23.9",
     "@bufbuild/protoc-gen-es": "^1.3.0",
     "@changesets/cli": "2.27.1",
     "@livekit/changesets-changelog-github": "^0.0.4",
@@ -73,20 +73,21 @@
     "gh-pages": "6.1.1",
     "jsdom": "^23.0.0",
     "prettier": "^3.0.0",
-    "rollup": "4.9.2",
+    "rollup": "4.9.6",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-re": "1.0.7",
     "rollup-plugin-typescript2": "0.36.0",
     "size-limit": "^8.2.4",
-    "typedoc": "0.25.6",
+    "typedoc": "0.25.7",
     "typedoc-plugin-no-inherit": "1.4.0",
     "typescript": "5.3.3",
-    "vite": "5.0.10",
+    "vite": "5.0.12",
     "vitest": "^1.0.0"
   },
   "scripts": {
     "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs && pnpm downlevel-dts",
-    "build:watch": "rollup --watch --config rollup.config.js",
+    "build:watch": "rollup --watch --config --bundleConfigAsCjs",
+    "build:worker:watch": "rollup --watch --config rollup.config.worker.js --bundleConfigAsCjs",
     "build-docs": "typedoc",
     "proto": "protoc --es_out src/proto --es_opt target=ts -I./protocol ./protocol/livekit_rtc.proto ./protocol/livekit_models.proto",
     "sample": "vite example -c vite.config.mjs",

package/src/api/SignalClient.ts

@@ -56,8 +56,6 @@ interface ConnectOpts extends SignalOptions {
 // public options
 export interface SignalOptions {
   autoSubscribe: boolean;
-  /** @deprecated */
-  publishOnly?: string;
   adaptiveStream?: boolean;
   maxRetries: number;
   e2eeEnabled: boolean;
@@ -274,7 +272,7 @@ export class SignalClient {
         abortSignal?.addEventListener('abort', abortHandler);
         this.log.debug(`connecting to ${url + params}`, this.logContext);
         if (this.ws) {
-          await this.close();
+          await this.close(false);
         }
         this.ws = new WebSocket(url + params);
         this.ws.binaryType = 'arraybuffer';
@@ -396,6 +394,8 @@ export class SignalClient {
           this.log.warn(`websocket closed`, {
             ...this.logContext,
             reason: ev.reason,
+            code: ev.code,
+            wasClean: ev.wasClean,
             state: this.state,
           });
           this.handleOnClose(ev.reason);
@@ -421,10 +421,12 @@ export class SignalClient {
     this.onClose = undefined;
   };
 
-  async close() {
+  async close(updateState: boolean = true) {
     const unlock = await this.closingLock.lock();
     try {
-      this.state = SignalConnectionState.DISCONNECTING;
+      if (updateState) {
+        this.state = SignalConnectionState.DISCONNECTING;
+      }
       if (this.ws) {
         this.ws.onmessage = null;
         this.ws.onopen = null;
@@ -449,7 +451,9 @@ export class SignalClient {
         this.ws = undefined;
       }
     } finally {
-      this.state = SignalConnectionState.DISCONNECTED;
+      if (updateState) {
+        this.state = SignalConnectionState.DISCONNECTED;
+      }
       this.clearPingInterval();
       unlock();
     }
@@ -849,10 +853,6 @@ function createConnectionParams(token: string, info: ClientInfo, opts: ConnectOp
     params.set('browser_version', info.browserVersion);
   }
 
-  if (opts.publishOnly !== undefined) {
-    params.set('publish', opts.publishOnly);
-  }
-
   if (opts.adaptiveStream) {
     params.set('adaptive_stream', '1');
   }

package/src/e2ee/E2eeManager.ts

@@ -168,8 +168,8 @@ export class E2EEManager extends (EventEmitter as new () => TypedEventEmitter<E2
     room
       .on(RoomEvent.ConnectionStateChanged, (state) => {
         if (state === ConnectionState.Connected) {
-          room.participants.forEach((participant) => {
-            participant.tracks.forEach((pub) => {
+          room.remoteParticipants.forEach((participant) => {
+            participant.trackPublications.forEach((pub) => {
               this.setParticipantCryptorEnabled(
                 pub.trackInfo!.encryption !== Encryption_Type.NONE,
                 participant.identity,

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

@@ -437,6 +437,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 +461,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 +732,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 +756,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 +816,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 +1080,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 +1110,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/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,
     );
   };