livekit-client 0.14.3 → 0.15.3

package/dist/index.js

@@ -25,11 +25,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VideoQuality = exports.TrackPublication = exports.RemoteTrackPublication = exports.RemoteVideoTrack = exports.RemoteAudioTrack = exports.LocalTrackPublication = exports.LocalTrack = exports.LocalVideoTrack = exports.LocalAudioTrack = exports.LocalParticipant = exports.RemoteParticipant = exports.Participant = exports.ConnectionQuality = exports.DataPacket_Kind = exports.RoomState = exports.Room = void 0;
+exports.VideoQuality = exports.TrackPublication = exports.RemoteTrackPublication = exports.RemoteVideoTrack = exports.RemoteAudioTrack = exports.RemoteTrack = exports.LocalTrackPublication = exports.LocalTrack = exports.LocalVideoTrack = exports.LocalAudioTrack = exports.LocalParticipant = exports.RemoteParticipant = exports.Participant = exports.ConnectionQuality = exports.DataPacket_Kind = exports.RoomState = exports.Room = exports.setLogLevel = void 0;
+const logger_1 = require("./logger");
+Object.defineProperty(exports, "setLogLevel", { enumerable: true, get: function () { return logger_1.setLogLevel; } });
 const livekit_models_1 = require("./proto/livekit_models");
 Object.defineProperty(exports, "DataPacket_Kind", { enumerable: true, get: function () { return livekit_models_1.DataPacket_Kind; } });
-const livekit_rtc_1 = require("./proto/livekit_rtc");
-Object.defineProperty(exports, "VideoQuality", { enumerable: true, get: function () { return livekit_rtc_1.VideoQuality; } });
+Object.defineProperty(exports, "VideoQuality", { enumerable: true, get: function () { return livekit_models_1.VideoQuality; } });
 const LocalParticipant_1 = __importDefault(require("./room/participant/LocalParticipant"));
 exports.LocalParticipant = LocalParticipant_1.default;
 const Participant_1 = __importStar(require("./room/participant/Participant"));
@@ -50,12 +51,14 @@ const LocalVideoTrack_1 = __importDefault(require("./room/track/LocalVideoTrack"
 exports.LocalVideoTrack = LocalVideoTrack_1.default;
 const RemoteAudioTrack_1 = __importDefault(require("./room/track/RemoteAudioTrack"));
 exports.RemoteAudioTrack = RemoteAudioTrack_1.default;
+const RemoteTrack_1 = __importDefault(require("./room/track/RemoteTrack"));
+exports.RemoteTrack = RemoteTrack_1.default;
 const RemoteTrackPublication_1 = __importDefault(require("./room/track/RemoteTrackPublication"));
 exports.RemoteTrackPublication = RemoteTrackPublication_1.default;
 const RemoteVideoTrack_1 = __importDefault(require("./room/track/RemoteVideoTrack"));
 exports.RemoteVideoTrack = RemoteVideoTrack_1.default;
-const TrackPublication_1 = __importDefault(require("./room/track/TrackPublication"));
-exports.TrackPublication = TrackPublication_1.default;
+const TrackPublication_1 = require("./room/track/TrackPublication");
+Object.defineProperty(exports, "TrackPublication", { enumerable: true, get: function () { return TrackPublication_1.TrackPublication; } });
 __exportStar(require("./connect"), exports);
 __exportStar(require("./options"), exports);
 __exportStar(require("./room/errors"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAAyD;AA2BvD,gGA3BO,gCAAe,OA2BP;AA1BjB,qDAAmD;AAuCjD,6FAvCO,0BAAY,OAuCP;AAtCd,2FAAmE;AA6BjE,2BA7BK,0BAAgB,CA6BL;AA5BlB,8EAAgF;AA0B9E,sBA1BK,qBAAW,CA0BL;AADX,kGAzBoB,+BAAiB,OAyBpB;AAxBnB,6FAAqE;AA0BnE,4BA1BK,2BAAiB,CA0BL;AAzBnB,oDAA8C;AAoB5C,eApBK,cAAI,CAoBL;AACJ,0FArBa,gBAAS,OAqBb;AApBX,mFAA2D;AA0BzD,0BA1BK,yBAAe,CA0BL;AAzBjB,yEAAiD;AA2B/C,qBA3BK,oBAAU,CA2BL;AA1BZ,+FAAuE;AA2BrE,gCA3BK,+BAAqB,CA2BL;AA1BvB,mFAA2D;AAwBzD,0BAxBK,yBAAe,CAwBL;AAvBjB,qFAA6D;AA0B3D,2BA1BK,0BAAgB,CA0BL;AAzBlB,iGAAyE;AA2BvE,iCA3BK,gCAAsB,CA2BL;AA1BxB,qFAA6D;AAyB3D,2BAzBK,0BAAgB,CAyBL;AAxBlB,qFAA6D;AA0B3D,2BA1BK,0BAAgB,CA0BL;AAxBlB,4CAA0B;AAC1B,4CAA0B;AAC1B,gDAA8B;AAC9B,gDAA8B;AAC9B,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAuC;AA2BrC,4FA3BO,oBAAW,OA2BP;AA1Bb,2DAAuE;AA6BrE,gGA7BO,gCAAe,OA6BP;AAef,6FA5CwB,6BAAY,OA4CxB;AA3Cd,2FAAmE;AAgCjE,2BAhCK,0BAAgB,CAgCL;AA/BlB,8EAAgF;AA6B9E,sBA7BK,qBAAW,CA6BL;AADX,kGA5BoB,+BAAiB,OA4BpB;AA1BnB,6FAAqE;AA4BnE,4BA5BK,2BAAiB,CA4BL;AA3BnB,oDAA8C;AAsB5C,eAtBK,cAAI,CAsBL;AACJ,0FAvBa,gBAAS,OAuBb;AAtBX,mFAA2D;AA4BzD,0BA5BK,yBAAe,CA4BL;AA3BjB,yEAAiD;AA6B/C,qBA7BK,oBAAU,CA6BL;AA5BZ,+FAAuE;AA6BrE,gCA7BK,+BAAqB,CA6BL;AA5BvB,mFAA2D;AA0BzD,0BA1BK,yBAAe,CA0BL;AAzBjB,qFAA6D;AA6B3D,2BA7BK,0BAAgB,CA6BL;AA5BlB,2EAAmD;AA2BjD,sBA3BK,qBAAW,CA2BL;AA1Bb,iGAAyE;AA6BvE,iCA7BK,gCAAsB,CA6BL;AA5BxB,qFAA6D;AA2B3D,2BA3BK,0BAAgB,CA2BL;AA1BlB,oEAAiE;AA6B/D,iGA7BO,mCAAgB,OA6BP;AA3BlB,4CAA0B;AAC1B,4CAA0B;AAC1B,gDAA8B;AAC9B,gDAA8B;AAC9B,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC;AACnC,qDAAmC;AACnC,4CAA0B"}

package/dist/logger.d.ts

@@ -1,3 +1,13 @@
 import log from 'loglevel';
+export declare type LogLevelDesc = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent';
+export declare enum LogLevel {
+    trace = "trace",
+    debug = "debug",
+    info = "info",
+    warn = "warn",
+    error = "error",
+    silent = "silent"
+}
 declare const livekitLogger: log.Logger;
 export default livekitLogger;
+export declare function setLogLevel(level: LogLevel | LogLevelDesc): void;

package/dist/logger.js

@@ -3,7 +3,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLogLevel = exports.LogLevel = void 0;
 const loglevel_1 = __importDefault(require("loglevel"));
+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 = {}));
 const livekitLogger = loglevel_1.default.getLogger('livekit');
+livekitLogger.setLevel(LogLevel.info);
 exports.default = livekitLogger;
+function setLogLevel(level) {
+    livekitLogger.setLevel(level);
+}
+exports.setLogLevel = setLogLevel;
 //# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;AAAA,wDAA2B;AAE3B,MAAM,aAAa,GAAG,kBAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AAE/C,kBAAe,aAAa,CAAC"}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA2B;AAI3B,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;AAED,MAAM,aAAa,GAAG,kBAAG,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AAE/C,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEtC,kBAAe,aAAa,CAAC;AAE7B,SAAgB,WAAW,CAAC,KAA8B;IACxD,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAFD,kCAEC"}

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,15 @@ 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,
+    OFF = 3,
+    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 +45,7 @@ export interface Room {
     enabledCodecs: Codec[];
     metadata: string;
     numParticipants: number;
+    activeRecording: boolean;
 }
 export interface Codec {
     mime: string;
@@ -49,8 +59,9 @@ export interface ParticipantInfo {
     metadata: string;
     /** timestamp when participant joined room, in seconds */
     joinedAt: number;
-    /** hidden participant (used for recording) */
     hidden: boolean;
+    recorder: boolean;
+    name: string;
 }
 export declare enum ParticipantInfo_State {
     /** JOINING - websocket' connected, but not offered yet */
@@ -83,6 +94,20 @@ export interface TrackInfo {
     disableDtx: boolean;
     /** source of media */
     source: TrackSource;
+    layers: VideoLayer[];
+    /** mime type of codec */
+    mimeType: string;
+    mid: string;
+}
+/** 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;
+    ssrc: number;
 }
 /** new DataPacket API */
 export interface DataPacket {
@@ -115,6 +140,11 @@ export interface UserPacket {
     /** the ID of the participants who will receive the message (the message will be sent to all the people in the room if this variable is empty) */
     destinationSids: string[];
 }
+export interface ParticipantTracks {
+    /** participant ID of participant to whom the tracks belong */
+    participantSid: string;
+    trackSids: string[];
+}
 export declare const Room: {
     encode(message: Room, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number | undefined): Room;
@@ -143,6 +173,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;
@@ -171,6 +208,13 @@ export declare const UserPacket: {
     toJSON(message: UserPacket): unknown;
     fromPartial(object: DeepPartial<UserPacket>): UserPacket;
 };
+export declare const ParticipantTracks: {
+    encode(message: ParticipantTracks, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ParticipantTracks;
+    fromJSON(object: any): ParticipantTracks;
+    toJSON(message: ParticipantTracks): unknown;
+    fromPartial(object: DeepPartial<ParticipantTracks>): ParticipantTracks;
+};
 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]>;