livekit-server-sdk 1.1.3 → 1.2.0

package/README.md

@@ -1,6 +1,14 @@
+<!--BEGIN_BANNER_IMAGE-->
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="/.github/banner_dark.png">
+    <source media="(prefers-color-scheme: light)" srcset="/.github/banner_light.png">
+    <img style="width:100%;" alt="The LiveKit icon, the name of the repository and some sample code in the background." src="/.github/banner_light.png">
+  </picture>
+  <!--END_BANNER_IMAGE-->
+
 # LiveKit Server API for JS
 
-Javascript/Typescript APIs to manage rooms and to create access tokens. This library is designed to work with [livekit-server](https://github.com/livekit/livekit-server). Use it with a Node.js backend to manage access to LiveKit.
+<!--BEGIN_DESCRIPTION-->Use this SDK to manage <a href="https://livekit.io/">LiveKit</a> rooms and create access tokens from your JavaScript/Node.js backend.<!--END_DESCRIPTION-->
 
 ## Installation
 
@@ -114,6 +122,8 @@ svc.deleteRoom('myroom').then(() => {
 
 The JS SDK also provides helper functions to decode and verify webhook callbacks. While verification is optional, it ensures the authenticity of the message. See [webhooks guide](https://docs.livekit.io/guides/webhooks) for details.
 
+LiveKit POSTs to webhook endpoints with `Content-Type: application/webhook+json`. Please ensure your server is able to receive POST body with that MIME.
+
 Check out [example projects](examples) for full examples of webhooks integration.
 
 ```typescript
@@ -130,3 +140,17 @@ app.post('/webhook-endpoint', (req, res) => {
   const event = receiver.receive(req.body, req.get('Authorization'));
 });
 ```
+
+<!--BEGIN_REPO_NAV-->
+
+<br/><table>
+
+<thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
+<tbody>
+<tr><td>Client SDKs</td><td><a href="https://github.com/livekit/components-js">Components</a> · <a href="https://github.com/livekit/client-sdk-js">JavaScript</a> · <a href="https://github.com/livekit/client-sdk-rust">Rust</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (web)</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native (beta)</a></td></tr><tr></tr>
+<tr><td>Server SDKs</td><td><b>Node.js</b> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/tradablebits/livekit-server-sdk-python">Python (community)</a></td></tr><tr></tr>
+<tr><td>Services</td><td><a href="https://github.com/livekit/livekit">Livekit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a></td></tr><tr></tr>
+<tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/oss/deployment">Self-hosting</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr>
+</tbody>
+</table>
+<!--END_REPO_NAV-->

package/dist/AccessToken.d.ts

@@ -0,0 +1,56 @@
+import { ClaimGrants, VideoGrant } from './grants';
+export interface AccessTokenOptions {
+    /**
+     * amount of time before expiration
+     * expressed in seconds or a string describing a time span zeit/ms.
+     * eg: '2 days', '10h', or seconds as numeric value
+     */
+    ttl?: number | string;
+    /**
+     * display name for the participant, available as `Participant.name`
+     */
+    name?: string;
+    /**
+     * identity of the user, required for room join tokens
+     */
+    identity?: string;
+    /**
+     * custom metadata to be passed to participants
+     */
+    metadata?: string;
+}
+export declare class AccessToken {
+    private apiKey;
+    private apiSecret;
+    private grants;
+    identity?: string;
+    ttl?: number | string;
+    /**
+     * Creates a new AccessToken
+     * @param apiKey API Key, can be set in env LIVEKIT_API_KEY
+     * @param apiSecret Secret, can be set in env LIVEKIT_API_SECRET
+     */
+    constructor(apiKey?: string, apiSecret?: string, options?: AccessTokenOptions);
+    /**
+     * Adds a video grant to this token.
+     * @param grant
+     */
+    addGrant(grant: VideoGrant): void;
+    /**
+     * Set metadata to be passed to the Participant, used only when joining the room
+     */
+    set metadata(md: string);
+    set name(name: string);
+    get sha256(): string | undefined;
+    set sha256(sha: string | undefined);
+    /**
+     * @returns JWT encoded token
+     */
+    toJwt(): string;
+}
+export declare class TokenVerifier {
+    private apiKey;
+    private apiSecret;
+    constructor(apiKey: string, apiSecret: string);
+    verify(token: string): ClaimGrants;
+}

package/dist/AccessToken.js

@@ -0,0 +1,118 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenVerifier = exports.AccessToken = void 0;
+const jwt = __importStar(require("jsonwebtoken"));
+// 6 hours
+const defaultTTL = 6 * 60 * 60;
+class AccessToken {
+    /**
+     * Creates a new AccessToken
+     * @param apiKey API Key, can be set in env LIVEKIT_API_KEY
+     * @param apiSecret Secret, can be set in env LIVEKIT_API_SECRET
+     */
+    constructor(apiKey, apiSecret, options) {
+        if (!apiKey) {
+            apiKey = process.env.LIVEKIT_API_KEY;
+        }
+        if (!apiSecret) {
+            apiSecret = process.env.LIVEKIT_API_SECRET;
+        }
+        if (!apiKey || !apiSecret) {
+            throw Error('api-key and api-secret must be set');
+        }
+        else if (typeof document !== 'undefined') {
+            // check against document rather than window because deno provides window
+            console.error('You should not include your API secret in your web client bundle.\n\n' +
+                'Your web client should request a token from your backend server which should then use ' +
+                'the API secret to generate a token. See https://docs.livekit.io/client/connect/');
+        }
+        this.apiKey = apiKey;
+        this.apiSecret = apiSecret;
+        this.grants = {};
+        this.identity = options === null || options === void 0 ? void 0 : options.identity;
+        this.ttl = (options === null || options === void 0 ? void 0 : options.ttl) || defaultTTL;
+        if (options === null || options === void 0 ? void 0 : options.metadata) {
+            this.metadata = options.metadata;
+        }
+        if (options === null || options === void 0 ? void 0 : options.name) {
+            this.name = options.name;
+        }
+    }
+    /**
+     * Adds a video grant to this token.
+     * @param grant
+     */
+    addGrant(grant) {
+        this.grants.video = grant;
+    }
+    /**
+     * Set metadata to be passed to the Participant, used only when joining the room
+     */
+    set metadata(md) {
+        this.grants.metadata = md;
+    }
+    set name(name) {
+        this.grants.name = name;
+    }
+    get sha256() {
+        return this.grants.sha256;
+    }
+    set sha256(sha) {
+        this.grants.sha256 = sha;
+    }
+    /**
+     * @returns JWT encoded token
+     */
+    toJwt() {
+        // TODO: check for video grant validity
+        var _a;
+        const opts = {
+            issuer: this.apiKey,
+            expiresIn: this.ttl,
+            notBefore: 0,
+        };
+        if (this.identity) {
+            opts.subject = this.identity;
+            opts.jwtid = this.identity;
+        }
+        else if ((_a = this.grants.video) === null || _a === void 0 ? void 0 : _a.roomJoin) {
+            throw Error('identity is required for join but not set');
+        }
+        return jwt.sign(this.grants, this.apiSecret, opts);
+    }
+}
+exports.AccessToken = AccessToken;
+class TokenVerifier {
+    constructor(apiKey, apiSecret) {
+        this.apiKey = apiKey;
+        this.apiSecret = apiSecret;
+    }
+    verify(token) {
+        const decoded = jwt.verify(token, this.apiSecret, { issuer: this.apiKey });
+        if (!decoded) {
+            throw Error('invalid token');
+        }
+        return decoded;
+    }
+}
+exports.TokenVerifier = TokenVerifier;
+//# sourceMappingURL=AccessToken.js.map

package/dist/AccessToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessToken.js","sourceRoot":"","sources":["../src/AccessToken.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAoC;AAGpC,UAAU;AACV,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC;AA0B/B,MAAa,WAAW;IAWtB;;;;OAIG;IACH,YAAY,MAAe,EAAE,SAAkB,EAAE,OAA4B;QAC3E,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;SACtC;QACD,IAAI,CAAC,SAAS,EAAE;YACd,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;SAC5C;QACD,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE;YACzB,MAAM,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACnD;aAAM,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE;YAC1C,yEAAyE;YACzE,OAAO,CAAC,KAAK,CACX,uEAAuE;gBACrE,wFAAwF;gBACxF,iFAAiF,CACpF,CAAC;SACH;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC;QAClC,IAAI,CAAC,GAAG,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,KAAI,UAAU,CAAC;QACtC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE;YACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;SAClC;QACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;YACjB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;SAC1B;IACH,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,KAAiB;QACxB,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ,CAAC,EAAU;QACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,IAAY;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,IAAI,MAAM,CAAC,GAAuB;QAChC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,uCAAuC;;QAEvC,MAAM,IAAI,GAAoB;YAC5B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,SAAS,EAAE,IAAI,CAAC,GAAG;YACnB,SAAS,EAAE,CAAC;SACb,CAAC;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC;SAC5B;aAAM,IAAI,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,0CAAE,QAAQ,EAAE;YACtC,MAAM,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC1D;QACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;CACF;AA7FD,kCA6FC;AAED,MAAa,aAAa;IAKxB,YAAY,MAAc,EAAE,SAAiB;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,KAAa;QAClB,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,KAAK,CAAC,eAAe,CAAC,CAAC;SAC9B;QAED,OAAO,OAAsB,CAAC;IAChC,CAAC;CACF;AAlBD,sCAkBC"}

package/dist/AccessToken.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/AccessToken.test.js

@@ -0,0 +1,72 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jwt = __importStar(require("jsonwebtoken"));
+const AccessToken_1 = require("./AccessToken");
+const testApiKey = 'abcdefg';
+const testSecret = 'abababa';
+describe('encoded tokens are valid', () => {
+    const t = new AccessToken_1.AccessToken(testApiKey, testSecret, {
+        identity: 'me',
+        name: 'myname',
+    });
+    t.addGrant({ room: 'myroom' });
+    const token = t.toJwt();
+    const decoded = jwt.verify(token, testSecret, { jwtid: 'me' });
+    it('can be decoded', () => {
+        expect(decoded).not.toBe(undefined);
+    });
+    it('has name set', () => {
+        expect(decoded.name).toBe('myname');
+    });
+    it('has video grants set', () => {
+        expect(decoded.video).toBeTruthy();
+        expect(decoded.video.room).toEqual('myroom');
+    });
+});
+describe('identity is required for only join grants', () => {
+    it('allows empty identity for create', () => {
+        const t = new AccessToken_1.AccessToken(testApiKey, testSecret);
+        t.addGrant({ roomCreate: true });
+        expect(t.toJwt()).toBeTruthy();
+    });
+    it('throws error when identity is not provided for join', () => {
+        const t = new AccessToken_1.AccessToken(testApiKey, testSecret);
+        t.addGrant({ roomJoin: true });
+        expect(() => {
+            t.toJwt();
+        }).toThrow();
+    });
+});
+describe('verify token is valid', () => {
+    it('can decode encoded token', () => {
+        var _a;
+        const t = new AccessToken_1.AccessToken(testApiKey, testSecret);
+        t.sha256 = 'abcdefg';
+        t.addGrant({ roomCreate: true });
+        const v = new AccessToken_1.TokenVerifier(testApiKey, testSecret);
+        const decoded = v.verify(t.toJwt());
+        expect(decoded).not.toBe(undefined);
+        expect(decoded.sha256).toEqual('abcdefg');
+        expect((_a = decoded.video) === null || _a === void 0 ? void 0 : _a.roomCreate).toBeTruthy();
+    });
+});
+//# sourceMappingURL=AccessToken.test.js.map

package/dist/AccessToken.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccessToken.test.js","sourceRoot":"","sources":["../src/AccessToken.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,kDAAoC;AACpC,+CAA2D;AAE3D,MAAM,UAAU,GAAG,SAAS,CAAC;AAC7B,MAAM,UAAU,GAAG,SAAS,CAAC;AAE7B,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,CAAC,GAAG,IAAI,yBAAW,CAAC,UAAU,EAAE,UAAU,EAAE;QAChD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;KACf,CAAC,CAAC;IACH,CAAC,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAExB,MAAM,OAAO,GAAQ,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpE,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACtB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACzD,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,GAAG,IAAI,yBAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAClD,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,GAAG,IAAI,yBAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAClD,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/B,MAAM,CAAC,GAAG,EAAE;YACV,CAAC,CAAC,KAAK,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;;QAClC,MAAM,CAAC,GAAG,IAAI,yBAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAClD,CAAC,CAAC,MAAM,GAAG,SAAS,CAAC;QACrB,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QAEjC,MAAM,CAAC,GAAG,IAAI,2BAAa,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAEpC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAA,OAAO,CAAC,KAAK,0CAAE,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/EgressClient.d.ts

@@ -0,0 +1,128 @@
+import { DirectFileOutput, EgressInfo, EncodedFileOutput, EncodingOptions, EncodingOptionsPreset, SegmentedFileOutput, StreamOutput } from './proto/livekit_egress';
+import ServiceBase from './ServiceBase';
+export interface RoomCompositeOptions {
+    /**
+     * egress layout. optional
+     */
+    layout?: string;
+    /**
+     * encoding options or preset. optional
+     */
+    encodingOptions?: EncodingOptionsPreset | EncodingOptions;
+    /**
+     * record audio only. optional
+     */
+    audioOnly?: boolean;
+    /**
+     * record video only. optional
+     */
+    videoOnly?: boolean;
+    /**
+     * custom template url. optional
+     */
+    customBaseUrl?: string;
+}
+export interface WebOptions {
+    /**
+     * encoding options or preset. optional
+     */
+    encodingOptions?: EncodingOptionsPreset | EncodingOptions;
+    /**
+     * record audio only. optional
+     */
+    audioOnly?: boolean;
+    /**
+     * record video only. optional
+     */
+    videoOnly?: boolean;
+}
+export interface TrackCompositeOptions {
+    /**
+     * audio track ID
+     */
+    audioTrackId?: string;
+    /**
+     * video track ID
+     */
+    videoTrackId?: string;
+    /**
+     * encoding options or preset. optional
+     */
+    encodingOptions?: EncodingOptionsPreset | EncodingOptions;
+}
+/**
+ * Used to supply multiple outputs with an egress request
+ */
+export interface EncodedOutputs {
+    file?: EncodedFileOutput | undefined;
+    stream?: StreamOutput | undefined;
+    segments?: SegmentedFileOutput | undefined;
+}
+/**
+ * Client to access Egress APIs
+ */
+export declare class EgressClient extends ServiceBase {
+    private readonly rpc;
+    /**
+     * @param host hostname including protocol. i.e. 'https://cluster.livekit.io'
+     * @param apiKey API Key, can be set in env var LIVEKIT_API_KEY
+     * @param secret API Secret, can be set in env var LIVEKIT_API_SECRET
+     */
+    constructor(host: string, apiKey?: string, secret?: string);
+    /**
+     * @param roomName room name
+     * @param output file or stream output
+     * @param opts RoomCompositeOptions
+     */
+    startRoomCompositeEgress(roomName: string, output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput, opts?: RoomCompositeOptions): Promise<EgressInfo>;
+    /**
+     * @deprecated use RoomCompositeOptions instead
+     */
+    startRoomCompositeEgress(roomName: string, output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput, layout?: string, options?: EncodingOptionsPreset | EncodingOptions, audioOnly?: boolean, videoOnly?: boolean, customBaseUrl?: string): Promise<EgressInfo>;
+    /**
+     * @param url url
+     * @param output file or stream output
+     * @param opts WebOptions
+     */
+    startWebEgress(url: string, output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput, opts?: WebOptions): Promise<EgressInfo>;
+    /**
+     * @param roomName room name
+     * @param output file or stream output
+     * @param opts TrackCompositeOptions
+     */
+    startTrackCompositeEgress(roomName: string, output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput, opts?: TrackCompositeOptions): Promise<EgressInfo>;
+    /**
+     * @deprecated use TrackCompositeOptions instead
+     */
+    startTrackCompositeEgress(roomName: string, output: EncodedOutputs | EncodedFileOutput | StreamOutput | SegmentedFileOutput, audioTrackId?: string, videoTrackId?: string, options?: EncodingOptionsPreset | EncodingOptions): Promise<EgressInfo>;
+    private isEncodedOutputs;
+    private isEncodedFileOutput;
+    private isSegmentedFileOutput;
+    private isStreamOutput;
+    private getOutputParams;
+    /**
+     * @param roomName room name
+     * @param output file or websocket output
+     * @param trackId track Id
+     */
+    startTrackEgress(roomName: string, output: DirectFileOutput | string, trackId: string): Promise<EgressInfo>;
+    /**
+     * @param egressId
+     * @param layout
+     */
+    updateLayout(egressId: string, layout: string): Promise<EgressInfo>;
+    /**
+     * @param egressId
+     * @param addOutputUrls
+     * @param removeOutputUrls
+     */
+    updateStream(egressId: string, addOutputUrls?: string[], removeOutputUrls?: string[]): Promise<EgressInfo>;
+    /**
+     * @param roomName list egress for one room only
+     */
+    listEgress(roomName?: string): Promise<Array<EgressInfo>>;
+    /**
+     * @param egressId
+     */
+    stopEgress(egressId: string): Promise<EgressInfo>;
+}