livekit-client 2.19.1 → 2.20.0

package/dist/ts4.2/room/RTCEngine.d.ts

@@ -120,16 +120,25 @@ export default class RTCEngine extends RTCEngine_base {
     private configure;
     private setupSignalClientCallbacks;
     private makeRTCConfiguration;
+    /**
+     * Populate the publisher PC so its first offer carries the data channels + recvonly media
+     * sections. Required for every V1 connection: Firefox only binds receive decoders for media
+     * present in that first offer, and the offer-with-join path needs the sections to
+     * build a meaningful initial offer. Must be called on a configured pcManager.
+     */
+    private applyInitialPublisherLayout;
     private addMediaSections;
     private createDataChannels;
     private handleDataChannel;
     private handleDataMessage;
     private handleDataTrackMessage;
     private handleDataError;
+    private handleDataChannelClose;
     private handleBufferedAmountLow;
     createSender(track: LocalTrack, opts: TrackPublishOptions, encodings?: RTCRtpEncodingParameters[]): Promise<RTCRtpSender>;
     createSimulcastSender(track: LocalVideoTrack, simulcastTrack: SimulcastTrackInfo, opts: TrackPublishOptions, encodings?: RTCRtpEncodingParameters[]): Promise<RTCRtpSender | undefined>;
-    private setupPacketTrailerSender;
+    private get frameMetadataWorker();
+    private setupFrameMetadataSender;
     private createTransceiverRTCRtpSender;
     private createSimulcastTransceiverSender;
     private createRTCRtpSender;
@@ -162,6 +171,7 @@ export default class RTCEngine extends RTCEngine_base {
     sendSyncState(remoteTracks: RemoteTrackPublication[], localTracks: LocalTrackPublication[], localDataTrackInfos: Array<DataTrackInfo>): void;
     failNext(): void;
     failNextV1Path(): void;
+    private onRtpMapAvailable;
     private dataChannelsInfo;
     private clearReconnectTimeout;
     private clearPendingReconnect;

package/dist/ts4.2/room/Room.d.ts

@@ -68,7 +68,7 @@ declare class Room extends Room_base {
     private connectFuture?;
     private disconnectLock;
     private e2eeManager;
-    private packetTrailerManager;
+    private frameMetadataManager;
     private e2eeStateMutex;
     private connectionReconcileInterval?;
     private regionUrlProvider?;
@@ -135,7 +135,7 @@ declare class Room extends Room_base {
      */
     setE2EEEnabled(enabled: boolean): Promise<void>;
     private setupE2EE;
-    private setupPacketTrailer;
+    private setupFrameMetadata;
     private get logContext();
     /**
      * if the current room has a participant with `recorder: true` in its JWT grant

package/dist/ts4.2/room/participant/LocalParticipant.d.ts

@@ -146,8 +146,8 @@ export default class LocalParticipant extends Participant {
     private waitUntilEngineConnected;
     private hasPermissionsToPublish;
     private publish;
-    private canPublishPacketTrailer;
-    private normalizeRequestedPacketTrailerOptions;
+    private canPublishFrameMetadata;
+    private normalizeRequestedFrameMetadataOptions;
     get isLocal(): boolean;
     /** @internal
      * publish additional codec to existing track

package/dist/ts4.2/room/token-source/types.d.ts

@@ -48,6 +48,7 @@ export type TokenSourceFetchOptions = {
     };
     agentName?: string;
     agentMetadata?: string;
+    deployment?: string;
 };
 /** A Configurable TokenSource is a token source that takes a
  * {@link TokenSourceFetchOptions} object as input and returns a deterministic

package/dist/ts4.2/room/track/FrameMetadataExtractor.d.ts

@@ -0,0 +1,19 @@
+import type { FrameMetadata } from '../../frameMetadata/types';
+/**
+ * Caches frame metadata extracted from received video frames,
+ * keyed by RTP timestamp so it can be looked up when the frame is displayed.
+ *
+ * Metadata is populated either by the frame metadata worker managed by
+ * `FrameMetadataManager` (non-E2EE) or by the E2EE FrameCryptor worker
+ * after decryption (E2EE).
+ *
+ * @experimental
+ */
+export declare class FrameMetadataExtractor {
+    private metadataMap;
+    private activeSsrc;
+    storeMetadata(rtpTimestamp: number, ssrc: number, metadata: FrameMetadata): void;
+    lookupMetadata(rtpTimestamp: number): FrameMetadata | undefined;
+    dispose(): void;
+}
+//# sourceMappingURL=FrameMetadataExtractor.d.ts.map

package/dist/ts4.2/room/track/RemoteVideoTrack.d.ts

@@ -1,7 +1,7 @@
-import type { PacketTrailerMetadata } from '../../packetTrailer/types';
+import type { FrameMetadata } from '../../frameMetadata/types';
 import type { VideoReceiverStats } from '../stats';
 import type { LoggerOptions } from '../types';
-import type { PacketTrailerExtractor } from './PacketTrailerExtractor';
+import type { FrameMetadataExtractor } from './FrameMetadataExtractor';
 import RemoteTrack from './RemoteTrack';
 import { Track } from './Track';
 import type { AdaptiveStreamSettings } from './types';
@@ -12,7 +12,7 @@ export default class RemoteVideoTrack extends RemoteTrack<Track.Kind.Video> {
     private lastVisible?;
     private lastDimensions?;
     /** @internal */
-    packetTrailerExtractor?: PacketTrailerExtractor;
+    frameMetadataExtractor?: FrameMetadataExtractor;
     constructor(mediaTrack: MediaStreamTrack, sid: string, receiver: RTCRtpReceiver, adaptiveStreamSettings?: AdaptiveStreamSettings, loggerOptions?: LoggerOptions);
     get isAdaptiveStream(): boolean;
     /**
@@ -20,13 +20,13 @@ export default class RemoteVideoTrack extends RemoteTrack<Track.Kind.Video> {
      * Use with the `TrackEvent.TimeSyncUpdate` event to correlate displayed frames
      * with their capture-time metadata.
      *
-     * Requires the room to be configured with the `packetTrailer` worker option
-     * and the publishing track to have packet trailer features enabled.
+     * Requires the room to be configured with the `frameMetadata` worker option
+     * and the publishing track to have frame metadata features enabled.
      *
      */
-    lookupFrameMetadata({ rtpTimestamp, }: {
+    lookupFrameMetadata({ rtpTimestamp }: {
         rtpTimestamp: number;
-    }): PacketTrailerMetadata | undefined;
+    }): FrameMetadata | undefined;
     setStreamState(value: Track.StreamState): void;
     /**
      * Note: When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start

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

@@ -1,4 +1,4 @@
-import type { PacketTrailerPublishOptions } from '../../packetTrailer/types';
+import type { FrameMetadataPublishOptions } from '../../frameMetadata/types';
 import type { Track } from './Track';
 import type { AudioProcessorOptions, TrackProcessor, VideoProcessorOptions } from './processor/types';
 export interface TrackPublishDefaults {
@@ -113,14 +113,18 @@ export interface TrackPublishDefaults {
      */
     preConnectBuffer?: boolean;
     /**
-     * Packet trailer metadata to append to published video frames.
+     * Frame metadata to append to published video frames.
      *
-     * Requires either room-level packet trailer worker configuration or E2EE,
-     * because encoded frame transforms are used to write the trailer.
+     * Requires either room-level frame metadata worker configuration or E2EE,
+     * because encoded frame transforms are used to write the metadata.
      *
      * @experimental
      */
-    packetTrailer?: PacketTrailerPublishOptions;
+    frameMetadata?: FrameMetadataPublishOptions;
+    /**
+     * @deprecated Use {@link TrackPublishDefaults.frameMetadata} instead.
+     */
+    packetTrailer?: FrameMetadataPublishOptions;
 }
 /**
  * Options when publishing tracks
@@ -248,6 +252,14 @@ export interface AudioCaptureOptions {
      * @see https://w3c.github.io/mediacapture-extensions/#voiceisolation-constraint
      */
     voiceIsolation?: ConstrainBoolean;
+    /**
+     * @experimental
+     * when capturing system/screen-share audio, excludes the local participant's own audio
+     * from the captured stream to prevent echo. Browser support is not widespread yet
+     * (as of mid 2026, Chromium-based browsers only).
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints/restrictOwnAudio
+     */
+    restrictOwnAudio?: ConstrainBoolean;
     /**
      * the sample rate or range of sample rates which are acceptable and/or required.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "2.19.1",
+  "version": "2.20.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -17,9 +17,14 @@
       "require": "./dist/livekit-client.e2ee.worker.js"
     },
     "./packet-trailer-worker": {
-      "types": "./dist/src/packetTrailer/worker/packetTrailer.worker.d.ts",
-      "import": "./dist/livekit-client.pt.worker.mjs",
-      "require": "./dist/livekit-client.pt.worker.js"
+      "types": "./dist/src/frameMetadata/worker/frameMetadata.worker.d.ts",
+      "import": "./dist/livekit-client.fm.worker.mjs",
+      "require": "./dist/livekit-client.fm.worker.js"
+    },
+    "./frame-metadata-worker": {
+      "types": "./dist/src/frameMetadata/worker/frameMetadata.worker.d.ts",
+      "import": "./dist/livekit-client.fm.worker.mjs",
+      "require": "./dist/livekit-client.fm.worker.js"
     }
   },
   "files": [
@@ -35,8 +40,8 @@
       "./dist/src/e2ee/worker/e2ee.worker.d.ts": [
         "./dist/ts4.2/e2ee/worker/e2ee.worker.d.ts"
       ],
-      "./dist/src/packetTrailer/worker/packetTrailer.worker.d.ts": [
-        "./dist/ts4.2/packetTrailer/worker/packetTrailer.worker.d.ts"
+      "./dist/src/frameMetadata/worker/frameMetadata.worker.d.ts": [
+        "./dist/ts4.2/frameMetadata/worker/frameMetadata.worker.d.ts"
       ]
     }
   },
@@ -45,7 +50,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@livekit/mutex": "1.1.1",
-    "@livekit/protocol": "1.45.8",
+    "@livekit/protocol": "1.46.6",
     "events": "^3.3.0",
     "jose": "^6.1.0",
     "loglevel": "^1.9.2",
@@ -58,8 +63,8 @@
     "@types/dom-mediacapture-record": "^1"
   },
   "devDependencies": {
-    "@babel/core": "7.29.0",
-    "@babel/preset-env": "7.29.2",
+    "@babel/core": "7.29.7",
+    "@babel/preset-env": "7.29.7",
     "@bufbuild/protoc-gen-es": "^1.10.0",
     "@changesets/cli": "2.31.0",
     "@eslint/js": "10.0.1",
@@ -69,18 +74,18 @@
     "@rollup/plugin-commonjs": "29.0.2",
     "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "16.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@size-limit/file": "^11.2.0",
-    "@size-limit/webpack": "^11.2.0",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@size-limit/file": "^12.1.0",
+    "@size-limit/webpack": "^12.1.0",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "@trivago/prettier-plugin-sort-imports": "^5.0.0",
+    "@trivago/prettier-plugin-sort-imports": "^6.0.2",
     "@types/events": "^3.0.3",
     "@types/sdp-transform": "2.15.0",
     "@types/ua-parser-js": "0.7.39",
-    "@typescript-eslint/eslint-plugin": "8.59.2",
-    "@typescript-eslint/parser": "8.59.2",
+    "@typescript-eslint/eslint-plugin": "8.59.4",
+    "@typescript-eslint/parser": "8.59.4",
     "downlevel-dts": "^0.11.0",
-    "eslint": "10.2.1",
+    "eslint": "10.4.0",
     "eslint-config-airbnb-extended": "^2.3.2",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-compat": "^6.0.2",
@@ -92,7 +97,7 @@
     "jsdom": "^26.1.0",
     "prettier": "^3.4.2",
     "publint": "^0.3.21",
-    "rollup": "4.60.2",
+    "rollup": "4.60.4",
     "rollup-plugin-delete": "^2.1.0",
     "rollup-plugin-typescript2": "0.37.0",
     "size-limit": "^11.2.0",
@@ -101,11 +106,11 @@
     "typedoc-plugin-no-inherit": "1.6.1",
     "typescript": "5.9.3",
     "typescript-eslint": "^8.47.0",
-    "vite": "7.3.2",
-    "vitest": "^3.0.0"
+    "vite": "7.3.5",
+    "vitest": "^4.0.0"
   },
   "scripts": {
-    "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs && rollup --config rollup.config.pt-worker.js --bundleConfigAsCjs && pnpm downlevel-dts",
+    "build": "rollup --config --bundleConfigAsCjs && rollup --config rollup.config.worker.js --bundleConfigAsCjs && rollup --config rollup.config.fm-worker.js --bundleConfigAsCjs && pnpm downlevel-dts",
     "build:clean": "rm -rf ./dist && pnpm build",
     "build:watch": "rollup --watch --config --bundleConfigAsCjs",
     "build:worker:watch": "rollup --watch --config rollup.config.worker.js --bundleConfigAsCjs",

package/src/api/SignalClient.test.ts

@@ -77,7 +77,7 @@ function mockWebSocketStream(options: MockWebSocketStreamOptions = {}) {
     onUrl,
   } = options;
 
-  return vi.mocked(WebSocketStream).mockImplementationOnce((url) => {
+  return vi.mocked(WebSocketStream).mockImplementationOnce(function (url) {
     onUrl?.(url);
     return {
       url: 'wss://test.livekit.io',
@@ -283,7 +283,7 @@ describe('SignalClient.connect', () => {
     it('should reject when AbortSignal is triggered', async () => {
       const abortController = new AbortController();
 
-      vi.mocked(WebSocketStream).mockImplementation(() => {
+      vi.mocked(WebSocketStream).mockImplementation(function () {
         // Simulate abort
         setTimeout(() => abortController.abort(new Error('User aborted connection')), 50);
 
@@ -344,7 +344,7 @@ describe('SignalClient.connect', () => {
         extensions: '',
       };
 
-      vi.mocked(WebSocketStream).mockImplementation(() => {
+      vi.mocked(WebSocketStream).mockImplementation(function () {
         return {
           url: 'wss://test.livekit.io',
           opened: Promise.resolve(mockConnection),
@@ -526,7 +526,7 @@ describe('SignalClient.connect', () => {
         closedResolve = resolve;
       });
 
-      vi.mocked(WebSocketStream).mockImplementation(() => {
+      vi.mocked(WebSocketStream).mockImplementation(function () {
         // Simulate close during connection
         queueMicrotask(() => {
           closedResolve({ closeCode: 1006, reason: 'Connection lost' });

package/src/api/SignalClient.ts

@@ -376,13 +376,17 @@ export class SignalClient {
         if (redactedUrl.searchParams.has('access_token')) {
           redactedUrl.searchParams.set('access_token', '<redacted>');
         }
+
+        if (this.ws) {
+          const startClose = performance.now();
+          await this.close(false);
+          this.log.debug(`closed previous ws connection in ${performance.now() - startClose}ms`);
+        }
+
         this.log.info(`signal connecting to ${redactedUrl}`, {
           reconnect: opts.reconnect,
           reconnectReason: opts.reconnectReason,
         });
-        if (this.ws) {
-          await this.close(false);
-        }
         this.ws = new WebSocketStream<ArrayBuffer>(rtcUrl);
 
         try {

package/src/api/WebSocketStream.test.ts

@@ -129,24 +129,24 @@ describe('WebSocketStream', () => {
     vi.clearAllMocks();
 
     // Store original WebSocket
-    originalWebSocket = global.WebSocket;
+    originalWebSocket = globalThis.WebSocket;
 
     // Mock WebSocket globally
-    global.WebSocket = vi.fn((url: string, protocols?: string | string[]) => {
+    globalThis.WebSocket = vi.fn(function (url: string, protocols?: string | string[]) {
       mockWebSocket = new MockWebSocket(url, protocols);
       return mockWebSocket as any;
     }) as any;
 
     // Add constants to the mocked WebSocket
-    (global.WebSocket as any).CONNECTING = MockWebSocket.CONNECTING;
-    (global.WebSocket as any).OPEN = MockWebSocket.OPEN;
-    (global.WebSocket as any).CLOSING = MockWebSocket.CLOSING;
-    (global.WebSocket as any).CLOSED = MockWebSocket.CLOSED;
+    (globalThis.WebSocket as any).CONNECTING = MockWebSocket.CONNECTING;
+    (globalThis.WebSocket as any).OPEN = MockWebSocket.OPEN;
+    (globalThis.WebSocket as any).CLOSING = MockWebSocket.CLOSING;
+    (globalThis.WebSocket as any).CLOSED = MockWebSocket.CLOSED;
   });
 
   afterEach(() => {
     // Restore original WebSocket
-    global.WebSocket = originalWebSocket;
+    globalThis.WebSocket = originalWebSocket;
   });
 
   describe('Constructor and Initialization', () => {

package/src/e2ee/E2eeManager.ts

@@ -1,8 +1,8 @@
 import { Encryption_Type, TrackInfo } from '@livekit/protocol';
 import { EventEmitter } from 'events';
 import type TypedEventEmitter from 'typed-emitter';
+import { hasFrameMetadataPublishOptions } from '../frameMetadata/utils';
 import log, { LogLevel, workerLogger } from '../logger';
-import { hasPacketTrailerPublishOptions } from '../packetTrailer/utils';
 import type RTCEngine from '../room/RTCEngine';
 import type Room from '../room/Room';
 import { ConnectionState } from '../room/Room';
@@ -230,7 +230,7 @@ export class E2EEManager
         }
         break;
       case 'packetTrailerMetadata':
-        this.handlePacketTrailerMetadata(data.trackId, data.rtpTimestamp, data.ssrc, data.metadata);
+        this.handleFrameMetadata(data.trackId, data.rtpTimestamp, data.ssrc, data.metadata);
         break;
       default:
         break;
@@ -242,7 +242,7 @@ export class E2EEManager
     this.emit(EncryptionEvent.EncryptionError, ev.error, undefined);
   };
 
-  private handlePacketTrailerMetadata(
+  private handleFrameMetadata(
     trackId: string,
     rtpTimestamp: number,
     ssrc: number,
@@ -260,9 +260,9 @@ export class E2EEManager
           pub.track &&
           pub.track.mediaStreamID === trackId &&
           pub.track instanceof RemoteVideoTrack &&
-          pub.track.packetTrailerExtractor
+          pub.track.frameMetadataExtractor
         ) {
-          pub.track.packetTrailerExtractor.storeMetadata(rtpTimestamp, ssrc, metadata);
+          pub.track.frameMetadataExtractor.storeMetadata(rtpTimestamp, ssrc, metadata);
           return;
         }
       }
@@ -509,7 +509,9 @@ export class E2EEManager
       sender,
       track.mediaStreamID,
       undefined,
-      isVideoTrack(track) ? track.publishOptions?.packetTrailer : undefined,
+      isVideoTrack(track)
+        ? (track.publishOptions?.frameMetadata ?? track.publishOptions?.packetTrailer)
+        : undefined,
     );
   }
 
@@ -598,7 +600,7 @@ export class E2EEManager
     sender: RTCRtpSender,
     trackId: string,
     codec?: VideoCodec,
-    packetTrailer?: TrackPublishOptions['packetTrailer'],
+    frameMetadata?: TrackPublishOptions['frameMetadata'],
   ) {
     if (E2EE_FLAG in sender || !this.worker) {
       return;
@@ -615,8 +617,8 @@ export class E2EEManager
         participantIdentity: this.room.localParticipant.identity,
         trackId,
         codec,
-        hasPacketTrailer: hasPacketTrailerPublishOptions(packetTrailer),
-        packetTrailer,
+        hasPacketTrailer: hasFrameMetadataPublishOptions(frameMetadata),
+        packetTrailer: frameMetadata,
       };
       // @ts-ignore
       sender.transform = new RTCRtpScriptTransform(this.worker, options);
@@ -633,8 +635,8 @@ export class E2EEManager
           trackId,
           participantIdentity: this.room.localParticipant.identity,
           isReuse: false,
-          hasPacketTrailer: hasPacketTrailerPublishOptions(packetTrailer),
-          packetTrailer,
+          hasPacketTrailer: hasFrameMetadataPublishOptions(frameMetadata),
+          packetTrailer: frameMetadata,
         },
       };
       this.worker.postMessage(msg, [senderStreams.readable, senderStreams.writable]);

package/src/e2ee/types.ts

@@ -1,6 +1,6 @@
+import type { FrameMetadataPayload } from '../frameMetadata/frameMetadata';
+import type { FrameMetadataPublishOptions } from '../frameMetadata/types';
 import type { LogLevel } from '../logger';
-import type { PacketTrailerFramePayload } from '../packetTrailer/packetTrailer';
-import type { PacketTrailerPublishOptions } from '../packetTrailer/types';
 import type { VideoCodec } from '../room/track/options';
 import type { BaseE2EEManager } from './E2eeManager';
 import type { BaseKeyProvider } from './KeyProvider';
@@ -62,7 +62,7 @@ export interface EncodeMessage extends BaseMessage {
     /**
      * Packet trailer metadata to append on published video frames.
      */
-    packetTrailer?: PacketTrailerPublishOptions;
+    packetTrailer?: FrameMetadataPublishOptions;
   };
 }
 
@@ -165,7 +165,7 @@ export interface EncryptDataResponseMessage extends BaseMessage {
 
 export interface PTMetadataFromE2EEMessage extends BaseMessage {
   kind: 'packetTrailerMetadata';
-  data: PacketTrailerFramePayload;
+  data: FrameMetadataPayload;
 }
 
 export type E2EEWorkerMessage =
@@ -249,5 +249,5 @@ export type ScriptTransformOptions = {
   /**
    * Packet trailer metadata to append on published video frames.
    */
-  packetTrailer?: PacketTrailerPublishOptions;
+  packetTrailer?: FrameMetadataPublishOptions;
 };

package/src/e2ee/worker/FrameCryptor.test.ts

@@ -1,6 +1,6 @@
 import { afterEach, describe, expect, it, vitest } from 'vitest';
-import { appendPacketTrailer, extractPacketTrailer } from '../../packetTrailer/packetTrailer';
-import type { PacketTrailerPublishOptions } from '../../packetTrailer/types';
+import { appendPacketTrailer, extractPacketTrailer } from '../../frameMetadata/frameMetadata';
+import type { FrameMetadataPublishOptions } from '../../frameMetadata/types';
 import { IV_LENGTH, KEY_PROVIDER_DEFAULTS } from '../constants';
 import { CryptorEvent } from '../events';
 import type { KeyProviderOptions } from '../types';
@@ -69,7 +69,7 @@ function prepareParticipantTestDecoder(
 function prepareParticipantTestEncoder(
   participantIdentity: string,
   partialKeyProviderOptions: Partial<KeyProviderOptions>,
-  packetTrailer?: PacketTrailerPublishOptions,
+  packetTrailer?: FrameMetadataPublishOptions,
 ) {
   return prepareParticipantTest(
     'encode',
@@ -83,7 +83,7 @@ function prepareParticipantTest(
   mode: 'encode' | 'decode',
   participantIdentity: string,
   partialKeyProviderOptions: Partial<KeyProviderOptions>,
-  packetTrailer?: PacketTrailerPublishOptions,
+  packetTrailer?: FrameMetadataPublishOptions,
 ): {
   keys: ParticipantKeyHandler;
   cryptor: FrameCryptor;
@@ -536,7 +536,7 @@ describe('FrameCryptor', () => {
         const postMessage = vitest.fn();
         vitest.stubGlobal('postMessage', postMessage);
         encryptionEnabledMap.set(participantIdentity, false);
-        cryptor.setHasPacketTrailer(true);
+        cryptor.setHasFrameMetadata(true);
 
         const payload = Uint8Array.from([1, 2, 3, 4]);
         const trailer = appendPacketTrailer(payload, 1_744_249_600_123_456n, 0);