livekit-client 0.15.2 → 0.16.1

package/dist/proto/livekit_rtc.d.ts

@@ -37,7 +37,11 @@ export interface SignalRequest {
      */
     updateLayers?: UpdateVideoLayers | undefined;
     /** Update subscriber permissions */
-    subscriptionPermissions?: UpdateSubscriptionPermissions | undefined;
+    subscriptionPermission?: SubscriptionPermission | undefined;
+    /** sync client's subscribe state to server during reconnect */
+    syncState?: SyncState | undefined;
+    /** Simulate conditions, for client validations */
+    simulate?: SimulateScenario | undefined;
 }
 export interface SignalResponse {
     /** sent when join is accepted */
@@ -62,12 +66,17 @@ export interface SignalResponse {
     roomUpdate?: RoomUpdate | undefined;
     /** when connection quality changed */
     connectionQuality?: ConnectionQualityUpdate | undefined;
-    /** when streamed tracks state changed */
+    /**
+     * when streamed tracks state changed, used to notify when any of the streams were paused due to
+     * congestion
+     */
     streamStateUpdate?: StreamStateUpdate | undefined;
-    /** when max subscribe quality changed */
+    /** when max subscribe quality changed, used by dynamic broadcasting to disable unused layers */
     subscribedQualityUpdate?: SubscribedQualityUpdate | undefined;
     /** when subscription permission changed */
     subscriptionPermissionUpdate?: SubscriptionPermissionUpdate | undefined;
+    /** update the token the client was using, to prevent an active client from using an expired token */
+    refreshToken: string | undefined;
 }
 export interface AddTrackRequest {
     /** client ID of track, to match it when RTC track is received */
@@ -186,7 +195,7 @@ export interface TrackPermission {
     allTracks: boolean;
     trackSids: string[];
 }
-export interface UpdateSubscriptionPermissions {
+export interface SubscriptionPermission {
     allParticipants: boolean;
     trackPermissions: TrackPermission[];
 }
@@ -195,6 +204,21 @@ export interface SubscriptionPermissionUpdate {
     trackSid: string;
     allowed: boolean;
 }
+export interface SyncState {
+    answer?: SessionDescription;
+    subscription?: UpdateSubscription;
+    publishTracks: TrackPublishedResponse[];
+}
+export interface SimulateScenario {
+    /** simulate N seconds of speaker activity */
+    speakerUpdate: number | undefined;
+    /** simulate local node failure */
+    nodeFailure: boolean | undefined;
+    /** simulate migration */
+    migration: boolean | undefined;
+    /** server to send leave */
+    serverLeave: boolean | undefined;
+}
 export declare const SignalRequest: {
     encode(message: SignalRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SignalRequest;
@@ -356,12 +380,12 @@ export declare const TrackPermission: {
     toJSON(message: TrackPermission): unknown;
     fromPartial(object: DeepPartial<TrackPermission>): TrackPermission;
 };
-export declare const UpdateSubscriptionPermissions: {
-    encode(message: UpdateSubscriptionPermissions, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): UpdateSubscriptionPermissions;
-    fromJSON(object: any): UpdateSubscriptionPermissions;
-    toJSON(message: UpdateSubscriptionPermissions): unknown;
-    fromPartial(object: DeepPartial<UpdateSubscriptionPermissions>): UpdateSubscriptionPermissions;
+export declare const SubscriptionPermission: {
+    encode(message: SubscriptionPermission, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SubscriptionPermission;
+    fromJSON(object: any): SubscriptionPermission;
+    toJSON(message: SubscriptionPermission): unknown;
+    fromPartial(object: DeepPartial<SubscriptionPermission>): SubscriptionPermission;
 };
 export declare const SubscriptionPermissionUpdate: {
     encode(message: SubscriptionPermissionUpdate, writer?: _m0.Writer): _m0.Writer;
@@ -370,6 +394,20 @@ export declare const SubscriptionPermissionUpdate: {
     toJSON(message: SubscriptionPermissionUpdate): unknown;
     fromPartial(object: DeepPartial<SubscriptionPermissionUpdate>): SubscriptionPermissionUpdate;
 };
+export declare const SyncState: {
+    encode(message: SyncState, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SyncState;
+    fromJSON(object: any): SyncState;
+    toJSON(message: SyncState): unknown;
+    fromPartial(object: DeepPartial<SyncState>): SyncState;
+};
+export declare const SimulateScenario: {
+    encode(message: SimulateScenario, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): SimulateScenario;
+    fromJSON(object: any): SimulateScenario;
+    toJSON(message: SimulateScenario): unknown;
+    fromPartial(object: DeepPartial<SimulateScenario>): SimulateScenario;
+};
 declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;

package/dist/proto/livekit_rtc.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionPermissionUpdate = exports.UpdateSubscriptionPermissions = exports.TrackPermission = exports.SubscribedQualityUpdate = exports.SubscribedQuality = exports.StreamStateUpdate = exports.StreamStateInfo = exports.ConnectionQualityUpdate = exports.ConnectionQualityInfo = exports.RoomUpdate = exports.SpeakersChanged = exports.ICEServer = exports.UpdateVideoLayers = exports.LeaveRequest = exports.UpdateTrackSettings = exports.UpdateSubscription = exports.ParticipantUpdate = exports.SessionDescription = exports.TrackPublishedResponse = exports.JoinResponse = exports.MuteTrackRequest = exports.TrickleRequest = exports.AddTrackRequest = exports.SignalResponse = exports.SignalRequest = exports.streamStateToJSON = exports.streamStateFromJSON = exports.StreamState = exports.signalTargetToJSON = exports.signalTargetFromJSON = exports.SignalTarget = exports.protobufPackage = void 0;
+exports.SimulateScenario = exports.SyncState = exports.SubscriptionPermissionUpdate = exports.SubscriptionPermission = exports.TrackPermission = exports.SubscribedQualityUpdate = exports.SubscribedQuality = exports.StreamStateUpdate = exports.StreamStateInfo = exports.ConnectionQualityUpdate = exports.ConnectionQualityInfo = exports.RoomUpdate = exports.SpeakersChanged = exports.ICEServer = exports.UpdateVideoLayers = exports.LeaveRequest = exports.UpdateTrackSettings = exports.UpdateSubscription = exports.ParticipantUpdate = exports.SessionDescription = exports.TrackPublishedResponse = exports.JoinResponse = exports.MuteTrackRequest = exports.TrickleRequest = exports.AddTrackRequest = exports.SignalResponse = exports.SignalRequest = exports.streamStateToJSON = exports.streamStateFromJSON = exports.StreamState = exports.signalTargetToJSON = exports.signalTargetFromJSON = exports.SignalTarget = exports.protobufPackage = void 0;
 /* eslint-disable */
 const long_1 = __importDefault(require("long"));
 const minimal_1 = __importDefault(require("protobufjs/minimal"));
@@ -103,8 +103,14 @@ exports.SignalRequest = {
         if (message.updateLayers !== undefined) {
             exports.UpdateVideoLayers.encode(message.updateLayers, writer.uint32(82).fork()).ldelim();
         }
-        if (message.subscriptionPermissions !== undefined) {
-            exports.UpdateSubscriptionPermissions.encode(message.subscriptionPermissions, writer.uint32(90).fork()).ldelim();
+        if (message.subscriptionPermission !== undefined) {
+            exports.SubscriptionPermission.encode(message.subscriptionPermission, writer.uint32(90).fork()).ldelim();
+        }
+        if (message.syncState !== undefined) {
+            exports.SyncState.encode(message.syncState, writer.uint32(98).fork()).ldelim();
+        }
+        if (message.simulate !== undefined) {
+            exports.SimulateScenario.encode(message.simulate, writer.uint32(106).fork()).ldelim();
         }
         return writer;
     },
@@ -143,8 +149,13 @@ exports.SignalRequest = {
                     message.updateLayers = exports.UpdateVideoLayers.decode(reader, reader.uint32());
                     break;
                 case 11:
-                    message.subscriptionPermissions =
-                        exports.UpdateSubscriptionPermissions.decode(reader, reader.uint32());
+                    message.subscriptionPermission = exports.SubscriptionPermission.decode(reader, reader.uint32());
+                    break;
+                case 12:
+                    message.syncState = exports.SyncState.decode(reader, reader.uint32());
+                    break;
+                case 13:
+                    message.simulate = exports.SimulateScenario.decode(reader, reader.uint32());
                     break;
                 default:
                     reader.skipType(tag & 7);
@@ -209,12 +220,24 @@ exports.SignalRequest = {
         else {
             message.updateLayers = undefined;
         }
-        if (object.subscriptionPermissions !== undefined &&
-            object.subscriptionPermissions !== null) {
-            message.subscriptionPermissions = exports.UpdateSubscriptionPermissions.fromJSON(object.subscriptionPermissions);
+        if (object.subscriptionPermission !== undefined &&
+            object.subscriptionPermission !== null) {
+            message.subscriptionPermission = exports.SubscriptionPermission.fromJSON(object.subscriptionPermission);
+        }
+        else {
+            message.subscriptionPermission = undefined;
+        }
+        if (object.syncState !== undefined && object.syncState !== null) {
+            message.syncState = exports.SyncState.fromJSON(object.syncState);
+        }
+        else {
+            message.syncState = undefined;
+        }
+        if (object.simulate !== undefined && object.simulate !== null) {
+            message.simulate = exports.SimulateScenario.fromJSON(object.simulate);
         }
         else {
-            message.subscriptionPermissions = undefined;
+            message.simulate = undefined;
         }
         return message;
     },
@@ -256,9 +279,17 @@ exports.SignalRequest = {
             (obj.updateLayers = message.updateLayers
                 ? exports.UpdateVideoLayers.toJSON(message.updateLayers)
                 : undefined);
-        message.subscriptionPermissions !== undefined &&
-            (obj.subscriptionPermissions = message.subscriptionPermissions
-                ? exports.UpdateSubscriptionPermissions.toJSON(message.subscriptionPermissions)
+        message.subscriptionPermission !== undefined &&
+            (obj.subscriptionPermission = message.subscriptionPermission
+                ? exports.SubscriptionPermission.toJSON(message.subscriptionPermission)
+                : undefined);
+        message.syncState !== undefined &&
+            (obj.syncState = message.syncState
+                ? exports.SyncState.toJSON(message.syncState)
+                : undefined);
+        message.simulate !== undefined &&
+            (obj.simulate = message.simulate
+                ? exports.SimulateScenario.toJSON(message.simulate)
                 : undefined);
         return obj;
     },
@@ -318,13 +349,24 @@ exports.SignalRequest = {
         else {
             message.updateLayers = undefined;
         }
-        if (object.subscriptionPermissions !== undefined &&
-            object.subscriptionPermissions !== null) {
-            message.subscriptionPermissions =
-                exports.UpdateSubscriptionPermissions.fromPartial(object.subscriptionPermissions);
+        if (object.subscriptionPermission !== undefined &&
+            object.subscriptionPermission !== null) {
+            message.subscriptionPermission = exports.SubscriptionPermission.fromPartial(object.subscriptionPermission);
+        }
+        else {
+            message.subscriptionPermission = undefined;
+        }
+        if (object.syncState !== undefined && object.syncState !== null) {
+            message.syncState = exports.SyncState.fromPartial(object.syncState);
+        }
+        else {
+            message.syncState = undefined;
+        }
+        if (object.simulate !== undefined && object.simulate !== null) {
+            message.simulate = exports.SimulateScenario.fromPartial(object.simulate);
         }
         else {
-            message.subscriptionPermissions = undefined;
+            message.simulate = undefined;
         }
         return message;
     },
@@ -374,6 +416,9 @@ exports.SignalResponse = {
         if (message.subscriptionPermissionUpdate !== undefined) {
             exports.SubscriptionPermissionUpdate.encode(message.subscriptionPermissionUpdate, writer.uint32(122).fork()).ldelim();
         }
+        if (message.refreshToken !== undefined) {
+            writer.uint32(130).string(message.refreshToken);
+        }
         return writer;
     },
     decode(input, length) {
@@ -426,6 +471,9 @@ exports.SignalResponse = {
                     message.subscriptionPermissionUpdate =
                         exports.SubscriptionPermissionUpdate.decode(reader, reader.uint32());
                     break;
+                case 16:
+                    message.refreshToken = reader.string();
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -525,6 +573,12 @@ exports.SignalResponse = {
         else {
             message.subscriptionPermissionUpdate = undefined;
         }
+        if (object.refreshToken !== undefined && object.refreshToken !== null) {
+            message.refreshToken = String(object.refreshToken);
+        }
+        else {
+            message.refreshToken = undefined;
+        }
         return message;
     },
     toJSON(message) {
@@ -583,9 +637,12 @@ exports.SignalResponse = {
             (obj.subscriptionPermissionUpdate = message.subscriptionPermissionUpdate
                 ? exports.SubscriptionPermissionUpdate.toJSON(message.subscriptionPermissionUpdate)
                 : undefined);
+        message.refreshToken !== undefined &&
+            (obj.refreshToken = message.refreshToken);
         return obj;
     },
     fromPartial(object) {
+        var _a;
         const message = Object.assign({}, baseSignalResponse);
         if (object.join !== undefined && object.join !== null) {
             message.join = exports.JoinResponse.fromPartial(object.join);
@@ -677,6 +734,7 @@ exports.SignalResponse = {
         else {
             message.subscriptionPermissionUpdate = undefined;
         }
+        message.refreshToken = (_a = object.refreshToken) !== null && _a !== void 0 ? _a : undefined;
         return message;
     },
 };
@@ -2384,8 +2442,8 @@ exports.TrackPermission = {
         return message;
     },
 };
-const baseUpdateSubscriptionPermissions = { allParticipants: false };
-exports.UpdateSubscriptionPermissions = {
+const baseSubscriptionPermission = { allParticipants: false };
+exports.SubscriptionPermission = {
     encode(message, writer = minimal_1.default.Writer.create()) {
         if (message.allParticipants === true) {
             writer.uint32(8).bool(message.allParticipants);
@@ -2398,7 +2456,7 @@ exports.UpdateSubscriptionPermissions = {
     decode(input, length) {
         const reader = input instanceof minimal_1.default.Reader ? input : new minimal_1.default.Reader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
-        const message = Object.assign({}, baseUpdateSubscriptionPermissions);
+        const message = Object.assign({}, baseSubscriptionPermission);
         message.trackPermissions = [];
         while (reader.pos < end) {
             const tag = reader.uint32();
@@ -2417,7 +2475,7 @@ exports.UpdateSubscriptionPermissions = {
         return message;
     },
     fromJSON(object) {
-        const message = Object.assign({}, baseUpdateSubscriptionPermissions);
+        const message = Object.assign({}, baseSubscriptionPermission);
         message.trackPermissions = [];
         if (object.allParticipants !== undefined &&
             object.allParticipants !== null) {
@@ -2448,7 +2506,7 @@ exports.UpdateSubscriptionPermissions = {
     },
     fromPartial(object) {
         var _a;
-        const message = Object.assign({}, baseUpdateSubscriptionPermissions);
+        const message = Object.assign({}, baseSubscriptionPermission);
         message.allParticipants = (_a = object.allParticipants) !== null && _a !== void 0 ? _a : false;
         message.trackPermissions = [];
         if (object.trackPermissions !== undefined &&
@@ -2540,6 +2598,199 @@ exports.SubscriptionPermissionUpdate = {
         return message;
     },
 };
+const baseSyncState = {};
+exports.SyncState = {
+    encode(message, writer = minimal_1.default.Writer.create()) {
+        if (message.answer !== undefined) {
+            exports.SessionDescription.encode(message.answer, writer.uint32(10).fork()).ldelim();
+        }
+        if (message.subscription !== undefined) {
+            exports.UpdateSubscription.encode(message.subscription, writer.uint32(18).fork()).ldelim();
+        }
+        for (const v of message.publishTracks) {
+            exports.TrackPublishedResponse.encode(v, writer.uint32(26).fork()).ldelim();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof minimal_1.default.Reader ? input : new minimal_1.default.Reader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = Object.assign({}, baseSyncState);
+        message.publishTracks = [];
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    message.answer = exports.SessionDescription.decode(reader, reader.uint32());
+                    break;
+                case 2:
+                    message.subscription = exports.UpdateSubscription.decode(reader, reader.uint32());
+                    break;
+                case 3:
+                    message.publishTracks.push(exports.TrackPublishedResponse.decode(reader, reader.uint32()));
+                    break;
+                default:
+                    reader.skipType(tag & 7);
+                    break;
+            }
+        }
+        return message;
+    },
+    fromJSON(object) {
+        const message = Object.assign({}, baseSyncState);
+        message.publishTracks = [];
+        if (object.answer !== undefined && object.answer !== null) {
+            message.answer = exports.SessionDescription.fromJSON(object.answer);
+        }
+        else {
+            message.answer = undefined;
+        }
+        if (object.subscription !== undefined && object.subscription !== null) {
+            message.subscription = exports.UpdateSubscription.fromJSON(object.subscription);
+        }
+        else {
+            message.subscription = undefined;
+        }
+        if (object.publishTracks !== undefined && object.publishTracks !== null) {
+            for (const e of object.publishTracks) {
+                message.publishTracks.push(exports.TrackPublishedResponse.fromJSON(e));
+            }
+        }
+        return message;
+    },
+    toJSON(message) {
+        const obj = {};
+        message.answer !== undefined &&
+            (obj.answer = message.answer
+                ? exports.SessionDescription.toJSON(message.answer)
+                : undefined);
+        message.subscription !== undefined &&
+            (obj.subscription = message.subscription
+                ? exports.UpdateSubscription.toJSON(message.subscription)
+                : undefined);
+        if (message.publishTracks) {
+            obj.publishTracks = message.publishTracks.map((e) => e ? exports.TrackPublishedResponse.toJSON(e) : undefined);
+        }
+        else {
+            obj.publishTracks = [];
+        }
+        return obj;
+    },
+    fromPartial(object) {
+        const message = Object.assign({}, baseSyncState);
+        if (object.answer !== undefined && object.answer !== null) {
+            message.answer = exports.SessionDescription.fromPartial(object.answer);
+        }
+        else {
+            message.answer = undefined;
+        }
+        if (object.subscription !== undefined && object.subscription !== null) {
+            message.subscription = exports.UpdateSubscription.fromPartial(object.subscription);
+        }
+        else {
+            message.subscription = undefined;
+        }
+        message.publishTracks = [];
+        if (object.publishTracks !== undefined && object.publishTracks !== null) {
+            for (const e of object.publishTracks) {
+                message.publishTracks.push(exports.TrackPublishedResponse.fromPartial(e));
+            }
+        }
+        return message;
+    },
+};
+const baseSimulateScenario = {};
+exports.SimulateScenario = {
+    encode(message, writer = minimal_1.default.Writer.create()) {
+        if (message.speakerUpdate !== undefined) {
+            writer.uint32(8).int32(message.speakerUpdate);
+        }
+        if (message.nodeFailure !== undefined) {
+            writer.uint32(16).bool(message.nodeFailure);
+        }
+        if (message.migration !== undefined) {
+            writer.uint32(24).bool(message.migration);
+        }
+        if (message.serverLeave !== undefined) {
+            writer.uint32(32).bool(message.serverLeave);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof minimal_1.default.Reader ? input : new minimal_1.default.Reader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = Object.assign({}, baseSimulateScenario);
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    message.speakerUpdate = reader.int32();
+                    break;
+                case 2:
+                    message.nodeFailure = reader.bool();
+                    break;
+                case 3:
+                    message.migration = reader.bool();
+                    break;
+                case 4:
+                    message.serverLeave = reader.bool();
+                    break;
+                default:
+                    reader.skipType(tag & 7);
+                    break;
+            }
+        }
+        return message;
+    },
+    fromJSON(object) {
+        const message = Object.assign({}, baseSimulateScenario);
+        if (object.speakerUpdate !== undefined && object.speakerUpdate !== null) {
+            message.speakerUpdate = Number(object.speakerUpdate);
+        }
+        else {
+            message.speakerUpdate = undefined;
+        }
+        if (object.nodeFailure !== undefined && object.nodeFailure !== null) {
+            message.nodeFailure = Boolean(object.nodeFailure);
+        }
+        else {
+            message.nodeFailure = undefined;
+        }
+        if (object.migration !== undefined && object.migration !== null) {
+            message.migration = Boolean(object.migration);
+        }
+        else {
+            message.migration = undefined;
+        }
+        if (object.serverLeave !== undefined && object.serverLeave !== null) {
+            message.serverLeave = Boolean(object.serverLeave);
+        }
+        else {
+            message.serverLeave = undefined;
+        }
+        return message;
+    },
+    toJSON(message) {
+        const obj = {};
+        message.speakerUpdate !== undefined &&
+            (obj.speakerUpdate = message.speakerUpdate);
+        message.nodeFailure !== undefined &&
+            (obj.nodeFailure = message.nodeFailure);
+        message.migration !== undefined && (obj.migration = message.migration);
+        message.serverLeave !== undefined &&
+            (obj.serverLeave = message.serverLeave);
+        return obj;
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d;
+        const message = Object.assign({}, baseSimulateScenario);
+        message.speakerUpdate = (_a = object.speakerUpdate) !== null && _a !== void 0 ? _a : undefined;
+        message.nodeFailure = (_b = object.nodeFailure) !== null && _b !== void 0 ? _b : undefined;
+        message.migration = (_c = object.migration) !== null && _c !== void 0 ? _c : undefined;
+        message.serverLeave = (_d = object.serverLeave) !== null && _d !== void 0 ? _d : undefined;
+        return message;
+    },
+};
 if (minimal_1.default.util.Long !== long_1.default) {
     minimal_1.default.util.Long = long_1.default;
     minimal_1.default.configure();