livekit-client 1.9.6 → 1.10.0

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

@@ -1,7 +1,7 @@
 import type TypedEmitter from 'typed-emitter';
 import 'webrtc-adapter';
 import type { InternalRoomOptions, RoomConnectOptions, RoomOptions } from '../options';
-import { DataPacket_Kind, DisconnectReason, ParticipantPermission } from '../proto/livekit_models';
+import { DataPacket_Kind, DisconnectReason, ParticipantPermission, SubscriptionError } from '../proto/livekit_models';
 import RTCEngine from './RTCEngine';
 import LocalParticipant from './participant/LocalParticipant';
 import type Participant from './participant/Participant';
@@ -157,6 +157,7 @@ declare class Room extends Room_base {
     private handleSpeakersChanged;
     private handleStreamStateUpdate;
     private handleSubscriptionPermissionUpdate;
+    private handleSubscriptionError;
     private handleDataPacket;
     private handleAudioPlaybackStarted;
     private handleAudioPlaybackFailed;
@@ -207,7 +208,7 @@ export type RoomEventCallbacks = {
     participantDisconnected: (participant: RemoteParticipant) => void;
     trackPublished: (publication: RemoteTrackPublication, participant: RemoteParticipant) => void;
     trackSubscribed: (track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant) => void;
-    trackSubscriptionFailed: (trackSid: string, participant: RemoteParticipant) => void;
+    trackSubscriptionFailed: (trackSid: string, participant: RemoteParticipant, reason?: SubscriptionError) => void;
     trackUnpublished: (publication: RemoteTrackPublication, participant: RemoteParticipant) => void;
     trackUnsubscribed: (track: RemoteTrack, publication: RemoteTrackPublication, participant: RemoteParticipant) => void;
     trackMuted: (publication: TrackPublication, participant: Participant) => void;

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

@@ -451,6 +451,10 @@ export declare enum TrackEvent {
     /**
      * Fires on RemoteTrackPublication
      */
-    SubscriptionStatusChanged = "subscriptionStatusChanged"
+    SubscriptionStatusChanged = "subscriptionStatusChanged",
+    /**
+     * Fires on RemoteTrackPublication
+     */
+    SubscriptionFailed = "subscriptionFailed"
 }
 //# sourceMappingURL=events.d.ts.map

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

@@ -1,5 +1,5 @@
 import type TypedEmitter from 'typed-emitter';
-import { DataPacket_Kind, ParticipantInfo, ParticipantPermission, ConnectionQuality as ProtoQuality } from '../../proto/livekit_models';
+import { DataPacket_Kind, ParticipantInfo, ParticipantPermission, ConnectionQuality as ProtoQuality, SubscriptionError } from '../../proto/livekit_models';
 import type LocalTrackPublication from '../track/LocalTrackPublication';
 import type RemoteTrack from '../track/RemoteTrack';
 import type RemoteTrackPublication from '../track/RemoteTrackPublication';
@@ -72,7 +72,7 @@ export default class Participant extends Participant_base {
 export type ParticipantEventCallbacks = {
     trackPublished: (publication: RemoteTrackPublication) => void;
     trackSubscribed: (track: RemoteTrack, publication: RemoteTrackPublication) => void;
-    trackSubscriptionFailed: (trackSid: string) => void;
+    trackSubscriptionFailed: (trackSid: string, reason?: SubscriptionError) => void;
     trackUnpublished: (publication: RemoteTrackPublication) => void;
     trackUnsubscribed: (track: RemoteTrack, publication: RemoteTrackPublication) => void;
     trackMuted: (publication: TrackPublication) => void;

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

@@ -17,4 +17,12 @@ export declare function presetsForResolution(isScreenShare: boolean, width: numb
 export declare function defaultSimulcastLayers(isScreenShare: boolean, original: VideoPreset): VideoPreset[];
 /** @internal */
 export declare function sortPresets(presets: Array<VideoPreset> | undefined): VideoPreset[] | undefined;
+/** @internal */
+export declare class ScalabilityMode {
+    spatial: number;
+    temporal: number;
+    suffix: undefined | 'h' | '_KEY' | '_KEY_SHIFT';
+    constructor(scalabilityMode: string);
+    toString(): string;
+}
 //# sourceMappingURL=publishUtils.d.ts.map

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

@@ -1,6 +1,7 @@
 import { Mutex } from '../utils';
 import { Track } from './Track';
 import type { VideoCodec } from './options';
+import type { TrackProcessor } from './processor/types';
 export default abstract class LocalTrack extends Track {
     /** @internal */
     sender?: RTCRtpSender;
@@ -11,6 +12,9 @@ export default abstract class LocalTrack extends Track {
     protected providedByUser: boolean;
     protected muteLock: Mutex;
     protected pauseUpstreamLock: Mutex;
+    protected processorElement?: HTMLMediaElement;
+    protected processor?: TrackProcessor<typeof this.kind>;
+    protected isSettingUpProcessor: boolean;
     /**
      *
      * @param mediaTrack
@@ -24,6 +28,7 @@ export default abstract class LocalTrack extends Track {
     private _isUpstreamPaused;
     get isUpstreamPaused(): boolean;
     get isUserProvided(): boolean;
+    get mediaStreamTrack(): MediaStreamTrack;
     waitForDimensions(timeout?: number): Promise<Track.Dimensions>;
     /**
      * @returns DeviceID of the device that is currently being used for this track
@@ -37,8 +42,35 @@ export default abstract class LocalTrack extends Track {
     protected get needsReAcquisition(): boolean;
     protected handleAppVisibilityChanged(): Promise<void>;
     private handleEnded;
+    stop(): void;
+    /**
+     * pauses publishing to the server without disabling the local MediaStreamTrack
+     * this is used to display a user's own video locally while pausing publishing to
+     * the server.
+     * this API is unsupported on Safari < 12 due to a bug
+     **/
     pauseUpstream(): Promise<void>;
     resumeUpstream(): Promise<void>;
+    /**
+     * Sets a processor on this track.
+     * See https://github.com/livekit/track-processors-js for example usage
+     *
+     * @experimental
+     *
+     * @param processor
+     * @param showProcessedStreamLocally
+     * @returns
+     */
+    setProcessor(processor: TrackProcessor<typeof this.kind>, showProcessedStreamLocally?: boolean): Promise<void>;
+    getProcessor(): TrackProcessor<Track.Kind> | undefined;
+    /**
+     * Stops the track processor
+     * See https://github.com/livekit/track-processors-js for example usage
+     *
+     * @experimental
+     * @returns
+     */
+    stopProcessor(): Promise<void>;
     protected abstract monitorSender(): void;
 }
 //# sourceMappingURL=LocalTrack.d.ts.map

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

@@ -1,4 +1,4 @@
-import { TrackInfo, VideoQuality } from '../../proto/livekit_models';
+import { SubscriptionError, TrackInfo, VideoQuality } from '../../proto/livekit_models';
 import type RemoteTrack from './RemoteTrack';
 import { Track } from './Track';
 import { TrackPublication } from './TrackPublication';
@@ -11,6 +11,7 @@ export default class RemoteTrackPublication extends TrackPublication {
     protected currentVideoQuality?: VideoQuality;
     protected videoDimensions?: Track.Dimensions;
     protected fps?: number;
+    protected subscriptionError?: SubscriptionError;
     constructor(kind: Track.Kind, ti: TrackInfo, autoSubscribe: boolean | undefined);
     /**
      * Subscribe or unsubscribe to this remote track
@@ -48,6 +49,8 @@ export default class RemoteTrackPublication extends TrackPublication {
     /** @internal */
     setAllowed(allowed: boolean): void;
     /** @internal */
+    setSubscriptionError(error: SubscriptionError): void;
+    /** @internal */
     updateInfo(info: TrackInfo): void;
     private emitSubscriptionUpdateIfChanged;
     private emitPermissionUpdateIfChanged;

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

@@ -1,5 +1,5 @@
 import type TypedEventEmitter from 'typed-emitter';
-import type { TrackInfo } from '../../proto/livekit_models';
+import type { SubscriptionError, TrackInfo } from '../../proto/livekit_models';
 import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc';
 import LocalAudioTrack from './LocalAudioTrack';
 import LocalVideoTrack from './LocalVideoTrack';
@@ -63,6 +63,7 @@ export type PublicationEventCallbacks = {
     subscribed: (track: RemoteTrack) => void;
     unsubscribed: (track: RemoteTrack) => void;
     subscriptionStatusChanged: (status: TrackPublication.SubscriptionStatus, prevStatus: TrackPublication.SubscriptionStatus) => void;
+    subscriptionFailed: (error: SubscriptionError) => void;
 };
 export {};
 //# sourceMappingURL=TrackPublication.d.ts.map

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

@@ -216,7 +216,7 @@ export declare function isCodecEqual(c1: string | undefined, c2: string | undefi
 /**
  * scalability modes for svc, only supprot l3t3 now.
  */
-export type ScalabilityMode = 'L3T3';
+export type ScalabilityMode = 'L3T3' | 'L3T3_KEY';
 export declare namespace AudioPresets {
     const telephone: AudioPreset;
     const speech: AudioPreset;

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

@@ -0,0 +1,19 @@
+import type { Track } from '../Track';
+/**
+ * @experimental
+ */
+export type ProcessorOptions<T extends Track.Kind> = {
+    kind: T;
+    track: MediaStreamTrack;
+    element?: HTMLMediaElement;
+};
+/**
+ * @experimental
+ */
+export interface TrackProcessor<T extends Track.Kind> {
+    name: string;
+    init: (opts: ProcessorOptions<T>) => void;
+    destroy: () => Promise<void>;
+    processedTrack?: MediaStreamTrack;
+}
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-client",
-  "version": "1.9.6",
+  "version": "1.10.0",
   "description": "JavaScript/TypeScript client SDK for LiveKit",
   "main": "./dist/livekit-client.umd.js",
   "unpkg": "./dist/livekit-client.umd.js",
@@ -51,43 +51,44 @@
     "webrtc-adapter": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/core": "7.21.8",
-    "@babel/preset-env": "7.21.5",
+    "@babel/core": "7.22.1",
+    "@babel/preset-env": "7.22.4",
     "@changesets/cli": "2.26.1",
     "@livekit/changesets-changelog-github": "^0.0.4",
     "@rollup/plugin-babel": "6.0.3",
     "@rollup/plugin-commonjs": "24.1.0",
     "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.0.2",
+    "@rollup/plugin-node-resolve": "15.1.0",
     "@rollup/plugin-terser": "^0.4.0",
     "@size-limit/file": "^8.2.4",
     "@size-limit/webpack": "^8.2.4",
     "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/events": "^3.0.0",
-    "@types/jest": "29.5.1",
+    "@types/jest": "29.5.2",
     "@types/sdp-transform": "2.4.6",
     "@types/ua-parser-js": "0.7.36",
-    "@typescript-eslint/eslint-plugin": "5.59.2",
-    "@typescript-eslint/parser": "5.59.2",
+    "@typescript-eslint/eslint-plugin": "5.59.8",
+    "@typescript-eslint/parser": "5.59.8",
     "downlevel-dts": "^0.11.0",
-    "eslint": "8.39.0",
+    "eslint": "8.42.0",
     "eslint-config-airbnb-typescript": "17.0.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-ecmascript-compat": "^3.0.0",
     "eslint-plugin-import": "2.27.5",
     "gh-pages": "5.0.0",
     "jest": "29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
     "prettier": "^2.8.8",
-    "rollup": "3.21.3",
+    "rollup": "3.23.1",
     "rollup-plugin-delete": "^2.0.0",
     "rollup-plugin-re": "1.0.7",
     "rollup-plugin-typescript2": "0.34.1",
     "size-limit": "^8.2.4",
     "ts-jest": "29.1.0",
-    "ts-proto": "1.147.1",
-    "typedoc": "0.24.6",
+    "ts-proto": "1.148.2",
+    "typedoc": "0.24.8",
     "typedoc-plugin-no-inherit": "1.4.0",
-    "typescript": "5.0.4",
-    "vite": "4.3.4"
+    "typescript": "5.1.3",
+    "vite": "4.3.9"
   }
 }

package/src/api/SignalClient.ts

@@ -22,6 +22,7 @@ import {
   StreamStateUpdate,
   SubscribedQualityUpdate,
   SubscriptionPermissionUpdate,
+  SubscriptionResponse,
   SyncState,
   TrackPermission,
   TrackPublishedResponse,
@@ -127,6 +128,8 @@ export class SignalClient {
 
   onSubscriptionPermissionUpdate?: (update: SubscriptionPermissionUpdate) => void;
 
+  onSubscriptionError?: (update: SubscriptionResponse) => void;
+
   onLocalTrackUnpublished?: (res: TrackUnpublishedResponse) => void;
 
   onTokenRefresh?: (token: string) => void;
@@ -214,7 +217,7 @@ export class SignalClient {
 
     return new Promise<JoinResponse | ReconnectResponse | void>(async (resolve, reject) => {
       const abortHandler = async () => {
-        await this.close();
+        this.close();
         reject(new ConnectionError('room connection has been cancelled (signal)'));
       };
 
@@ -593,6 +596,10 @@ export class SignalClient {
       if (this.onLocalTrackUnpublished) {
         this.onLocalTrackUnpublished(msg.trackUnpublished);
       }
+    } else if (msg.$case === 'subscriptionResponse') {
+      if (this.onSubscriptionError) {
+        this.onSubscriptionError(msg.subscriptionResponse);
+      }
     } else if (msg.$case === 'pong') {
       this.resetPingTimeout();
     } else if (msg.$case === 'pongResp') {

package/src/index.ts

@@ -40,6 +40,7 @@ export * from './room/track/options';
 export * from './room/track/types';
 export type { DataPublishOptions, SimulationScenario } from './room/types';
 export * from './version';
+export * from './room/track/processor/types';
 export {
   setLogLevel,
   setLogExtension,

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

@@ -134,21 +134,21 @@ export const Timestamp = {
       const tag = reader.uint32();
       switch (tag >>> 3) {
         case 1:
-          if (tag != 8) {
+          if (tag !== 8) {
             break;
           }
 
           message.seconds = longToNumber(reader.int64() as Long);
           continue;
         case 2:
-          if (tag != 16) {
+          if (tag !== 16) {
             break;
           }
 
           message.nanos = reader.int32();
           continue;
       }
-      if ((tag & 7) == 4 || tag == 0) {
+      if ((tag & 7) === 4 || tag === 0) {
         break;
       }
       reader.skipType(tag & 7);