livekit-client 1.7.0 → 1.8.0

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

@@ -21,6 +21,7 @@ export default class RTCEngine extends RTCEngine_base {
     private lossyDC?;
     private lossyDCSub?;
     private reliableDC?;
+    private dcBufferStatus;
     private reliableDCSub?;
     private subscriberPrimary;
     private primaryPC?;
@@ -44,7 +45,9 @@ export default class RTCEngine extends RTCEngine_base {
     /** specifies how often an initial join connection is allowed to retry */
     private maxJoinAttempts;
     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>;
@@ -65,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>;
@@ -76,8 +80,11 @@ export default class RTCEngine extends RTCEngine_base {
     private getNextRetryDelay;
     private restartConnection;
     private resumeConnection;
-    waitForPCConnected(): Promise<void>;
+    waitForPCInitialConnection(timeout?: number, abortController?: AbortController): Promise<void>;
+    waitForPCReconnected(): Promise<void>;
     sendDataPacket(packet: DataPacket, kind: DataPacket_Kind): Promise<void>;
+    private updateAndEmitDCBufferStatus;
+    private isBufferStatusLow;
     /**
      * @internal
      */
@@ -106,6 +113,7 @@ export type EngineEventCallbacks = {
     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

@@ -86,6 +86,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]]
      */
@@ -105,7 +108,7 @@ declare class Room extends Room_base {
      * @internal for testing
      */
     simulateScenario(scenario: string): Promise<void>;
-    private onBeforeUnload;
+    private onPageLeave;
     /**
      * Browsers have different policies regarding audio playback. Most requiring
      * some form of user interaction (click/tap/etc).
@@ -203,6 +206,7 @@ export type RoomEventCallbacks = {
     trackUnmuted: (publication: TrackPublication, participant: Participant) => void;
     localTrackPublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
     localTrackUnpublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
+    localAudioSilenceDetected: (publication: LocalTrackPublication) => void;
     participantMetadataChanged: (metadata: string | undefined, participant: RemoteParticipant | LocalParticipant) => void;
     participantPermissionsChanged: (prevPermissions: ParticipantPermission | undefined, participant: RemoteParticipant | LocalParticipant) => void;
     activeSpeakersChanged: (speakers: Array<Participant>) => void;
@@ -216,5 +220,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

@@ -120,6 +120,13 @@ export declare enum RoomEvent {
      * args: ([[LocalTrackPublication]], [[LocalParticipant]])
      */
     LocalTrackUnpublished = "localTrackUnpublished",
+    /**
+     * When a local audio track is published the SDK checks whether there is complete silence
+     * on that track and emits the LocalAudioSilenceDetected event in that case.
+     * This allows for applications to show UI informing users that they might have to
+     * reset their audio hardware or check for proper device connectivity.
+     */
+    LocalAudioSilenceDetected = "localAudioSilenceDetected",
     /**
      * Active speakers changed. List of speakers are ordered by their audio level.
      * loudest speakers first. This will include the LocalParticipant too.
@@ -224,7 +231,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 {
     /**
@@ -371,7 +383,8 @@ export declare enum EngineEvent {
     Closing = "closing",
     MediaTrackAdded = "mediaTrackAdded",
     ActiveSpeakersUpdate = "activeSpeakersUpdate",
-    DataPacketReceived = "dataPacketReceived"
+    DataPacketReceived = "dataPacketReceived",
+    DCBufferStatusChanged = "dcBufferStatusChanged"
 }
 export declare enum TrackEvent {
     Message = "message",

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

@@ -20,6 +20,6 @@ export default class LocalAudioTrack extends LocalTrack {
     startMonitor(): void;
     protected monitorSender: () => Promise<void>;
     getSenderStats(): Promise<AudioSenderStats | undefined>;
-    checkForSilence(): Promise<void>;
+    checkForSilence(): Promise<boolean>;
 }
 //# sourceMappingURL=LocalAudioTrack.d.ts.map

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

@@ -1,4 +1,4 @@
-import Queue from 'async-await-queue';
+import { Mutex } from '../utils';
 import type { VideoCodec } from './options';
 import { Track } from './Track';
 export default abstract class LocalTrack extends Track {
@@ -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/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;
@@ -43,6 +43,7 @@ export interface ElementInfo {
     width(): number;
     height(): number;
     visible: boolean;
+    pictureInPicture: boolean;
     visibilityChangedAt: number | undefined;
     handleResize?: () => void;
     handleVisibilityChanged?: () => void;

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,8 @@ 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;
+};
 //# 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.0",
+  "version": "1.8.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -51,40 +51,40 @@
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "7.21.0",
-    "@babel/preset-env": "7.20.2",
+    "@babel/core": "7.21.4",
+    "@babel/preset-env": "7.21.4",
     "@changesets/changelog-github": "0.4.8",
-    "@changesets/cli": "2.26.0",
+    "@changesets/cli": "2.26.1",
     "@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",
+    "@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.7",
+    "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",

package/src/api/SignalClient.ts

@@ -33,7 +33,7 @@ import {
 } from '../proto/livekit_rtc';
 import { ConnectionError, ConnectionErrorReason } from '../room/errors';
 import CriticalTimers from '../room/timers';
-import { getClientInfo, Mutex, sleep } from '../room/utils';
+import { getClientInfo, isReactNative, Mutex, sleep } from '../room/utils';
 
 // internal options
 interface ConnectOpts {
@@ -216,7 +216,7 @@ export class SignalClient {
     return new Promise<JoinResponse | ReconnectResponse | void>(async (resolve, reject) => {
       const abortHandler = async () => {
         await this.close();
-        reject(new ConnectionError('room connection has been cancelled'));
+        reject(new ConnectionError('room connection has been cancelled (signal)'));
       };
 
       if (abortSignal?.aborted) {
@@ -234,7 +234,7 @@ export class SignalClient {
         if (!this.isConnected) {
           try {
             const resp = await fetch(`http${url.substring(2)}/validate${params}`);
-            if (!resp.ok) {
+            if (resp.status.toFixed(0).startsWith('4')) {
               const msg = await resp.text();
               reject(new ConnectionError(msg, ConnectionErrorReason.NotAllowed, resp.status));
             } else {
@@ -706,7 +706,7 @@ function createConnectionParams(token: string, info: ClientInfo, opts: ConnectOp
   params.set('auto_subscribe', opts.autoSubscribe ? '1' : '0');
 
   // ClientInfo
-  params.set('sdk', 'js');
+  params.set('sdk', isReactNative() ? 'reactnative' : 'js');
   params.set('version', info.version!);
   params.set('protocol', info.protocol!.toString());
   if (info.deviceModel) {

package/src/index.ts

@@ -28,10 +28,12 @@ import {
 } from './room/utils';
 
 import type { AudioAnalyserOptions } from './room/utils';
+import type { LiveKitReactNativeInfo } from './room/types';
 
 export * from './options';
 export * from './room/errors';
 export * from './room/events';
+export type { DataPublishOptions } from './room/types';
 export * from './room/track/create';
 export * from './room/track/options';
 export * from './room/track/Track';
@@ -73,4 +75,5 @@ export {
   ElementInfo,
   DefaultReconnectPolicy,
   CriticalTimers,
+  LiveKitReactNativeInfo,
 };

package/src/options.ts

@@ -64,6 +64,12 @@ export interface InternalRoomOptions {
    */
   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

package/src/proto/google/protobuf/timestamp.ts

@@ -127,22 +127,31 @@ export const Timestamp = {
   },
 
   decode(input: _m0.Reader | Uint8Array, length?: number): Timestamp {
-    const reader = input instanceof _m0.Reader ? input : new _m0.Reader(input);
+    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
     let end = length === undefined ? reader.len : reader.pos + length;
     const message = createBaseTimestamp();
     while (reader.pos < end) {
       const tag = reader.uint32();
       switch (tag >>> 3) {
         case 1:
+          if (tag != 8) {
+            break;
+          }
+
           message.seconds = longToNumber(reader.int64() as Long);
-          break;
+          continue;
         case 2:
+          if (tag != 16) {
+            break;
+          }
+
           message.nanos = reader.int32();
-          break;
-        default:
-          reader.skipType(tag & 7);
-          break;
+          continue;
+      }
+      if ((tag & 7) == 4 || tag == 0) {
+        break;
       }
+      reader.skipType(tag & 7);
     }
     return message;
   },