livekit-client 1.7.1 → 1.9.0

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

@@ -17,10 +17,12 @@ export default class RTCEngine extends RTCEngine_base {
     client: SignalClient;
     rtcConfig: RTCConfiguration;
     peerConnectionTimeout: number;
+    fullReconnectOnNext: boolean;
     get isClosed(): boolean;
     private lossyDC?;
     private lossyDCSub?;
     private reliableDC?;
+    private dcBufferStatus;
     private reliableDCSub?;
     private subscriberPrimary;
     private primaryPC?;
@@ -33,7 +35,6 @@ export default class RTCEngine extends RTCEngine_base {
     private signalOpts?;
     private reconnectAttempts;
     private reconnectStart;
-    private fullReconnectOnNext;
     private clientConfiguration?;
     private attemptingReconnect;
     private reconnectPolicy;
@@ -46,6 +47,7 @@ export default class RTCEngine extends RTCEngine_base {
     private closingLock;
     private dataProcessLock;
     private shouldFailNext;
+    private regionUrlProvider?;
     constructor(options: InternalRoomOptions);
     join(url: string, token: string, opts: SignalOptions, abortSignal?: AbortSignal): Promise<JoinResponse>;
     close(): Promise<void>;
@@ -66,6 +68,7 @@ export default class RTCEngine extends RTCEngine_base {
     private handleDataChannel;
     private handleDataMessage;
     private handleDataError;
+    private handleBufferedAmountLow;
     private setPreferredCodec;
     createSender(track: LocalTrack, opts: TrackPublishOptions, encodings?: RTCRtpEncodingParameters[]): Promise<RTCRtpSender>;
     createSimulcastSender(track: LocalVideoTrack, simulcastTrack: SimulcastTrackInfo, opts: TrackPublishOptions, encodings?: RTCRtpEncodingParameters[]): Promise<RTCRtpSender | undefined>;
@@ -77,8 +80,12 @@ export default class RTCEngine extends RTCEngine_base {
     private getNextRetryDelay;
     private restartConnection;
     private resumeConnection;
-    waitForPCConnected(): Promise<void>;
+    waitForPCInitialConnection(timeout?: number, abortController?: AbortController): Promise<void>;
+    private waitForPCReconnected;
+    waitForRestarted: () => Promise<void>;
     sendDataPacket(packet: DataPacket, kind: DataPacket_Kind): Promise<void>;
+    private updateAndEmitDCBufferStatus;
+    private isBufferStatusLow;
     /**
      * @internal
      */
@@ -100,13 +107,15 @@ export type EngineEventCallbacks = {
     resuming: () => void;
     resumed: () => void;
     restarting: () => void;
-    restarted: (joinResp: JoinResponse) => void;
+    restarted: () => void;
     signalResumed: () => void;
+    signalRestarted: (joinResp: JoinResponse) => void;
     closing: () => void;
     mediaTrackAdded: (track: MediaStreamTrack, streams: MediaStream, receiver?: RTCRtpReceiver) => void;
     activeSpeakersUpdate: (speakers: Array<SpeakerInfo>) => void;
     dataPacketReceived: (userPacket: UserPacket, kind: DataPacket_Kind) => void;
     transportsCreated: (publisher: PCTransport, subscriber: PCTransport) => void;
+    dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void;
 };
 export {};
 //# sourceMappingURL=RTCEngine.d.ts.map

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

@@ -19,5 +19,6 @@ export interface ReconnectContext {
      * Reason for retrying
      */
     readonly retryReason?: Error;
+    readonly serverUrl?: string;
 }
 //# sourceMappingURL=ReconnectPolicy.d.ts.map

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

@@ -0,0 +1,14 @@
+export declare class RegionUrlProvider {
+    private serverUrl;
+    private token;
+    private regionSettings;
+    private lastUpdateAt;
+    private settingsCacheTime;
+    private attemptedRegions;
+    constructor(url: string, token: string);
+    isCloud(): boolean;
+    getNextBestRegionUrl(abortSignal?: AbortSignal): Promise<string | null>;
+    resetAttempts(): void;
+    private fetchRegionSettings;
+}
+//# sourceMappingURL=RegionUrlProvider.d.ts.map

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

@@ -1,17 +1,17 @@
 import type TypedEmitter from 'typed-emitter';
 import type { InternalRoomOptions, RoomConnectOptions, RoomOptions } from '../options';
 import { DataPacket_Kind, DisconnectReason, ParticipantPermission } from '../proto/livekit_models';
+import RTCEngine from './RTCEngine';
 import LocalParticipant from './participant/LocalParticipant';
 import type Participant from './participant/Participant';
 import type { ConnectionQuality } from './participant/Participant';
 import RemoteParticipant from './participant/RemoteParticipant';
-import RTCEngine from './RTCEngine';
 import LocalTrackPublication from './track/LocalTrackPublication';
 import type RemoteTrack from './track/RemoteTrack';
 import RemoteTrackPublication from './track/RemoteTrackPublication';
 import { Track } from './track/Track';
 import type { TrackPublication } from './track/TrackPublication';
-import type { SimulationOptions } from './types';
+import type { SimulationOptions, SimulationScenario } from './types';
 export declare enum ConnectionState {
     Disconnected = "disconnected",
     Connecting = "connecting",
@@ -40,17 +40,11 @@ declare class Room extends Room_base {
     activeSpeakers: Participant[];
     /** @internal */
     engine: RTCEngine;
-    /** server assigned unique room id */
-    sid: string;
-    /** user assigned name, derived from JWT token */
-    name: string;
     /** the current participant */
     localParticipant: LocalParticipant;
-    /** room metadata */
-    metadata: string | undefined;
     /** options of room */
     options: InternalRoomOptions;
-    private _isRecording;
+    private roomInfo?;
     private identityToSid;
     /** connect options of room */
     private connOptions?;
@@ -66,6 +60,18 @@ declare class Room extends Room_base {
      * @param options
      */
     constructor(options?: RoomOptions);
+    /**
+     * if the current room has a participant with `recorder: true` in its JWT grant
+     **/
+    get isRecording(): boolean;
+    /** server assigned unique room id */
+    get sid(): string;
+    /** user assigned name, derived from JWT token */
+    get name(): string;
+    /** room metadata */
+    get metadata(): string | undefined;
+    get numParticipants(): number;
+    get numPublishers(): number;
     private maybeCreateEngine;
     /**
      * getLocalDevices abstracts navigator.mediaDevices.enumerateDevices.
@@ -86,6 +92,9 @@ declare class Room extends Room_base {
      */
     prepareConnection(url: string): Promise<void>;
     connect: (url: string, token: string, opts?: RoomConnectOptions) => Promise<void>;
+    private connectSignal;
+    private applyJoinResponse;
+    private attemptConnection;
     /**
      * disconnects the room, emits [[RoomEvent.Disconnected]]
      */
@@ -97,14 +106,10 @@ declare class Room extends Room_base {
      */
     getParticipantByIdentity(identity: string): Participant | undefined;
     private clearConnectionFutures;
-    /**
-     * if the current room has a participant with `recorder: true` in its JWT grant
-     **/
-    get isRecording(): boolean;
     /**
      * @internal for testing
      */
-    simulateScenario(scenario: string): Promise<void>;
+    simulateScenario(scenario: SimulationScenario): Promise<void>;
     private onPageLeave;
     /**
      * Browsers have different policies regarding audio playback. Most requiring
@@ -141,7 +146,7 @@ declare class Room extends Room_base {
     private recreateEngine;
     private onTrackAdded;
     private handleRestarting;
-    private handleRestarted;
+    private handleSignalRestarted;
     private handleDisconnect;
     private handleParticipantUpdates;
     private handleParticipantDisconnected;
@@ -167,6 +172,7 @@ declare class Room extends Room_base {
     private setAndEmitConnectionState;
     private emitWhenConnected;
     private onLocalParticipantMetadataChanged;
+    private onLocalParticipantNameChanged;
     private onLocalTrackMuted;
     private onLocalTrackUnmuted;
     private onLocalTrackPublished;
@@ -205,6 +211,7 @@ export type RoomEventCallbacks = {
     localTrackUnpublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
     localAudioSilenceDetected: (publication: LocalTrackPublication) => void;
     participantMetadataChanged: (metadata: string | undefined, participant: RemoteParticipant | LocalParticipant) => void;
+    participantNameChanged: (name: string, participant: RemoteParticipant | LocalParticipant) => void;
     participantPermissionsChanged: (prevPermissions: ParticipantPermission | undefined, participant: RemoteParticipant | LocalParticipant) => void;
     activeSpeakersChanged: (speakers: Array<Participant>) => void;
     roomMetadataChanged: (metadata: string) => void;
@@ -217,5 +224,6 @@ export type RoomEventCallbacks = {
     audioPlaybackChanged: (playing: boolean) => void;
     signalConnected: () => void;
     recordingStatusChanged: (recording: boolean) => void;
+    dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void;
 };
 //# sourceMappingURL=Room.d.ts.map

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

@@ -5,7 +5,8 @@ export declare class LivekitError extends Error {
 export declare const enum ConnectionErrorReason {
     NotAllowed = 0,
     ServerUnreachable = 1,
-    InternalError = 2
+    InternalError = 2,
+    Cancelled = 3
 }
 export declare class ConnectionError extends LivekitError {
     status?: number;

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

@@ -146,6 +146,13 @@ export declare enum RoomEvent {
      *
      */
     ParticipantMetadataChanged = "participantMetadataChanged",
+    /**
+     * Participant's display name changed
+     *
+     * args: (name: string, [[Participant]])
+     *
+     */
+    ParticipantNameChanged = "participantNameChanged",
     /**
      * Room metadata is a simple way for app-specific state to be pushed to
      * all users.
@@ -231,7 +238,12 @@ export declare enum RoomEvent {
      * Recording of a room has started/stopped. Room.isRecording will be updated too.
      * args: (isRecording: boolean)
      */
-    RecordingStatusChanged = "recordingStatusChanged"
+    RecordingStatusChanged = "recordingStatusChanged",
+    /**
+     * Emits whenever the current buffer status of a data channel changes
+     * args: (isLow: boolean, kind: [[DataPacket_Kind]])
+     */
+    DCBufferStatusChanged = "dcBufferStatusChanged"
 }
 export declare enum ParticipantEvent {
     /**
@@ -310,6 +322,13 @@ export declare enum ParticipantEvent {
      *
      */
     ParticipantMetadataChanged = "participantMetadataChanged",
+    /**
+     * Participant's display name changed
+     *
+     * args: (name: string, [[Participant]])
+     *
+     */
+    ParticipantNameChanged = "participantNameChanged",
     /**
      * Data received from this participant as sender.
      * Data packets provides the ability to use LiveKit to send/receive arbitrary payloads.
@@ -375,10 +394,12 @@ export declare enum EngineEvent {
     Restarting = "restarting",
     Restarted = "restarted",
     SignalResumed = "signalResumed",
+    SignalRestarted = "signalRestarted",
     Closing = "closing",
     MediaTrackAdded = "mediaTrackAdded",
     ActiveSpeakersUpdate = "activeSpeakersUpdate",
-    DataPacketReceived = "dataPacketReceived"
+    DataPacketReceived = "dataPacketReceived",
+    DCBufferStatusChanged = "dcBufferStatusChanged"
 }
 export declare enum TrackEvent {
     Message = "message",

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

@@ -5,8 +5,8 @@ import { DataChannelInfo, TrackPublishedResponse } from '../../proto/livekit_rtc
 import type RTCEngine from '../RTCEngine';
 import LocalTrack from '../track/LocalTrack';
 import LocalTrackPublication from '../track/LocalTrackPublication';
-import { AudioCaptureOptions, BackupVideoCodec, CreateLocalTracksOptions, ScreenShareCaptureOptions, TrackPublishOptions, VideoCaptureOptions } from '../track/options';
 import { Track } from '../track/Track';
+import { AudioCaptureOptions, BackupVideoCodec, CreateLocalTracksOptions, ScreenShareCaptureOptions, TrackPublishOptions, VideoCaptureOptions } from '../track/options';
 import type { DataPublishOptions } from '../types';
 import Participant from './Participant';
 import { ParticipantTrackPermission } from './ParticipantTrackPermission';
@@ -39,6 +39,18 @@ export default class LocalParticipant extends Participant {
     private handleReconnecting;
     private handleReconnected;
     private handleDisconnected;
+    /**
+     * Sets and updates the metadata of the local participant.
+     * Note: this requires `CanUpdateOwnMetadata` permission encoded in the token.
+     * @param metadata
+     */
+    setMetadata(metadata: string): void;
+    /**
+     * Sets and updates the name of the local participant.
+     * Note: this requires `CanUpdateOwnMetadata` permission encoded in the token.
+     * @param metadata
+     */
+    setName(name: string): void;
     /**
      * Enable or disable a participant's camera track.
      *
@@ -139,7 +151,7 @@ export default class LocalParticipant extends Participant {
      */
     setTrackSubscriptionPermissions(allParticipantsAllowed: boolean, participantTrackPermissions?: ParticipantTrackPermission[]): void;
     /** @internal */
-    updateInfo(info: ParticipantInfo): void;
+    updateInfo(info: ParticipantInfo): boolean;
     private updateTrackSubscriptionPermissions;
     /** @internal */
     private onTrackUnmuted;

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

@@ -1,5 +1,5 @@
 import type TypedEmitter from 'typed-emitter';
-import { ConnectionQuality as ProtoQuality, DataPacket_Kind, ParticipantInfo, ParticipantPermission } from '../../proto/livekit_models';
+import { DataPacket_Kind, ParticipantInfo, ParticipantPermission, ConnectionQuality as ProtoQuality } from '../../proto/livekit_models';
 import type LocalTrackPublication from '../track/LocalTrackPublication';
 import type RemoteTrack from '../track/RemoteTrack';
 import type RemoteTrackPublication from '../track/RemoteTrackPublication';
@@ -57,9 +57,10 @@ export default class Participant extends Participant_base {
     /** when participant joined the room */
     get joinedAt(): Date | undefined;
     /** @internal */
-    updateInfo(info: ParticipantInfo): void;
+    updateInfo(info: ParticipantInfo): boolean;
     /** @internal */
     setMetadata(md: string): void;
+    protected setName(name: string): void;
     /** @internal */
     setPermissions(permissions: ParticipantPermission): boolean;
     /** @internal */
@@ -79,6 +80,7 @@ export type ParticipantEventCallbacks = {
     localTrackPublished: (publication: LocalTrackPublication) => void;
     localTrackUnpublished: (publication: LocalTrackPublication) => void;
     participantMetadataChanged: (prevMetadata: string | undefined, participant?: any) => void;
+    participantNameChanged: (name: string) => void;
     dataReceived: (payload: Uint8Array, kind: DataPacket_Kind) => void;
     isSpeakingChanged: (speaking: boolean) => void;
     connectionQualityChanged: (connectionQuality: ConnectionQuality) => void;

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

@@ -1,8 +1,8 @@
 import type { SignalClient } from '../../api/SignalClient';
 import type { ParticipantInfo } from '../../proto/livekit_models';
-import type { AudioOutputOptions } from '../track/options';
 import RemoteTrackPublication from '../track/RemoteTrackPublication';
 import { Track } from '../track/Track';
+import type { AudioOutputOptions } from '../track/options';
 import type { AdaptiveStreamSettings } from '../track/types';
 import Participant, { ParticipantEventCallbacks } from './Participant';
 export default class RemoteParticipant extends Participant {
@@ -35,7 +35,7 @@ export default class RemoteParticipant extends Participant {
     get hasMetadata(): boolean;
     getTrackPublication(sid: Track.SID): RemoteTrackPublication | undefined;
     /** @internal */
-    updateInfo(info: ParticipantInfo): void;
+    updateInfo(info: ParticipantInfo): boolean;
     /** @internal */
     unpublishTrack(sid: Track.SID, sendUnpublish?: boolean): void;
     /**

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

@@ -1,6 +1,6 @@
-import Queue from 'async-await-queue';
-import type { VideoCodec } from './options';
+import { Mutex } from '../utils';
 import { Track } from './Track';
+import type { VideoCodec } from './options';
 export default abstract class LocalTrack extends Track {
     /** @internal */
     sender?: RTCRtpSender;
@@ -9,7 +9,8 @@ export default abstract class LocalTrack extends Track {
     protected constraints: MediaTrackConstraints;
     protected reacquireTrack: boolean;
     protected providedByUser: boolean;
-    protected muteQueue: Queue;
+    protected muteLock: Mutex;
+    protected pauseUpstreamLock: Mutex;
     /**
      *
      * @param mediaTrack

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

@@ -2,9 +2,9 @@ import type { TrackInfo } from '../../proto/livekit_models';
 import type LocalAudioTrack from './LocalAudioTrack';
 import type LocalTrack from './LocalTrack';
 import type LocalVideoTrack from './LocalVideoTrack';
-import type { TrackPublishOptions } from './options';
 import type { Track } from './Track';
 import { TrackPublication } from './TrackPublication';
+import type { TrackPublishOptions } from './options';
 export default class LocalTrackPublication extends TrackPublication {
     track?: LocalTrack;
     options?: TrackPublishOptions;

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

@@ -1,6 +1,6 @@
 import { AudioReceiverStats } from '../stats';
-import type { AudioOutputOptions } from './options';
 import RemoteTrack from './RemoteTrack';
+import type { AudioOutputOptions } from './options';
 export default class RemoteAudioTrack extends RemoteTrack {
     private prevStats?;
     private elementVolume;

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

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

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

@@ -6,7 +6,7 @@ export default class RemoteVideoTrack extends RemoteTrack {
     private adaptiveStreamSettings?;
     private lastVisible?;
     private lastDimensions?;
-    private hasUsedAttach;
+    private isObserved;
     constructor(mediaTrack: MediaStreamTrack, sid: string, receiver?: RTCRtpReceiver, adaptiveStreamSettings?: AdaptiveStreamSettings);
     get isAdaptiveStream(): boolean;
     get mediaStreamTrack(): MediaStreamTrack;

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

@@ -58,10 +58,12 @@ export declare abstract class Track extends Track_base {
     protected enable(): void;
     protected disable(): void;
     abstract startMonitor(signalClient?: SignalClient): void;
-    protected stopMonitor(): void;
+    stopMonitor(): void;
     private recycleElement;
     protected appVisibilityChangedListener: () => void;
     protected handleAppVisibilityChanged(): Promise<void>;
+    protected addAppVisibilityListener(): void;
+    protected removeAppVisibilityListener(): void;
 }
 /** @internal */
 export declare function attachToElement(track: MediaStreamTrack, element: HTMLMediaElement): void;

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

@@ -18,4 +18,9 @@ export type DataPublishOptions = {
     /** the topic under which the message gets published */
     topic?: string;
 };
+export type LiveKitReactNativeInfo = {
+    platform: 'ios' | 'android' | 'windows' | 'macos' | 'web' | 'native';
+    devicePixelRatio: number;
+};
+export type SimulationScenario = 'signal-reconnect' | 'speaker' | 'node-failure' | 'server-leave' | 'migration' | 'resume-reconnect' | 'force-tcp' | 'force-tls' | 'full-reconnect';
 //# sourceMappingURL=types.d.ts.map

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

@@ -17,6 +17,10 @@ export declare function isFireFox(): boolean;
 export declare function isSafari(): boolean;
 export declare function isMobile(): boolean;
 export declare function isWeb(): boolean;
+export declare function isReactNative(): boolean;
+export declare function isCloud(serverUrl: URL): boolean;
+export declare function getReactNativeOs(): string | undefined;
+export declare function getDevicePixelRatio(): number;
 export declare function compareVersions(v1: string, v2: string): number;
 export declare const getResizeObserver: () => ResizeObserver;
 export declare const getIntersectionObserver: () => IntersectionObserver;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.7.1",
+  "version": "1.9.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -51,40 +51,41 @@
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "7.21.0",
-    "@babel/preset-env": "7.20.2",
-    "@changesets/changelog-github": "0.4.8",
-    "@changesets/cli": "2.26.0",
+    "@babel/core": "7.21.4",
+    "@babel/preset-env": "7.21.4",
+    "@changesets/cli": "2.26.1",
+    "@livekit/changesets-changelog-github": "^0.0.4",
     "@rollup/plugin-babel": "6.0.3",
-    "@rollup/plugin-commonjs": "24.0.1",
+    "@rollup/plugin-commonjs": "24.1.0",
     "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.0.1",
+    "@rollup/plugin-node-resolve": "15.0.2",
     "@rollup/plugin-terser": "^0.4.0",
-    "@types/jest": "29.4.0",
-    "@types/sdp-transform": "2.4.5",
+    "@trivago/prettier-plugin-sort-imports": "^4.1.1",
+    "@types/jest": "29.5.0",
+    "@types/sdp-transform": "2.4.6",
     "@types/ua-parser-js": "0.7.36",
     "@types/ws": "8.5.4",
-    "@typescript-eslint/eslint-plugin": "5.54.0",
-    "@typescript-eslint/parser": "5.54.0",
+    "@typescript-eslint/eslint-plugin": "5.58.0",
+    "@typescript-eslint/parser": "5.58.0",
     "downlevel-dts": "^0.11.0",
-    "eslint": "8.35.0",
+    "eslint": "8.38.0",
     "eslint-config-airbnb-typescript": "17.0.0",
-    "eslint-config-prettier": "8.6.0",
+    "eslint-config-prettier": "8.8.0",
     "eslint-plugin-import": "2.27.5",
     "gh-pages": "5.0.0",
-    "jest": "29.4.3",
-    "prettier": "2.8.4",
-    "rollup": "3.18.0",
+    "jest": "29.5.0",
+    "prettier": "^2.8.8",
+    "rollup": "3.20.2",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-filesize": "10.0.0",
     "rollup-plugin-re": "1.0.7",
     "rollup-plugin-typescript2": "0.34.1",
-    "ts-jest": "29.0.5",
-    "ts-proto": "1.140.0",
-    "typedoc": "0.23.26",
+    "ts-jest": "29.1.0",
+    "ts-proto": "1.146.0",
+    "typedoc": "0.24.1",
     "typedoc-plugin-no-inherit": "1.4.0",
     "typescript": "4.9.5",
-    "vite": "4.1.4"
+    "vite": "4.2.1"
   },
   "browserslist": [
     "safari >= 11",