livekit-client 0.14.1 → 0.15.1

package/dist/options.d.ts

@@ -1,4 +1,59 @@
-import { CreateLocalTracksOptions, TrackCaptureDefaults, TrackPublishDefaults } from './room/track/options';
+import { LogLevel, LogLevelDesc } from './logger';
+import { AudioCaptureOptions, CreateLocalTracksOptions, TrackPublishDefaults, VideoCaptureOptions } from './room/track/options';
+/**
+ * Options for when creating a new room
+ */
+export interface RoomOptions {
+    /**
+     * 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?: 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?: 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;
+    /**
+     * 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;
+    /**
+     * @internal
+     * experimental flag, disable client managed layer pause when publishing capability is limited
+     */
+    expDisableLayerPause?: boolean;
+}
+/**
+ * Options for Room.connect()
+ */
+export interface RoomConnectOptions {
+    /** autosubscribe to room tracks after joining, defaults to true */
+    autoSubscribe?: boolean;
+    /**
+     * use to override any RTCConfiguration options.
+     */
+    rtcConfig?: RTCConfiguration;
+}
 /**
  * if video or audio tracks are created as part of [[connect]], it'll automatically
  * publish those tracks to the room.
@@ -7,17 +62,20 @@ export interface ConnectOptions extends CreateLocalTracksOptions {
     /** autosubscribe to room tracks upon connect, defaults to true */
     autoSubscribe?: boolean;
     /**
-     * automatically manage quality of subscribed video tracks, subscribe to the
-     * an appropriate resolution based on the size of the video elements that tracks
-     * are attached to.
-     *
-     * also observes the visibility of attached tracks and pauses receiving data
-     * if they are not visible.
-     *
+     * see [[RoomOptions.adaptiveStream]]
+     */
+    adaptiveStream?: boolean;
+    /**
+     * alias for adaptiveStream
+     * @deprecated
      */
     autoManageVideo?: boolean;
+    /**
+     * see [[RoomOptions.dynacast]]
+     */
+    dynacast?: boolean;
     /** configures LiveKit internal log level */
-    logLevel?: LogLevel;
+    logLevel?: LogLevel | LogLevelDesc;
     /**
      * set ICE servers. When deployed correctly, LiveKit automatically uses the built-in TURN servers
      */
@@ -39,19 +97,25 @@ export interface ConnectOptions extends CreateLocalTracksOptions {
      */
     video?: boolean;
     /**
-     * default options to use when capturing user media
+     * default options to use when capturing user's audio
+     */
+    audioCaptureDefaults?: AudioCaptureOptions;
+    /**
+     * default options to use when capturing user's video
      */
-    captureDefaults?: TrackCaptureDefaults;
+    videoCaptureDefaults?: VideoCaptureOptions;
     /**
      * default options to use when publishing tracks
      */
     publishDefaults?: TrackPublishDefaults;
-}
-export declare enum LogLevel {
-    trace = "trace",
-    debug = "debug",
-    info = "info",
-    warn = "warn",
-    error = "error",
-    silent = "silent"
+    /**
+     * 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;
+    /**
+     * @internal
+     * experimental flag, disable client managed layer pause when publishing capability is limited
+     */
+    expDisableLayerPause?: boolean;
 }

package/dist/options.js

@@ -1,13 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = void 0;
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["trace"] = "trace";
-    LogLevel["debug"] = "debug";
-    LogLevel["info"] = "info";
-    LogLevel["warn"] = "warn";
-    LogLevel["error"] = "error";
-    LogLevel["silent"] = "silent";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 //# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";;;AA6DA,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,6BAAiB,CAAA;AACnB,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB"}
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":""}

package/dist/proto/livekit_models.d.ts

@@ -18,6 +18,14 @@ export declare enum TrackSource {
 }
 export declare function trackSourceFromJSON(object: any): TrackSource;
 export declare function trackSourceToJSON(object: TrackSource): string;
+export declare enum VideoQuality {
+    LOW = 0,
+    MEDIUM = 1,
+    HIGH = 2,
+    UNRECOGNIZED = -1
+}
+export declare function videoQualityFromJSON(object: any): VideoQuality;
+export declare function videoQualityToJSON(object: VideoQuality): string;
 export declare enum ConnectionQuality {
     POOR = 0,
     GOOD = 1,
@@ -36,6 +44,7 @@ export interface Room {
     enabledCodecs: Codec[];
     metadata: string;
     numParticipants: number;
+    activeRecording: boolean;
 }
 export interface Codec {
     mime: string;
@@ -49,8 +58,8 @@ export interface ParticipantInfo {
     metadata: string;
     /** timestamp when participant joined room, in seconds */
     joinedAt: number;
-    /** hidden participant (used for recording) */
     hidden: boolean;
+    recorder: boolean;
 }
 export declare enum ParticipantInfo_State {
     /** JOINING - websocket' connected, but not offered yet */
@@ -83,6 +92,16 @@ export interface TrackInfo {
     disableDtx: boolean;
     /** source of media */
     source: TrackSource;
+    layers: VideoLayer[];
+}
+/** provide information about available spatial layers */
+export interface VideoLayer {
+    /** for tracks with a single layer, this should be HIGH */
+    quality: VideoQuality;
+    width: number;
+    height: number;
+    /** target bitrate, server will measure actual */
+    bitrate: number;
 }
 /** new DataPacket API */
 export interface DataPacket {
@@ -143,6 +162,13 @@ export declare const TrackInfo: {
     toJSON(message: TrackInfo): unknown;
     fromPartial(object: DeepPartial<TrackInfo>): TrackInfo;
 };
+export declare const VideoLayer: {
+    encode(message: VideoLayer, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): VideoLayer;
+    fromJSON(object: any): VideoLayer;
+    toJSON(message: VideoLayer): unknown;
+    fromPartial(object: DeepPartial<VideoLayer>): VideoLayer;
+};
 export declare const DataPacket: {
     encode(message: DataPacket, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): DataPacket;

package/dist/proto/livekit_models.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.UserPacket = exports.SpeakerInfo = exports.ActiveSpeakerUpdate = exports.DataPacket = exports.TrackInfo = exports.ParticipantInfo = exports.Codec = exports.Room = exports.dataPacket_KindToJSON = exports.dataPacket_KindFromJSON = exports.DataPacket_Kind = exports.participantInfo_StateToJSON = exports.participantInfo_StateFromJSON = exports.ParticipantInfo_State = exports.connectionQualityToJSON = exports.connectionQualityFromJSON = exports.ConnectionQuality = exports.trackSourceToJSON = exports.trackSourceFromJSON = exports.TrackSource = exports.trackTypeToJSON = exports.trackTypeFromJSON = exports.TrackType = exports.protobufPackage = void 0;
+exports.UserPacket = exports.SpeakerInfo = exports.ActiveSpeakerUpdate = exports.DataPacket = exports.VideoLayer = exports.TrackInfo = exports.ParticipantInfo = exports.Codec = exports.Room = exports.dataPacket_KindToJSON = exports.dataPacket_KindFromJSON = exports.DataPacket_Kind = exports.participantInfo_StateToJSON = exports.participantInfo_StateFromJSON = exports.ParticipantInfo_State = exports.connectionQualityToJSON = exports.connectionQualityFromJSON = exports.ConnectionQuality = exports.videoQualityToJSON = exports.videoQualityFromJSON = exports.VideoQuality = exports.trackSourceToJSON = exports.trackSourceFromJSON = exports.TrackSource = exports.trackTypeToJSON = exports.trackTypeFromJSON = exports.TrackType = exports.protobufPackage = void 0;
 /* eslint-disable */
 const long_1 = __importDefault(require("long"));
 const minimal_1 = __importDefault(require("protobufjs/minimal"));
@@ -96,6 +96,44 @@ function trackSourceToJSON(object) {
     }
 }
 exports.trackSourceToJSON = trackSourceToJSON;
+var VideoQuality;
+(function (VideoQuality) {
+    VideoQuality[VideoQuality["LOW"] = 0] = "LOW";
+    VideoQuality[VideoQuality["MEDIUM"] = 1] = "MEDIUM";
+    VideoQuality[VideoQuality["HIGH"] = 2] = "HIGH";
+    VideoQuality[VideoQuality["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(VideoQuality = exports.VideoQuality || (exports.VideoQuality = {}));
+function videoQualityFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "LOW":
+            return VideoQuality.LOW;
+        case 1:
+        case "MEDIUM":
+            return VideoQuality.MEDIUM;
+        case 2:
+        case "HIGH":
+            return VideoQuality.HIGH;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return VideoQuality.UNRECOGNIZED;
+    }
+}
+exports.videoQualityFromJSON = videoQualityFromJSON;
+function videoQualityToJSON(object) {
+    switch (object) {
+        case VideoQuality.LOW:
+            return "LOW";
+        case VideoQuality.MEDIUM:
+            return "MEDIUM";
+        case VideoQuality.HIGH:
+            return "HIGH";
+        default:
+            return "UNKNOWN";
+    }
+}
+exports.videoQualityToJSON = videoQualityToJSON;
 var ConnectionQuality;
 (function (ConnectionQuality) {
     ConnectionQuality[ConnectionQuality["POOR"] = 0] = "POOR";
@@ -223,6 +261,7 @@ const baseRoom = {
     turnPassword: "",
     metadata: "",
     numParticipants: 0,
+    activeRecording: false,
 };
 exports.Room = {
     encode(message, writer = minimal_1.default.Writer.create()) {
@@ -253,6 +292,9 @@ exports.Room = {
         if (message.numParticipants !== 0) {
             writer.uint32(72).uint32(message.numParticipants);
         }
+        if (message.activeRecording === true) {
+            writer.uint32(80).bool(message.activeRecording);
+        }
         return writer;
     },
     decode(input, length) {
@@ -290,6 +332,9 @@ exports.Room = {
                 case 9:
                     message.numParticipants = reader.uint32();
                     break;
+                case 10:
+                    message.activeRecording = reader.bool();
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -355,6 +400,13 @@ exports.Room = {
         else {
             message.numParticipants = 0;
         }
+        if (object.activeRecording !== undefined &&
+            object.activeRecording !== null) {
+            message.activeRecording = Boolean(object.activeRecording);
+        }
+        else {
+            message.activeRecording = false;
+        }
         return message;
     },
     toJSON(message) {
@@ -378,10 +430,12 @@ exports.Room = {
         message.metadata !== undefined && (obj.metadata = message.metadata);
         message.numParticipants !== undefined &&
             (obj.numParticipants = message.numParticipants);
+        message.activeRecording !== undefined &&
+            (obj.activeRecording = message.activeRecording);
         return obj;
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const message = Object.assign({}, baseRoom);
         message.sid = (_a = object.sid) !== null && _a !== void 0 ? _a : "";
         message.name = (_b = object.name) !== null && _b !== void 0 ? _b : "";
@@ -397,6 +451,7 @@ exports.Room = {
         }
         message.metadata = (_g = object.metadata) !== null && _g !== void 0 ? _g : "";
         message.numParticipants = (_h = object.numParticipants) !== null && _h !== void 0 ? _h : 0;
+        message.activeRecording = (_j = object.activeRecording) !== null && _j !== void 0 ? _j : false;
         return message;
     },
 };
@@ -468,6 +523,7 @@ const baseParticipantInfo = {
     metadata: "",
     joinedAt: 0,
     hidden: false,
+    recorder: false,
 };
 exports.ParticipantInfo = {
     encode(message, writer = minimal_1.default.Writer.create()) {
@@ -492,6 +548,9 @@ exports.ParticipantInfo = {
         if (message.hidden === true) {
             writer.uint32(56).bool(message.hidden);
         }
+        if (message.recorder === true) {
+            writer.uint32(64).bool(message.recorder);
+        }
         return writer;
     },
     decode(input, length) {
@@ -523,6 +582,9 @@ exports.ParticipantInfo = {
                 case 7:
                     message.hidden = reader.bool();
                     break;
+                case 8:
+                    message.recorder = reader.bool();
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -574,6 +636,12 @@ exports.ParticipantInfo = {
         else {
             message.hidden = false;
         }
+        if (object.recorder !== undefined && object.recorder !== null) {
+            message.recorder = Boolean(object.recorder);
+        }
+        else {
+            message.recorder = false;
+        }
         return message;
     },
     toJSON(message) {
@@ -591,10 +659,11 @@ exports.ParticipantInfo = {
         message.metadata !== undefined && (obj.metadata = message.metadata);
         message.joinedAt !== undefined && (obj.joinedAt = message.joinedAt);
         message.hidden !== undefined && (obj.hidden = message.hidden);
+        message.recorder !== undefined && (obj.recorder = message.recorder);
         return obj;
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const message = Object.assign({}, baseParticipantInfo);
         message.sid = (_a = object.sid) !== null && _a !== void 0 ? _a : "";
         message.identity = (_b = object.identity) !== null && _b !== void 0 ? _b : "";
@@ -608,6 +677,7 @@ exports.ParticipantInfo = {
         message.metadata = (_d = object.metadata) !== null && _d !== void 0 ? _d : "";
         message.joinedAt = (_e = object.joinedAt) !== null && _e !== void 0 ? _e : 0;
         message.hidden = (_f = object.hidden) !== null && _f !== void 0 ? _f : false;
+        message.recorder = (_g = object.recorder) !== null && _g !== void 0 ? _g : false;
         return message;
     },
 };
@@ -651,12 +721,16 @@ exports.TrackInfo = {
         if (message.source !== 0) {
             writer.uint32(72).int32(message.source);
         }
+        for (const v of message.layers) {
+            exports.VideoLayer.encode(v, writer.uint32(82).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({}, baseTrackInfo);
+        message.layers = [];
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
@@ -687,6 +761,9 @@ exports.TrackInfo = {
                 case 9:
                     message.source = reader.int32();
                     break;
+                case 10:
+                    message.layers.push(exports.VideoLayer.decode(reader, reader.uint32()));
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -696,6 +773,7 @@ exports.TrackInfo = {
     },
     fromJSON(object) {
         const message = Object.assign({}, baseTrackInfo);
+        message.layers = [];
         if (object.sid !== undefined && object.sid !== null) {
             message.sid = String(object.sid);
         }
@@ -750,6 +828,11 @@ exports.TrackInfo = {
         else {
             message.source = 0;
         }
+        if (object.layers !== undefined && object.layers !== null) {
+            for (const e of object.layers) {
+                message.layers.push(exports.VideoLayer.fromJSON(e));
+            }
+        }
         return message;
     },
     toJSON(message) {
@@ -764,6 +847,12 @@ exports.TrackInfo = {
         message.disableDtx !== undefined && (obj.disableDtx = message.disableDtx);
         message.source !== undefined &&
             (obj.source = trackSourceToJSON(message.source));
+        if (message.layers) {
+            obj.layers = message.layers.map((e) => e ? exports.VideoLayer.toJSON(e) : undefined);
+        }
+        else {
+            obj.layers = [];
+        }
         return obj;
     },
     fromPartial(object) {
@@ -778,6 +867,102 @@ exports.TrackInfo = {
         message.simulcast = (_g = object.simulcast) !== null && _g !== void 0 ? _g : false;
         message.disableDtx = (_h = object.disableDtx) !== null && _h !== void 0 ? _h : false;
         message.source = (_j = object.source) !== null && _j !== void 0 ? _j : 0;
+        message.layers = [];
+        if (object.layers !== undefined && object.layers !== null) {
+            for (const e of object.layers) {
+                message.layers.push(exports.VideoLayer.fromPartial(e));
+            }
+        }
+        return message;
+    },
+};
+const baseVideoLayer = { quality: 0, width: 0, height: 0, bitrate: 0 };
+exports.VideoLayer = {
+    encode(message, writer = minimal_1.default.Writer.create()) {
+        if (message.quality !== 0) {
+            writer.uint32(8).int32(message.quality);
+        }
+        if (message.width !== 0) {
+            writer.uint32(16).uint32(message.width);
+        }
+        if (message.height !== 0) {
+            writer.uint32(24).uint32(message.height);
+        }
+        if (message.bitrate !== 0) {
+            writer.uint32(32).uint32(message.bitrate);
+        }
+        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({}, baseVideoLayer);
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    message.quality = reader.int32();
+                    break;
+                case 2:
+                    message.width = reader.uint32();
+                    break;
+                case 3:
+                    message.height = reader.uint32();
+                    break;
+                case 4:
+                    message.bitrate = reader.uint32();
+                    break;
+                default:
+                    reader.skipType(tag & 7);
+                    break;
+            }
+        }
+        return message;
+    },
+    fromJSON(object) {
+        const message = Object.assign({}, baseVideoLayer);
+        if (object.quality !== undefined && object.quality !== null) {
+            message.quality = videoQualityFromJSON(object.quality);
+        }
+        else {
+            message.quality = 0;
+        }
+        if (object.width !== undefined && object.width !== null) {
+            message.width = Number(object.width);
+        }
+        else {
+            message.width = 0;
+        }
+        if (object.height !== undefined && object.height !== null) {
+            message.height = Number(object.height);
+        }
+        else {
+            message.height = 0;
+        }
+        if (object.bitrate !== undefined && object.bitrate !== null) {
+            message.bitrate = Number(object.bitrate);
+        }
+        else {
+            message.bitrate = 0;
+        }
+        return message;
+    },
+    toJSON(message) {
+        const obj = {};
+        message.quality !== undefined &&
+            (obj.quality = videoQualityToJSON(message.quality));
+        message.width !== undefined && (obj.width = message.width);
+        message.height !== undefined && (obj.height = message.height);
+        message.bitrate !== undefined && (obj.bitrate = message.bitrate);
+        return obj;
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d;
+        const message = Object.assign({}, baseVideoLayer);
+        message.quality = (_a = object.quality) !== null && _a !== void 0 ? _a : 0;
+        message.width = (_b = object.width) !== null && _b !== void 0 ? _b : 0;
+        message.height = (_c = object.height) !== null && _c !== void 0 ? _c : 0;
+        message.bitrate = (_d = object.bitrate) !== null && _d !== void 0 ? _d : 0;
         return message;
     },
 };