@voltkit-rtc/client 0.6.1 → 0.7.0

package/dist/esm/errors.js

@@ -0,0 +1,149 @@
+/**
+ * One error registry for every VoltKit SDK (docs/sdk-contract.json): the codes
+ * the controller and the media nodes answer with, passed through unchanged, and
+ * the ones the SDKs raise themselves. Switch on `error.code`, never on the
+ * message.
+ *
+ * Kept as a literal here, since the package cannot read the repository's docs
+ * at runtime, and checked against the contract by
+ * scripts/test/sdk-contract-browser.sh and test/contract.test.mjs. One code per
+ * line, so that check can read it.
+ */
+export const ERROR_CODES = {
+    'bad-json': { origin: 'server', terminal: false, retryable: false },
+    'bad-params': { origin: 'server', terminal: false, retryable: false },
+    'unknown-method': { origin: 'server', terminal: false, retryable: false },
+    'too-many-requests': { origin: 'server', terminal: false, retryable: true },
+    'not-joined': { origin: 'server', terminal: false, retryable: false },
+    'already-joined': { origin: 'server', terminal: false, retryable: false },
+    'internal': { origin: 'server', terminal: false, retryable: true },
+    'node-error': { origin: 'server', terminal: false, retryable: true },
+    'no-token': { origin: 'server', terminal: true, retryable: false },
+    'bad-token': { origin: 'server', terminal: true, retryable: false },
+    'wrong-tenant': { origin: 'server', terminal: true, retryable: false },
+    'token-mismatch': { origin: 'server', terminal: false, retryable: false },
+    'no-room': { origin: 'server', terminal: true, retryable: false },
+    'room-ended': { origin: 'server', terminal: true, retryable: false },
+    'kicked': { origin: 'server', terminal: true, retryable: false },
+    'no-node': { origin: 'server', terminal: false, retryable: true },
+    'no-capacity': { origin: 'server', terminal: false, retryable: true },
+    'stage-full': { origin: 'server', terminal: false, retryable: true },
+    'participant-quota': { origin: 'server', terminal: false, retryable: true },
+    'viewer-quota': { origin: 'server', terminal: false, retryable: true },
+    'quota-exhausted': { origin: 'server', terminal: true, retryable: false },
+    'daily-limit-reached': { origin: 'server', terminal: true, retryable: false },
+    'monthly-limit-reached': { origin: 'server', terminal: true, retryable: false },
+    'tenant-suspended': { origin: 'server', terminal: true, retryable: false },
+    'billing-unavailable': { origin: 'server', terminal: true, retryable: false },
+    'forbidden': { origin: 'server', terminal: true, retryable: false },
+    'not-in-room': { origin: 'server', terminal: false, retryable: false },
+    'no-participant': { origin: 'server', terminal: false, retryable: false },
+    'bad-transport': { origin: 'server', terminal: false, retryable: false },
+    'no-transport': { origin: 'server', terminal: false, retryable: false },
+    'no-producer': { origin: 'server', terminal: false, retryable: false },
+    'no-consumer': { origin: 'server', terminal: false, retryable: false },
+    'cannot-consume': { origin: 'server', terminal: false, retryable: false },
+    'consumer-cap': { origin: 'server', terminal: false, retryable: true },
+    'producer-cap': { origin: 'server', terminal: false, retryable: true },
+    'room-cap': { origin: 'server', terminal: false, retryable: true },
+    'draining': { origin: 'server', terminal: false, retryable: true },
+    'bad-request': { origin: 'server', terminal: false, retryable: false },
+    'source-already-published': { origin: 'server', terminal: false, retryable: false },
+    'force-muted': { origin: 'server', terminal: false, retryable: false },
+    'media-disabled': { origin: 'server', terminal: false, retryable: false },
+    'frame-rate-not-allowed': { origin: 'server', terminal: false, retryable: false },
+    'video-quality-not-allowed': { origin: 'server', terminal: false, retryable: false },
+    'audio-quality-not-allowed': { origin: 'server', terminal: false, retryable: false },
+    'video-not-allowed': { origin: 'server', terminal: false, retryable: false },
+    'audio-not-allowed': { origin: 'server', terminal: false, retryable: false },
+    'video-subscription-limit': { origin: 'server', terminal: false, retryable: false },
+    'slot-taken': { origin: 'server', terminal: false, retryable: false },
+    'slot-blocked': { origin: 'server', terminal: false, retryable: false },
+    'slot-occupied': { origin: 'server', terminal: false, retryable: false },
+    'chat-muted': { origin: 'server', terminal: false, retryable: false },
+    'rate-limited': { origin: 'server', terminal: false, retryable: true },
+    'no-message': { origin: 'server', terminal: false, retryable: false },
+    'chat-unavailable': { origin: 'server', terminal: false, retryable: false },
+    'closed': { origin: 'server', terminal: false, retryable: true },
+    'unauthorized': { origin: 'server', terminal: false, retryable: false },
+    'bad-signature': { origin: 'server', terminal: false, retryable: false },
+    'operator-only': { origin: 'server', terminal: false, retryable: false },
+    'bad-role': { origin: 'server', terminal: false, retryable: false },
+    'room-exists': { origin: 'server', terminal: false, retryable: false },
+    'room-quota': { origin: 'server', terminal: false, retryable: true },
+    'no-nodes': { origin: 'server', terminal: false, retryable: true },
+    'capacity-exhausted': { origin: 'server', terminal: false, retryable: true },
+    'unavailable': { origin: 'server', terminal: false, retryable: true },
+    'not-found': { origin: 'server', terminal: false, retryable: false },
+    'broadcast-disabled': { origin: 'server', terminal: false, retryable: false },
+    'chat-disabled': { origin: 'server', terminal: false, retryable: false },
+    'no-stream': { origin: 'server', terminal: false, retryable: false },
+    'stream-exists': { origin: 'server', terminal: false, retryable: false },
+    'stream-quota': { origin: 'server', terminal: false, retryable: true },
+    'network': { origin: 'sdk', terminal: false, retryable: true },
+    'rates-unconfigured': { origin: 'sdk', terminal: false, retryable: false },
+    'redirected': { origin: 'sdk', terminal: false, retryable: false },
+    'not-connected': { origin: 'sdk', terminal: false, retryable: true },
+    'timeout': { origin: 'sdk', terminal: false, retryable: true },
+    'connect-failed': { origin: 'sdk', terminal: false, retryable: true },
+    'replaced': { origin: 'sdk', terminal: true, retryable: false },
+    'reconnect-gave-up': { origin: 'sdk', terminal: true, retryable: false },
+    'devices-gone': { origin: 'sdk', terminal: false, retryable: false },
+    'unpublished': { origin: 'sdk', terminal: false, retryable: false },
+    'frame-rate-fallback': { origin: 'sdk', terminal: false, retryable: false },
+    'codec-fallback': { origin: 'sdk', terminal: false, retryable: false },
+    'quality-unavailable': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-active': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-unsupported': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-no-video': { origin: 'sdk', terminal: false, retryable: false },
+    'disconnected': { origin: 'sdk', terminal: false, retryable: true },
+    'produce-failed': { origin: 'sdk', terminal: false, retryable: true },
+    'consume-failed': { origin: 'sdk', terminal: false, retryable: true },
+    'media-unavailable': { origin: 'sdk', terminal: false, retryable: false },
+    'music-unavailable': { origin: 'sdk', terminal: false, retryable: false },
+    'no-camera': { origin: 'sdk', terminal: false, retryable: false },
+    'camera-failed': { origin: 'sdk', terminal: false, retryable: true },
+    'unknown-producer': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-denied': { origin: 'sdk', terminal: false, retryable: true },
+    'screen-share-service-required': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-source-required': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-setup-required': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-share-start-timeout': { origin: 'sdk', terminal: false, retryable: true },
+    'screen-share-ended': { origin: 'sdk', terminal: false, retryable: true },
+    'screen-share-failed': { origin: 'sdk', terminal: false, retryable: true },
+    'screen-share-size-unavailable': { origin: 'sdk', terminal: false, retryable: true },
+    'screen-audio-unavailable': { origin: 'sdk', terminal: false, retryable: false },
+    'screen-stop-failed': { origin: 'sdk', terminal: false, retryable: false },
+    'degradation-preference-failed': { origin: 'sdk', terminal: false, retryable: false },
+};
+/** The registry entry for a code, or undefined for one this SDK does not know. */
+export function errorInfo(code) {
+    return Object.prototype.hasOwnProperty.call(ERROR_CODES, code) ? ERROR_CODES[code] : undefined;
+}
+/**
+ * Whether reconnecting cannot fix a join refused with this code: a room that
+ * has ended is not coming back, and a token that is wrong will be wrong next
+ * time too. Unknown codes are not terminal, so a newer server's code never
+ * stops a reconnect that could succeed.
+ */
+export function isTerminalError(code) {
+    return errorInfo(code)?.terminal === true;
+}
+/**
+ * An error with a machine-readable code: returned by the server (its code
+ * passed through unchanged, known to this SDK or not) or raised by the SDK
+ * itself with a registry code. `data` is what the server attached so the app
+ * can act on a refusal rather than merely report it: `{ slots }` for
+ * `slot-occupied`, for instance.
+ */
+export class RpcError extends Error {
+    code;
+    data;
+    constructor(code, message, data) {
+        super(`${code}: ${message}`);
+        this.code = code;
+        this.data = data;
+        this.name = 'RpcError';
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAaH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC3E,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAClE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAClE,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACnE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACjE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACpE,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAChE,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACjE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACrE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpE,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC3E,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACtE,iBAAiB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,qBAAqB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC7E,uBAAuB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC/E,kBAAkB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC1E,qBAAqB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC7E,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACnE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACvE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACtE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACtE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAClE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAClE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,0BAA0B,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnF,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,gBAAgB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,wBAAwB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACjF,2BAA2B,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpF,2BAA2B,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpF,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC5E,mBAAmB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC5E,0BAA0B,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnF,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACvE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACtE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrE,kBAAkB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC3E,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAChE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACvE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnE,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpE,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAClE,oBAAoB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC5E,aAAa,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACrE,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpE,oBAAoB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC7E,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,WAAW,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpE,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACtE,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC9D,oBAAoB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC1E,YAAY,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAClE,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpE,SAAS,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC9D,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACrE,UAAU,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC/D,mBAAmB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,cAAc,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpE,aAAa,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnE,qBAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC3E,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACtE,qBAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC3E,qBAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC3E,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAChF,uBAAuB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC7E,cAAc,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACnE,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACrE,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACrE,mBAAmB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,mBAAmB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACzE,WAAW,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACjE,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpE,kBAAkB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACxE,qBAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC1E,+BAA+B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACrF,8BAA8B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACpF,6BAA6B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IACnF,4BAA4B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACjF,oBAAoB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACzE,qBAAqB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IAC1E,+BAA+B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE;IACpF,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAChF,oBAAoB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;IAC1E,+BAA+B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE;CACzC,CAAC;AAK/C,kFAAkF;AAClF,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9G,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,KAAK,IAAI,CAAC;AAC5C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,QAAS,SAAQ,KAAK;IACZ;IAA2D;IAAhF,YAAqB,IAA+B,EAAE,OAAe,EAAW,IAAc;QAC5F,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QADV,SAAI,GAAJ,IAAI,CAA2B;QAA4B,SAAI,GAAJ,IAAI,CAAU;QAE5F,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;CACF"}

package/dist/esm/index.d.ts

@@ -9,6 +9,8 @@ import { type RecordingOptions, type RecordingFile } from './recording.js';
 import { type types as ms } from 'mediasoup-client';
 type RtpCapabilities = ms.RtpCapabilities;
 import type { ChatEvents, ChatMessage, ChatState, SendMessageOptions } from './chat.js';
+import { type AudioQuality, type JoinBilling, type JoinMedia, type MediaPermissions } from './media-permissions.js';
+import { type NetworkQuality } from './network.js';
 import { type CodecPreference } from './device.js';
 import { type MusicInput, type MusicOptions, type TrackSource } from './music.js';
 import { type ScreenMode, type ReceiveQuality, type VideoLayer, type LayerCount, type VideoPolicy, type VideoQuality } from './quality.js';
@@ -20,6 +22,13 @@ export { AudioMixer, MusicSource } from './music.js';
 export type { MusicInput, MusicOptions, TrackSource } from './music.js';
 export type { BroadcastEvents, BroadcastStartOptions, BroadcastState } from './broadcast.js';
 export { ChatClient, ChatRpcError } from './chat.js';
+export { RpcError, ERROR_CODES, errorInfo, isTerminalError } from './errors.js';
+export type { ErrorCode, ErrorInfo, ErrorOrigin } from './errors.js';
+export { AUDIO_QUALITIES, AUDIO_SETTINGS, DEFAULT_MEDIA_PERMISSIONS, resolvePermissions } from './media-permissions.js';
+export type { AudioQuality, BillingMode, JoinBilling, JoinMedia, MediaPermissions, MediaProfile } from './media-permissions.js';
+export { NETWORK_QUALITY_INTERVAL_MS, NETWORK_QUALITY_LEVELS, networkLevel } from './network.js';
+export type { NetworkQuality, NetworkQualityLevel } from './network.js';
+export { TOKEN_EXPIRING_LEAD_MS, tokenExpiresAt } from './token.js';
 export { allowedQuality, layerBitrate, videoEncodings, VIDEO_QUALITIES } from './quality.js';
 export type { LayerCount, VideoEncoding, VideoPolicy, VideoQuality, VideoLayer, ReceiveQuality, ScreenMode } from './quality.js';
 export type { CodecPreference } from './device.js';
@@ -33,6 +42,52 @@ export interface UsageLimitNotice {
     /** When the session will be ended, in ms since the epoch. */
     endsAt: number;
 }
+/**
+ * Wallet billing: what the project may still spend covers less than the
+ * grace period at the current burn, or (`cleared: true`) a recharge or a
+ * lower burn lifted it back above it.
+ */
+export interface WalletLowNotice {
+    /** Seconds the funds cover at the current burn; -1 on a cleared notice when nothing limits them. */
+    remainingSeconds: number;
+    /** True once the warning is over: hide the banner, and the `usageLimit` countdown sent beside it is cancelled. */
+    cleared?: boolean;
+}
+/** The token this client would reconnect with lapses soon, and nobody has refreshed it. */
+export interface TokenExpiringNotice {
+    /** When it expires, in ms since the epoch. */
+    expiresAt: number;
+    secondsLeft: number;
+}
+/** Where a session stands, in the order a session goes through them. `closed` is final; the `closed` event says why. */
+export declare const CONNECTION_STATES: readonly ["idle", "connecting", "connected", "reconnecting", "closed"];
+export type ConnectionState = (typeof CONNECTION_STATES)[number];
+export type ClosedReason = 'replaced' | 'kicked' | 'room-closed' | 'gave-up' | 'left';
+/** A slot changed hands, went away, came back, was locked or was freed. */
+export interface ClaimChange {
+    key: string;
+    /** Null when the slot is now free or blocked. */
+    identity: string | null;
+    state: 'held' | 'away' | 'free' | 'blocked';
+    /** `claimed`, `moved`, `released`, `disconnected`, `reconnected`, `expired`, `blocked` or `unblocked`. */
+    reason: string;
+}
+/** A track this client is receiving. */
+export interface RemoteTrack {
+    producerId: string;
+    identity: string;
+    kind: 'audio' | 'video';
+    source: TrackSource;
+    track: MediaStreamTrack;
+    /** Its publisher has it switched off (or a moderator does). */
+    paused: boolean;
+}
+/** What this client publishes, as `localMediaChanged` reports it. */
+export interface LocalMediaState {
+    micEnabled: boolean;
+    camEnabled: boolean;
+    musicEnabled: boolean;
+}
 export interface JoinResult {
     roomId: string;
     identity: string;
@@ -54,8 +109,23 @@ export interface JoinResult {
      * on a publisher's incoming bitrate. Absent from older servers: 1080p.
      */
     video?: VideoPolicy;
+    /**
+     * The project's media settings, the modes they allow and the fan-out
+     * limits. Absent from older servers; `mediaPermissions` resolves either.
+     */
+    media?: JoinMedia;
+    /** How this session is billed. Absent from older servers. */
+    billing?: JoinBilling;
 }
 export interface PublishOptions {
+    /**
+     * The microphone: `'std'` (the default) is mono Opus up to 64 kbps, billed
+     * as standard audio; `'hd'` is stereo Opus up to 128 kbps, billed as HD
+     * audio. HD in a project limited to standard audio sends standard and warns
+     * on `error` with `audio-quality-not-allowed`. Change it live with
+     * `setAudioQuality`. Music (`publishMusic`) is not affected.
+     */
+    audioQuality?: AudioQuality;
     /** 30 by default. Only the top layer uses 60; capture at 60 too. */
     frameRate?: 30 | 60;
     /**
@@ -99,6 +169,21 @@ export interface ScreenPublishOptions {
     /** An existing screen stream; otherwise capture is requested from this user gesture. */
     stream?: MediaStream;
 }
+/**
+ * The handlers mediasoup-client can make its Device with. `ReactNative106` is
+ * reserved for future native hosts (react-native-webrtc); nothing published
+ * uses it yet.
+ */
+export type DeviceHandlerName = 'Chrome111' | 'Chrome74' | 'Firefox120' | 'Safari12' | 'ReactNative106';
+/** `new StreamClient(wsUrl, token, options)`. Everything here is optional; a browser needs none of it. */
+export interface ClientOptions {
+    /**
+     * The mediasoup-client handler to make the Device with, instead of detecting
+     * the browser from its user agent. Leave it unset in browsers; it is
+     * reserved for future native hosts, which have no user agent to detect.
+     */
+    handlerName?: DeviceHandlerName;
+}
 export interface SlotClaim {
     key: string;
     identity: string;
@@ -131,6 +216,11 @@ export interface RemoteProducer {
 export interface ClientEvents extends ChatEvents {
     connected: () => void;
     disconnected: (reason: string) => void;
+    /** idle → connecting → connected ⇄ reconnecting → closed. Read it any time as `connectionState`. */
+    connectionStateChanged: (e: {
+        state: ConnectionState;
+        previous: ConnectionState;
+    }) => void;
     joined: (result: JoinResult) => void;
     track: (info: {
         identity: string;
@@ -162,6 +252,11 @@ export interface ClientEvents extends ChatEvents {
         kind?: 'audio' | 'video' | '';
         paused: boolean;
     }) => void;
+    /** Someone's display metadata changed (their own `setMetadata`). */
+    participantUpdated: (e: {
+        identity: string;
+        metadata: unknown;
+    }) => void;
     roleChanged: (e: {
         identity: string;
         role: Role;
@@ -182,6 +277,17 @@ export interface ClientEvents extends ChatEvents {
         kind?: 'audio' | 'video' | '';
         paused: boolean;
     }) => void;
+    /**
+     * A slot changed. **Draw `away` as taken (greyed), never as free**: the
+     * holder's connection dropped and the slot is kept for them. `info.claims`
+     * and `info.blockedSlots` are kept current from these.
+     */
+    claimChanged: (e: ClaimChange) => void;
+    /** Room metadata changed (a moderator's `setRoomMetadata`); persisted, so `info.metadata` is kept current too. */
+    roomMetadataChanged: (e: {
+        metadata: unknown;
+        by?: string;
+    }) => void;
     mustReconnect: (e: {
         reason: string;
         token?: string;
@@ -201,12 +307,13 @@ export interface ClientEvents extends ChatEvents {
     screenShareEnded: (e: {
         reason: 'stopped' | 'track-ended';
     }) => void;
+    /**
+     * A failure, or a warning that changes nothing else: an `RpcError` whose
+     * `code` is in `ERROR_CODES` (`frame-rate-fallback`,
+     * `audio-quality-not-allowed`, ...). Switch on the code.
+     */
     error: (err: Error) => void;
-    localMediaChanged: (state: {
-        micEnabled: boolean;
-        camEnabled: boolean;
-        musicEnabled: boolean;
-    }) => void;
+    localMediaChanged: (state: LocalMediaState) => void;
     /** The local stream was replaced, typically after reacquiring devices on a reconnect. */
     localStreamChanged: (stream: MediaStream | null) => void;
     /** Media stopped arriving but the connection is intact -- the publisher is reconnecting. */
@@ -214,13 +321,33 @@ export interface ClientEvents extends ChatEvents {
         reason: string;
     }) => void;
     /** The session ended and will not recover. Nothing further will be emitted. */
-    closed: (reason: 'replaced' | 'kicked' | 'room-closed' | 'gave-up' | 'left') => void;
+    closed: (reason: ClosedReason) => void;
     /**
      * The account behind this session ran out of minutes or reached a usage
      * limit. The session ends at `endsAt` (after `graceSeconds`) unless the
      * account is topped up first -- tell the user, and stop asking them to wait.
      */
     usageLimit: (e: UsageLimitNotice) => void;
+    /**
+     * Wallet billing: the funds this project may spend cover less than the
+     * grace period at the current burn, repeated while it lasts; the room closes
+     * when they reach zero unless the wallet is recharged. A notice with
+     * `cleared: true` ends the warning (and the `usageLimit` countdown beside it).
+     */
+    walletLow: (e: WalletLowNotice) => void;
+    /**
+     * The token this client would reconnect with expires in about a minute and
+     * the server has not refreshed it (it stops when the account may no longer
+     * be used, or the socket is down). Mint a new one on your backend and hand it
+     * over with `updateToken`.
+     */
+    tokenExpiring: (e: TokenExpiringNotice) => void;
+    /**
+     * Round trip, packet loss and available bandwidth to the media server, about
+     * every 3 s while listened to and media is flowing, with a level for the UI
+     * (thresholds in the README). Sampled only while someone listens.
+     */
+    networkQuality: (e: NetworkQuality) => void;
     /**
      * Your camera video is being held back by this device (`cpu`: too busy to
      * encode it), by the upload (`bandwidth`), or by something else (`other`);
@@ -231,13 +358,11 @@ export interface ClientEvents extends ChatEvents {
      */
     videoLimited: (e: VideoLimitedEvent) => void;
 }
-/** An error returned by the server, carrying its machine-readable code. */
-export declare class RpcError extends Error {
-    readonly code: string;
-    constructor(code: string, message: string);
-}
+/** The names of every event `StreamClient.on` accepts. */
+export declare const CLIENT_EVENTS: readonly (keyof ClientEvents)[];
 export declare class StreamClient {
     private readonly wsUrl;
+    private readonly options;
     private ws;
     private device;
     private sendTransport;
@@ -294,12 +419,39 @@ export declare class StreamClient {
     private readonly sendStatsBaseline;
     private readonly recvStatsBaseline;
     private readonly limitWatch;
-    constructor(wsUrl: string, token: string);
+    /** Where the session stands; see connectionStateChanged. */
+    private state;
+    /** When the token held for reconnects expires (unix ms), and the timer that warns before it does. */
+    private tokenExpiry;
+    private tokenTimer;
+    /** Whose each received track is and whether it is switched off, by producerId. */
+    private readonly remoteInfo;
+    /** Videos left unconsumed at the fan-out limit, oldest first; consumed as others end. */
+    private readonly skippedVideos;
+    /** Producers whose video this client receives, or is about to: the fan-out count. */
+    private readonly videoSlots;
+    /** The quality the microphone producer was made with. */
+    private micQuality;
+    private micQueue;
+    private audioCapReported;
+    private sizeCapReported;
+    private readonly networkWatch;
+    constructor(wsUrl: string, token: string, options?: ClientOptions);
     on<K extends keyof ClientEvents>(event: K, fn: ClientEvents[K]): () => void;
+    /** Where the session stands: idle, connecting, connected, reconnecting or closed. */
+    get connectionState(): ConnectionState;
+    private setState;
+    /** Over for good: the state, then the event that says why. */
+    private finish;
+    private stopTimers;
     private listenerCount;
     private emit;
     connect(): Promise<JoinResult>;
-    /** A new mediasoup Device for each join. Its own method so tests, which have no WebRTC, can stand one in. */
+    /**
+     * A new mediasoup Device for each join: the handler named in the options, or
+     * the one detected from the browser. Its own method so tests, which have no
+     * WebRTC, can stand one in.
+     */
     private createDevice;
     private openSocket;
     private detachSocket;
@@ -311,12 +463,56 @@ export declare class StreamClient {
     private scheduleReconnect;
     close(): void;
     private teardownMedia;
-    /** Everything currently known about the room, for rendering. */
+    /**
+     * Everything currently known about the room, for rendering: the join
+     * result, kept current -- participants, roles, hands, mutes, display
+     * metadata, slots and room metadata follow the events.
+     */
     get info(): JoinResult | null;
+    /** Who is in the room now, this client included; kept current from the roster events. */
+    get participants(): ParticipantInfo[];
+    /** Every track this client is receiving now. */
+    get remoteTracks(): RemoteTrack[];
+    /**
+     * What this project lets this client publish: from the join result's
+     * `media` (servers with wallet billing), else its `video` policy, else
+     * everything before a join. Offer only these in your UI; the SDK refuses
+     * or caps anything else with the server's own codes.
+     */
+    get mediaPermissions(): MediaPermissions;
+    /** How this session is billed: `legacy` (minutes) or `wallet`; null before a join or on older servers. */
+    get billingMode(): 'legacy' | 'wallet' | null;
+    /**
+     * Hand the session a newer room token, minted by your backend for the same
+     * room and identity (`POST /v1/rooms/{roomId}/tokens`), typically on
+     * `tokenExpiring`. On a live connection the server checks it like a join
+     * token (`bad-token`, or `token-mismatch` for another room or identity; the
+     * session then keeps its token); otherwise it is kept for the next join,
+     * which checks it there. Resolves to when it expires (unix ms), when known.
+     */
+    updateToken(token: string): Promise<{
+        expiresAt: number | null;
+    }>;
+    /** The token reconnects use from now on, with its expiry (read from the token when not given). */
+    private setToken;
+    /**
+     * Warn TOKEN_EXPIRING_LEAD_MS before the token held for reconnects
+     * expires. Every new token -- the server's refresh, a promotion's, the
+     * app's -- reschedules it, so it fires only when nobody refreshed it.
+     */
+    private scheduleTokenExpiring;
+    /** networkQuality sampling runs while someone listens and the session is connected. */
+    private syncNetworkWatch;
+    /** Each live media transport's statistics, keyed by transport so a new one starts fresh. */
+    private transportStats;
     private rpc;
     private failAllPending;
     private onMessage;
     private onEvent;
+    /** Change the roster the join result holds; a new array each time, so a renderer sees the change. */
+    private updateRoster;
+    /** Keep the join result's slots current: claims held or away, and the moderator's locks. */
+    private applyClaim;
     private ensureSendTransport;
     private createSendTransport;
     private ensureRecvTransport;
@@ -334,10 +530,42 @@ export declare class StreamClient {
      * kept for a reconnect's republish.
      */
     publish(stream: MediaStream, constraints?: MediaStreamConstraints, options?: PublishOptions): Promise<void>;
+    private publishStream;
+    /**
+     * The microphone's audio quality: what it is being sent at while
+     * published, else what the next publish will use, after the project's limit.
+     */
+    get audioQuality(): AudioQuality;
+    /**
+     * Switch the microphone between standard (mono, up to 64 kbps) and HD
+     * (stereo, up to 128 kbps) while live. The codec settings are fixed per
+     * producer, so the microphone's producer is replaced: listeners hear a gap
+     * of a fraction of a second, and a microphone that is off stays off. Rejects
+     * with `audio-quality-not-allowed` when the project allows standard audio
+     * only. Resolves to the quality in use.
+     */
+    setAudioQuality(quality: AudioQuality): Promise<AudioQuality>;
+    private micProducer;
+    private micTask;
+    /** The audio quality to send: the request, capped to the project's, with the cap reported once. */
+    private audioQualityFor;
+    /**
+     * Produce the microphone at the audio quality in force. A track handed over
+     * switched off (or paused before a reconnect or a quality change) starts
+     * paused, on both ends.
+     */
+    private produceMic;
+    /** Close the microphone producer and produce its track again at the quality now in force. */
+    private reproduceMic;
     /** What this project may publish. Known once joined; 1080p before that. */
     get videoPolicy(): VideoPolicy;
-    /** The quality video is being sent at, after the project's limit. */
+    /**
+     * The quality video is being sent at, after the project's limit: at 60 fps
+     * the largest size the project allows at 60, otherwise its 30 fps maximum.
+     */
     get videoQuality(): VideoQuality;
+    /** The camera's frame rate: what it is being sent at while published, else 30 until a publish decides. */
+    get videoFrameRate(): 30 | 60;
     /**
      * Change the video quality while publishing. The camera's producer is
      * replaced, so viewers see a brief pause while the new one starts. Resolves
@@ -345,8 +573,21 @@ export declare class StreamClient {
      * that size (for example with `track.applyConstraints`) first.
      */
     setVideoQuality(quality: VideoQuality): Promise<VideoQuality>;
-    /** Change the camera frame rate without stopping screen, microphone or music. */
+    /**
+     * Change the camera frame rate without stopping screen, microphone or music.
+     * 60 where the project allows none stays at 30 and warns on `error` with
+     * `frame-rate-not-allowed`, without touching the camera; a camera or device
+     * that cannot keep 60 up falls back with `frame-rate-fallback`. Resolves to
+     * the frame rate used.
+     */
     setVideoFrameRate(frameRate: 30 | 60): Promise<30 | 60>;
+    /** Whether this project allows any 60 fps mode. */
+    private allows60;
+    /**
+     * The quality to send at a frame rate. A request above what 60 fps allows
+     * is sent at the largest size it does allow, and said so once.
+     */
+    private cameraQuality;
     /**
      * Send a different video track from now on: a canvas with effects drawn on
      * it, the raw camera again, another camera. When the new track needs the
@@ -452,6 +693,13 @@ export declare class StreamClient {
     private releaseScreen;
     private stopScreen;
     private restoreScreen;
+    /**
+     * 60 only when asked for, allowed by the project, captured at 50 or more and
+     * not fallen back from. The project's refusal and the camera's are reported
+     * apart, each once: `frame-rate-not-allowed` is the server's own code for a
+     * 60 fps producer the project does not allow, `frame-rate-fallback` means
+     * the camera or device cannot provide it.
+     */
     private frameRateFor;
     private sampleCamera;
     /**
@@ -477,6 +725,9 @@ export declare class StreamClient {
     stopMusic(): Promise<void>;
     private emitLocalMedia;
     private consume;
+    /** The oldest videos left waiting at the fan-out limit take the slots that opened. */
+    private consumeSkipped;
+    private consumeNow;
     /** True once this client has at least one live producer. */
     get publishing(): boolean;
     get micEnabled(): boolean;
@@ -510,6 +761,37 @@ export declare class StreamClient {
     kick(identity: string, reason?: string): Promise<unknown>;
     endRoom(): Promise<unknown>;
     getRoomState(): Promise<unknown>;
+    /**
+     * Take a slot, or (moderators) grant one by naming `identity`. One claim
+     * per identity: a second moves you. Refused with `slot-taken` when someone
+     * holds it (away included) and `slot-blocked` when a moderator locked it.
+     * Claim first, then promote: if the slot has gone, nothing has happened yet.
+     */
+    claim(key: string, identity?: string): Promise<void>;
+    /** Give up a slot. Moderators may release anyone's. */
+    release(key: string): Promise<void>;
+    /**
+     * Lock a slot so nobody may claim it. Moderators only. Refused with
+     * `slot-occupied` while someone holds it: taking a seat from a person using
+     * it is two deliberate acts, not a side effect of one tap.
+     */
+    blockSlot(key: string): Promise<void>;
+    /** Unlock a slot. Moderators only. */
+    unblockSlot(key: string): Promise<void>;
+    /** Replace your own display metadata; the room hears it as participantUpdated. */
+    setMetadata(metadata: Record<string, unknown>): Promise<void>;
+    /**
+     * Change room-scoped metadata. Moderators only, and persisted, so a client
+     * joining later reads it from `info.metadata`. Merges one key deep by
+     * default (a null value deletes its key); `replace` swaps the whole object.
+     * `requireFree` names slots that must be unheld for the change to apply,
+     * checked and applied together: the refusal (`slot-occupied`) names the
+     * offending keys in `RpcError.data.slots`. Resolves to the metadata now.
+     */
+    setRoomMetadata(metadata: Record<string, unknown>, options?: {
+        replace?: boolean;
+        requireFree?: string[];
+    }): Promise<unknown>;
     sendMessage(text: string, opts?: SendMessageOptions): Promise<{
         id: string;
         ts: number;