livekit-client 2.22.3 → 2.23.0

package/dist/ts4.2/logger.d.ts

@@ -1,66 +1,66 @@
-import * as log from 'loglevel';
-export declare enum LogLevel {
-    trace = 0,
-    debug = 1,
-    info = 2,
-    warn = 3,
-    error = 4,
-    silent = 5
-}
-export declare enum LoggerNames {
-    Default = "livekit",
-    Room = "livekit-room",
-    TokenSource = "livekit-token-source",
-    Participant = "livekit-participant",
-    Track = "livekit-track",
-    Publication = "livekit-track-publication",
-    Engine = "livekit-engine",
-    Signal = "livekit-signal",
-    PCManager = "livekit-pc-manager",
-    PCTransport = "livekit-pc-transport",
-    E2EE = "lk-e2ee",
-    DataTracks = "livekit-data-tracks",
-    Region = "livekit-region",
-    ICE = "livekit-ice",
-    Stats = "livekit-stats"
-}
-type LogLevelString = keyof typeof LogLevel;
-export type StructuredLogger = log.Logger & {
-    trace: (msg: string, context?: object) => void;
-    debug: (msg: string, context?: object) => void;
-    info: (msg: string, context?: object) => void;
-    warn: (msg: string, context?: object) => void;
-    error: (msg: string, context?: object) => void;
-    setDefaultLevel: (level: log.LogLevelDesc) => void;
-    setLevel: (level: log.LogLevelDesc) => void;
-    getLevel: () => number;
-};
-export type ContextProvider = () => object | undefined;
-declare const _default: StructuredLogger;
-export default _default;
-/**
- * @internal
- *
- * Get a named logger. When `ctxFn` is supplied, every log call
- * automatically:
- * 1. prepends a `[key=value ...]` prefix derived from `ctxFn()` to the
- *    message string, so identifiers are visible in browser devtools
- *    without expanding the structured context object, and
- * 2. merges `ctxFn()` into the structured context passed to any
- *    `setLogExtension` consumer, so ingestion pipelines continue to
- *    receive the full metadata unchanged.
- */
-export declare function getLogger(name: string, ctxFn?: ContextProvider): StructuredLogger;
-export declare function setLogLevel(level: LogLevel | LogLevelString, loggerName?: LoggerNames): void;
-export type LogExtension = (level: LogLevel, msg: string, context?: object) => void;
-/**
- * use this to hook into the logging function to allow sending internal livekit logs to third party services
- * if set, the browser logs will lose their stacktrace information (see https://github.com/pimterry/loglevel#writing-plugins)
- */
-export declare function setLogExtension(extension: LogExtension, logger?: StructuredLogger): void;
-export declare const workerLogger: StructuredLogger;
-/** @internal Subscribe to workerLogger level changes (so E2EE workers can be kept in sync). */
-export declare function onWorkerLogLevelChanged(cb: (level: LogLevel) => void): () => void;
-/** @internal Test-only accessor: current number of workerLogger level listeners. */
-export declare function getWorkerLogLevelListenerCount(): number;
-//# sourceMappingURL=logger.d.ts.map
+import * as log from 'loglevel';
+export declare enum LogLevel {
+    trace = 0,
+    debug = 1,
+    info = 2,
+    warn = 3,
+    error = 4,
+    silent = 5
+}
+export declare enum LoggerNames {
+    Default = "livekit",
+    Room = "livekit-room",
+    TokenSource = "livekit-token-source",
+    Participant = "livekit-participant",
+    Track = "livekit-track",
+    Publication = "livekit-track-publication",
+    Engine = "livekit-engine",
+    Signal = "livekit-signal",
+    PCManager = "livekit-pc-manager",
+    PCTransport = "livekit-pc-transport",
+    E2EE = "lk-e2ee",
+    DataTracks = "livekit-data-tracks",
+    Region = "livekit-region",
+    ICE = "livekit-ice",
+    Stats = "livekit-stats"
+}
+type LogLevelString = keyof typeof LogLevel;
+export type StructuredLogger = log.Logger & {
+    trace: (msg: string, context?: object) => void;
+    debug: (msg: string, context?: object) => void;
+    info: (msg: string, context?: object) => void;
+    warn: (msg: string, context?: object) => void;
+    error: (msg: string, context?: object) => void;
+    setDefaultLevel: (level: log.LogLevelDesc) => void;
+    setLevel: (level: log.LogLevelDesc) => void;
+    getLevel: () => number;
+};
+export type ContextProvider = () => object | undefined;
+declare const _default: StructuredLogger;
+export default _default;
+/**
+ * @internal
+ *
+ * Get a named logger. When `ctxFn` is supplied, every log call
+ * automatically:
+ * 1. prepends a `[key=value ...]` prefix derived from `ctxFn()` to the
+ *    message string, so identifiers are visible in browser devtools
+ *    without expanding the structured context object, and
+ * 2. merges `ctxFn()` into the structured context passed to any
+ *    `setLogExtension` consumer, so ingestion pipelines continue to
+ *    receive the full metadata unchanged.
+ */
+export declare function getLogger(name: string, ctxFn?: ContextProvider): StructuredLogger;
+export declare function setLogLevel(level: LogLevel | LogLevelString, loggerName?: LoggerNames): void;
+export type LogExtension = (level: LogLevel, msg: string, context?: object) => void;
+/**
+ * use this to hook into the logging function to allow sending internal livekit logs to third party services
+ * if set, the browser logs will lose their stacktrace information (see https://github.com/pimterry/loglevel#writing-plugins)
+ */
+export declare function setLogExtension(extension: LogExtension, logger?: StructuredLogger): void;
+export declare const workerLogger: StructuredLogger;
+/** @internal Subscribe to workerLogger level changes (so E2EE workers can be kept in sync). */
+export declare function onWorkerLogLevelChanged(cb: (level: LogLevel) => void): () => void;
+/** @internal Test-only accessor: current number of workerLogger level listeners. */
+export declare function getWorkerLogLevelListenerCount(): number;
+//# sourceMappingURL=logger.d.ts.map

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

@@ -1,149 +1,163 @@
-import type { E2EEOptions } from './e2ee/types';
-import type { FrameMetadataOptions } from './frameMetadata/FrameMetadataManager';
-import type { ReconnectPolicy } from './room/ReconnectPolicy';
-import type { AudioCaptureOptions, AudioOutputOptions, TrackPublishDefaults, VideoCaptureOptions } from './room/track/options';
-import type { AdaptiveStreamSettings } from './room/track/types';
-export interface WebAudioSettings {
-    audioContext: AudioContext;
-}
-/**
- * @internal
- */
-export interface InternalRoomOptions {
-    /**
-     * AdaptiveStream lets LiveKit automatically manage quality of subscribed
-     * video tracks to optimize for bandwidth and CPU.
-     * When attached video elements are visible, it'll choose an appropriate
-     * resolution based on the size of largest video element it's attached to.
-     *
-     * When none of the video elements are visible, it'll temporarily pause
-     * the data flow until they are visible again.
-     */
-    adaptiveStream: AdaptiveStreamSettings | boolean;
-    /**
-     * enable Dynacast, off by default. With Dynacast dynamically pauses
-     * video layers that are not being consumed by any subscribers, significantly
-     * reducing publishing CPU and bandwidth usage.
-     *
-     * Dynacast will be enabled if SVC codecs (VP9/AV1) are used. Multi-codec simulcast
-     * requires dynacast
-     */
-    dynacast: boolean;
-    /**
-     * default options to use when capturing user's audio
-     */
-    audioCaptureDefaults?: AudioCaptureOptions;
-    /**
-     * default options to use when capturing user's video
-     */
-    videoCaptureDefaults?: VideoCaptureOptions;
-    /**
-     * default options to use when publishing tracks
-     */
-    publishDefaults?: TrackPublishDefaults;
-    /**
-     * audio output for the room
-     */
-    audioOutput?: AudioOutputOptions;
-    /**
-     * should local tracks be stopped when they are unpublished. defaults to true
-     * set this to false if you would prefer to clean up unpublished local tracks manually.
-     */
-    stopLocalTrackOnUnpublish: boolean;
-    /**
-     * policy to use when attempting to reconnect
-     */
-    reconnectPolicy: ReconnectPolicy;
-    /**
-     * specifies whether the sdk should automatically disconnect the room
-     * on 'pagehide' and 'beforeunload' events
-     */
-    disconnectOnPageLeave: boolean;
-    /**
-     * @internal
-     * experimental flag, introduce a delay before sending signaling messages
-     */
-    expSignalLatency?: number;
-    /**
-     * mix all audio tracks in web audio, helps to tackle some audio auto playback issues
-     * allows for passing in your own AudioContext instance, too
-     */
-    webAudioMix: boolean | WebAudioSettings;
-    /**
-     * @deprecated Use `encryption` field instead.
-     */
-    e2ee?: E2EEOptions;
-    /**
-     * @experimental
-     * Options for enabling end-to-end encryption.
-     */
-    encryption?: E2EEOptions;
-    loggerName?: string;
-    /**
-     * @experimental
-     * Options for enabling frame metadata on video tracks.
-     * Frame metadata carries frame-level information such as user timestamps and frame IDs.
-     */
-    frameMetadata?: FrameMetadataOptions;
-    /**
-     * @deprecated Use {@link InternalRoomOptions.frameMetadata} instead.
-     */
-    packetTrailer?: FrameMetadataOptions;
-    /**
-     * will attempt to connect via single peer connection mode.
-     * falls back to dual peer connection mode if not available.
-     *
-     * @default true
-     */
-    singlePeerConnection: boolean;
-    /**
-     * Options controlling data stream behavior for this room.
-     */
-    dataStream?: RoomDataStreamOptions;
-}
-/**
- * Options controlling data stream behavior for a room.
- */
-export interface RoomDataStreamOptions {
-    /**
-     * Maximum size, in bytes, of the payload this client accepts from a single incoming data stream.
-     *
-     * A compressed stream can inflate to an arbitrarily large payload, so the decompressed output is
-     * bounded rather than trusting the size declared on the wire. An incoming stream that exceeds the
-     * cap fails with a `DataStreamErrorReason.PayloadTooLarge` error on the next read instead of
-     * buffering without bound.
-     *
-     * This is enforced on the receiving side only: raising it on a sender has no effect.
-     *
-     * @default 5_000_000_000 (5 GB)
-     */
-    maxPayloadByteLength?: number;
-}
-/**
- * Options for when creating a new room
- */
-export interface RoomOptions extends Partial<InternalRoomOptions> {
-}
-/**
- * @internal
- */
-export interface InternalRoomConnectOptions {
-    /** autosubscribe to room tracks after joining, defaults to true */
-    autoSubscribe: boolean;
-    /** amount of time for PeerConnection to be established, defaults to 15s */
-    peerConnectionTimeout: number;
-    /**
-     * use to override any RTCConfiguration options.
-     */
-    rtcConfig?: RTCConfiguration;
-    /** specifies how often an initial join connection is allowed to retry (only applicable if server is not reachable) */
-    maxRetries: number;
-    /** amount of time for Websocket connection to be established, defaults to 15s */
-    websocketTimeout: number;
-}
-/**
- * Options for Room.connect()
- */
-export interface RoomConnectOptions extends Partial<InternalRoomConnectOptions> {
-}
-//# sourceMappingURL=options.d.ts.map
+import type { E2EEOptions } from './e2ee/types';
+import type { FrameMetadataOptions } from './frameMetadata/FrameMetadataManager';
+import type { ReconnectPolicy } from './room/ReconnectPolicy';
+import type { AudioCaptureOptions, AudioOutputOptions, TrackPublishDefaults, VideoCaptureOptions } from './room/track/options';
+import type { AdaptiveStreamSettings } from './room/track/types';
+export interface WebAudioSettings {
+    audioContext: AudioContext;
+}
+/**
+ * @internal
+ */
+export interface InternalRoomOptions {
+    /**
+     * AdaptiveStream lets LiveKit automatically manage quality of subscribed
+     * video tracks to optimize for bandwidth and CPU.
+     * When attached video elements are visible, it'll choose an appropriate
+     * resolution based on the size of largest video element it's attached to.
+     *
+     * When none of the video elements are visible, it'll temporarily pause
+     * the data flow until they are visible again.
+     */
+    adaptiveStream: AdaptiveStreamSettings | boolean;
+    /**
+     * enable Dynacast, off by default. With Dynacast dynamically pauses
+     * video layers that are not being consumed by any subscribers, significantly
+     * reducing publishing CPU and bandwidth usage.
+     *
+     * Dynacast will be enabled if SVC codecs (VP9/AV1) are used. Multi-codec simulcast
+     * requires dynacast
+     */
+    dynacast: boolean;
+    /**
+     * default options to use when capturing user's audio
+     */
+    audioCaptureDefaults?: AudioCaptureOptions;
+    /**
+     * default options to use when capturing user's video
+     */
+    videoCaptureDefaults?: VideoCaptureOptions;
+    /**
+     * default options to use when publishing tracks
+     */
+    publishDefaults?: TrackPublishDefaults;
+    /**
+     * audio output for the room
+     */
+    audioOutput?: AudioOutputOptions;
+    /**
+     * should local tracks be stopped when they are unpublished. defaults to true
+     * set this to false if you would prefer to clean up unpublished local tracks manually.
+     */
+    stopLocalTrackOnUnpublish: boolean;
+    /**
+     * policy to use when attempting to reconnect
+     */
+    reconnectPolicy: ReconnectPolicy;
+    /**
+     * specifies whether the sdk should automatically disconnect the room
+     * on 'pagehide' and 'beforeunload' events
+     */
+    disconnectOnPageLeave: boolean;
+    /**
+     * @internal
+     * experimental flag, introduce a delay before sending signaling messages
+     */
+    expSignalLatency?: number;
+    /**
+     * mix all audio tracks in web audio, helps to tackle some audio auto playback issues
+     * allows for passing in your own AudioContext instance, too
+     */
+    webAudioMix: boolean | WebAudioSettings;
+    /**
+     * @deprecated Use `encryption` field instead.
+     */
+    e2ee?: E2EEOptions;
+    /**
+     * @experimental
+     * Options for enabling end-to-end encryption.
+     */
+    encryption?: E2EEOptions;
+    loggerName?: string;
+    /**
+     * @experimental
+     * Options for enabling frame metadata on video tracks.
+     * Frame metadata carries frame-level information such as user timestamps and frame IDs.
+     */
+    frameMetadata?: FrameMetadataOptions;
+    /**
+     * @deprecated Use {@link InternalRoomOptions.frameMetadata} instead.
+     */
+    packetTrailer?: FrameMetadataOptions;
+    /**
+     * will attempt to connect via single peer connection mode.
+     * falls back to dual peer connection mode if not available.
+     *
+     * @default true
+     */
+    singlePeerConnection: boolean;
+    /**
+     * Options controlling data stream behavior for this room.
+     */
+    dataStream?: RoomDataStreamOptions;
+}
+/**
+ * Options controlling data stream behavior for a room.
+ */
+export interface RoomDataStreamOptions {
+    /**
+     * Maximum size, in bytes, of the payload this client accepts from a single incoming data stream.
+     *
+     * A compressed stream can inflate to an arbitrarily large payload, so the decompressed output is
+     * bounded rather than trusting the size declared on the wire. An incoming stream that exceeds the
+     * cap fails with a `DataStreamErrorReason.PayloadTooLarge` error on the next read instead of
+     * buffering without bound.
+     *
+     * This is enforced on the receiving side only: raising it on a sender has no effect.
+     *
+     * @default 5_000_000_000 (5 GB)
+     */
+    maxPayloadByteLength?: number;
+}
+/**
+ * Options for when creating a new room
+ */
+export interface RoomOptions extends Partial<InternalRoomOptions> {
+}
+/**
+ * @internal
+ */
+export interface InternalRoomConnectOptions {
+    /** autosubscribe to room tracks after joining, defaults to true */
+    autoSubscribe: boolean;
+    /** amount of time for PeerConnection to be established, defaults to 15s */
+    peerConnectionTimeout: number;
+    /**
+     * use to override any RTCConfiguration options.
+     */
+    rtcConfig?: RTCConfiguration;
+    /**
+     * when the server runs ICE lite, asks it to use a full ICE agent for this participant.
+     * this is a server-side setting that the server may ignore, defaults to false
+     */
+    disableIceLite: boolean;
+    /**
+     * whether the SFU may pause subscribed video tracks when this participant's downstream
+     * connection is congested, so that other tracks can continue to stream smoothly.
+     * paused tracks resume automatically when conditions allow, and `RoomEvent.TrackStreamStateChanged`
+     * fires on each transition.
+     * when left undefined, the server's default applies (the project setting on LiveKit Cloud,
+     * or `rtc.congestion_control.allow_pause` when self-hosting)
+     */
+    subscriberAllowPause?: boolean;
+    /** specifies how often an initial join connection is allowed to retry (only applicable if server is not reachable) */
+    maxRetries: number;
+    /** amount of time for Websocket connection to be established, defaults to 15s */
+    websocketTimeout: number;
+}
+/**
+ * Options for Room.connect()
+ */
+export interface RoomConnectOptions extends Partial<InternalRoomConnectOptions> {
+}
+//# sourceMappingURL=options.d.ts.map

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

@@ -1,27 +1,27 @@
-/**
- * BackOffStrategy implements exponential backoff for connection failures.
- *
- * When severe connection failures occur (e.g., network issues, server unavailability),
- * this strategy introduces increasing delays between reconnection attempts to avoid
- * overwhelming the server and to give transient issues time to resolve.
- *
- * This strategy is only applied to LiveKit Cloud projects. It identifies
- * projects by extracting the project name from the connection URL and tracks failures
- * per project. Self-hosted deployments (URLs without a project identifier) are not
- * subject to backoff delays.
- *
- * The class is implemented as a singleton to maintain consistent backoff state across
- * the entire application lifecycle instead of room instance lifecycle.
- */
-export declare class BackOffStrategy {
-    private static _instance;
-    private failedConnectionAttempts;
-    private backOffPromises;
-    private constructor();
-    static getInstance(): BackOffStrategy;
-    addFailedConnectionAttempt(urlString: string): void;
-    getBackOffPromise(urlString: string): Promise<void>;
-    resetFailedConnectionAttempts(urlString: string): void;
-    resetAll(): void;
-}
-//# sourceMappingURL=BackOffStrategy.d.ts.map
+/**
+ * BackOffStrategy implements exponential backoff for connection failures.
+ *
+ * When severe connection failures occur (e.g., network issues, server unavailability),
+ * this strategy introduces increasing delays between reconnection attempts to avoid
+ * overwhelming the server and to give transient issues time to resolve.
+ *
+ * This strategy is only applied to LiveKit Cloud projects. It identifies
+ * projects by extracting the project name from the connection URL and tracks failures
+ * per project. Self-hosted deployments (URLs without a project identifier) are not
+ * subject to backoff delays.
+ *
+ * The class is implemented as a singleton to maintain consistent backoff state across
+ * the entire application lifecycle instead of room instance lifecycle.
+ */
+export declare class BackOffStrategy {
+    private static _instance;
+    private failedConnectionAttempts;
+    private backOffPromises;
+    private constructor();
+    static getInstance(): BackOffStrategy;
+    addFailedConnectionAttempt(urlString: string): void;
+    getBackOffPromise(urlString: string): Promise<void>;
+    resetFailedConnectionAttempts(urlString: string): void;
+    resetAll(): void;
+}
+//# sourceMappingURL=BackOffStrategy.d.ts.map

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

@@ -1,8 +1,8 @@
-import type { ReconnectContext, ReconnectPolicy } from './ReconnectPolicy';
-declare class DefaultReconnectPolicy implements ReconnectPolicy {
-    private readonly _retryDelays;
-    constructor(retryDelays?: number[]);
-    nextRetryDelayInMs(context: ReconnectContext): number | null;
-}
-export default DefaultReconnectPolicy;
-//# sourceMappingURL=DefaultReconnectPolicy.d.ts.map
+import type { ReconnectContext, ReconnectPolicy } from './ReconnectPolicy';
+declare class DefaultReconnectPolicy implements ReconnectPolicy {
+    private readonly _retryDelays;
+    constructor(retryDelays?: number[]);
+    nextRetryDelayInMs(context: ReconnectContext): number | null;
+}
+export default DefaultReconnectPolicy;
+//# sourceMappingURL=DefaultReconnectPolicy.d.ts.map

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

@@ -1,12 +1,12 @@
-export default class DeviceManager {
-    private static instance?;
-    static mediaDeviceKinds: MediaDeviceKind[];
-    static getInstance(): DeviceManager;
-    static userMediaPromiseMap: Map<MediaDeviceKind, Promise<MediaStream>>;
-    private _previousDevices;
-    get previousDevices(): MediaDeviceInfo[];
-    getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
-    normalizeDeviceId(kind: MediaDeviceKind, deviceId?: string, groupId?: string): Promise<string | undefined>;
-    private hasDeviceInUse;
-}
-//# sourceMappingURL=DeviceManager.d.ts.map
+export default class DeviceManager {
+    private static instance?;
+    static mediaDeviceKinds: MediaDeviceKind[];
+    static getInstance(): DeviceManager;
+    static userMediaPromiseMap: Map<MediaDeviceKind, Promise<MediaStream>>;
+    private _previousDevices;
+    get previousDevices(): MediaDeviceInfo[];
+    getDevices(kind?: MediaDeviceKind, requestPermissions?: boolean): Promise<MediaDeviceInfo[]>;
+    normalizeDeviceId(kind: MediaDeviceKind, deviceId?: string, groupId?: string): Promise<string | undefined>;
+    private hasDeviceInUse;
+}
+//# sourceMappingURL=DeviceManager.d.ts.map