@voltkit-rtc/client 0.8.0 → 0.9.0

package/dist/esm/noise-suppression.d.ts

@@ -0,0 +1,44 @@
+/**
+ * AI noise suppression for the microphone (docs/implementation-progress/RTC_PERF_PROGRESS.md P3-4): what Agora's AI
+ * Denoiser, LiveKit's Krisp filter and ZEGOCLOUD's AI noise suppression do, with RNNoise -- the open neural-network
+ * denoiser Jitsi uses -- through `@sapphi-red/web-noise-suppressor` (MIT): a Web Audio worklet in the browser's
+ * audio thread. Fans, traffic and room rumble fall away (measured in Chromium: rumble-like noise down by more than
+ * 60 dB, steady white hiss by 7-12 dB); voices stay.
+ *
+ * Imported on its own (`@voltkit-rtc/client/noise-suppression`), so an app that does not use it never ships it:
+ *
+ *   import { createNoiseSuppressor } from '@voltkit-rtc/client/noise-suppression';
+ *   await client.setAudioProcessor(createNoiseSuppressor());
+ *
+ * The worklet (64 kB) and the model (150 kB) are fetched when it starts: from jsDelivr, at the exact version this
+ * SDK was tested with, unless you serve them yourself (`workletUrl`, `wasmUrl`, `simdWasmUrl`) -- copy them from
+ * `node_modules/@sapphi-red/web-noise-suppressor/dist` to your own site for a strict Content-Security-Policy.
+ */
+import type { AudioTrackProcessor } from './processors.js';
+/** The package version the default URLs point at; equal to this SDK's pinned dependency (a test checks it). */
+export declare const NOISE_SUPPRESSOR_VERSION = "0.4.1";
+export interface NoiseSuppressorOptions {
+    /** Where `rnnoise/workletProcessor.js` is served. Default: jsDelivr, pinned. */
+    workletUrl?: string;
+    /** Where `rnnoise.wasm` is served. Default: jsDelivr, pinned. */
+    wasmUrl?: string;
+    /** Where `rnnoise_simd.wasm` is served (used where the browser supports SIMD). Default: jsDelivr, pinned. */
+    simdWasmUrl?: string;
+}
+/** What the processor needs from the browser; stood in for by tests. */
+export interface NoiseSuppressorDeps {
+    createContext(): AudioContext;
+    loadModel(urls: {
+        url: string;
+        simdUrl: string;
+    }): Promise<ArrayBuffer>;
+    createNode(context: AudioContext, wasmBinary: ArrayBuffer): Promise<DenoiseNode> | DenoiseNode;
+    createStream(tracks: MediaStreamTrack[]): MediaStream;
+}
+type DenoiseNode = AudioNode & {
+    destroy?(): void;
+};
+/** An `AudioTrackProcessor` for `client.setAudioProcessor()` that removes background noise with RNNoise. */
+export declare function createNoiseSuppressor(options?: NoiseSuppressorOptions, deps?: NoiseSuppressorDeps): AudioTrackProcessor;
+export {};
+//# sourceMappingURL=noise-suppression.d.ts.map

package/dist/esm/noise-suppression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noise-suppression.d.ts","sourceRoot":"","sources":["../../src/noise-suppression.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,+GAA+G;AAC/G,eAAO,MAAM,wBAAwB,UAAU,CAAC;AAGhD,MAAM,WAAW,sBAAsB;IACrC,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6GAA6G;IAC7G,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,aAAa,IAAI,YAAY,CAAC;IAC9B,SAAS,CAAC,IAAI,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxE,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;IAC/F,YAAY,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC;CACvD;AAED,KAAK,WAAW,GAAG,SAAS,GAAG;IAAE,OAAO,CAAC,IAAI,IAAI,CAAA;CAAE,CAAC;AAsBpD,4GAA4G;AAC5G,wBAAgB,qBAAqB,CAAC,OAAO,GAAE,sBAA2B,EAAE,IAAI,GAAE,mBAAiC,GAAG,mBAAmB,CAwExI"}

package/dist/esm/noise-suppression.js

@@ -0,0 +1,99 @@
+/** The package version the default URLs point at; equal to this SDK's pinned dependency (a test checks it). */
+export const NOISE_SUPPRESSOR_VERSION = '0.4.1';
+const CDN = `https://cdn.jsdelivr.net/npm/@sapphi-red/web-noise-suppressor@${NOISE_SUPPRESSOR_VERSION}/dist`;
+let library = null;
+/**
+ * The library is loaded on first use, not with this module: it extends `AudioWorkletNode` as it loads, which exists
+ * only in browsers, so a static import would break a server render (Next.js) or Node.
+ */
+const load = () => (library ??= import('@sapphi-red/web-noise-suppressor').catch((err) => {
+    library = null;
+    throw err;
+}));
+const browserDeps = {
+    // RNNoise works on 48 kHz audio.
+    createContext: () => new AudioContext({ sampleRate: 48000 }),
+    loadModel: async (urls) => (await load()).loadRnnoise(urls),
+    createNode: async (context, wasmBinary) => new (await load()).RnnoiseWorkletNode(context, { wasmBinary, maxChannels: 1 }),
+    createStream: (tracks) => new MediaStream(tracks),
+};
+/** An `AudioTrackProcessor` for `client.setAudioProcessor()` that removes background noise with RNNoise. */
+export function createNoiseSuppressor(options = {}, deps = browserDeps) {
+    let context = null;
+    let ready = null;
+    let graph = null;
+    let resumeOnGesture = null;
+    const release = () => {
+        if (!graph)
+            return;
+        try {
+            graph.source.disconnect();
+            graph.node.disconnect();
+            graph.node.destroy?.();
+        }
+        catch {
+            // Already gone.
+        }
+        graph.output.stop();
+        graph = null;
+    };
+    /** A context made without a tap starts suspended: no sound would go out until the page is touched. */
+    const keepRunning = (ctx) => {
+        void ctx.resume?.().catch(() => undefined);
+        if (ctx.state === 'running' || typeof document === 'undefined' || resumeOnGesture)
+            return;
+        resumeOnGesture = () => {
+            void ctx.resume().catch(() => undefined);
+            if (ctx.state === 'running' && resumeOnGesture) {
+                for (const type of ['pointerdown', 'keydown'])
+                    document.removeEventListener(type, resumeOnGesture, { capture: true });
+                resumeOnGesture = null;
+            }
+        };
+        for (const type of ['pointerdown', 'keydown'])
+            document.addEventListener(type, resumeOnGesture, { capture: true });
+    };
+    return {
+        name: 'noise-suppression',
+        async process(track) {
+            const ctx = (context ??= deps.createContext());
+            ready ??= Promise.all([
+                deps.loadModel({ url: options.wasmUrl ?? `${CDN}/rnnoise.wasm`, simdUrl: options.simdWasmUrl ?? `${CDN}/rnnoise_simd.wasm` }),
+                ctx.audioWorklet.addModule(options.workletUrl ?? `${CDN}/rnnoise/workletProcessor.js`),
+            ]).then(([model]) => model);
+            let model;
+            try {
+                model = await ready;
+            }
+            catch (err) {
+                ready = null; // try again next time (a network blip)
+                throw err;
+            }
+            const node = await deps.createNode(ctx, model);
+            release();
+            const source = ctx.createMediaStreamSource(deps.createStream([track]));
+            const destination = ctx.createMediaStreamDestination();
+            source.connect(node);
+            node.connect(destination);
+            const output = destination.stream.getAudioTracks()[0];
+            if (!output)
+                throw new Error('the audio graph gave no track');
+            graph = { source, node, output };
+            keepRunning(ctx);
+            return output;
+        },
+        async destroy() {
+            release();
+            if (resumeOnGesture && typeof document !== 'undefined') {
+                for (const type of ['pointerdown', 'keydown'])
+                    document.removeEventListener(type, resumeOnGesture, { capture: true });
+            }
+            resumeOnGesture = null;
+            const ctx = context;
+            context = null;
+            ready = null;
+            await ctx?.close().catch(() => undefined);
+        },
+    };
+}
+//# sourceMappingURL=noise-suppression.js.map

package/dist/esm/noise-suppression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noise-suppression.js","sourceRoot":"","sources":["../../src/noise-suppression.ts"],"names":[],"mappings":"AAkBA,+GAA+G;AAC/G,MAAM,CAAC,MAAM,wBAAwB,GAAG,OAAO,CAAC;AAChD,MAAM,GAAG,GAAG,iEAAiE,wBAAwB,OAAO,CAAC;AAqB7G,IAAI,OAAO,GAA4B,IAAI,CAAC;AAE5C;;;GAGG;AACH,MAAM,IAAI,GAAG,GAAqB,EAAE,CAClC,CAAC,OAAO,KAAK,MAAM,CAAC,kCAAkC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC7E,OAAO,GAAG,IAAI,CAAC;IACf,MAAM,GAAG,CAAC;AACZ,CAAC,CAAC,CAAC,CAAC;AAEN,MAAM,WAAW,GAAwB;IACvC,iCAAiC;IACjC,aAAa,EAAE,GAAG,EAAE,CAAC,IAAI,YAAY,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAC5D,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;IAC3D,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;IACzH,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC;CAClD,CAAC;AAEF,4GAA4G;AAC5G,MAAM,UAAU,qBAAqB,CAAC,UAAkC,EAAE,EAAE,OAA4B,WAAW;IACjH,IAAI,OAAO,GAAwB,IAAI,CAAC;IACxC,IAAI,KAAK,GAAgC,IAAI,CAAC;IAC9C,IAAI,KAAK,GAA8E,IAAI,CAAC;IAC5F,IAAI,eAAe,GAAwB,IAAI,CAAC;IAEhD,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,IAAI,CAAC;YACH,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC;YACP,gBAAgB;QAClB,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,GAAG,IAAI,CAAC;IACf,CAAC,CAAC;IAEF,sGAAsG;IACtG,MAAM,WAAW,GAAG,CAAC,GAAiB,EAAE,EAAE;QACxC,KAAK,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,QAAQ,KAAK,WAAW,IAAI,eAAe;YAAE,OAAO;QAC1F,eAAe,GAAG,GAAG,EAAE;YACrB,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YACzC,IAAI,GAAG,CAAC,KAAK,KAAK,SAAS,IAAI,eAAe,EAAE,CAAC;gBAC/C,KAAK,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,SAAS,CAAU;oBAAE,QAAQ,CAAC,mBAAmB,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC/H,eAAe,GAAG,IAAI,CAAC;YACzB,CAAC;QACH,CAAC,CAAC;QACF,KAAK,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,SAAS,CAAU;YAAE,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9H,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,KAAK,CAAC,OAAO,CAAC,KAAuB;YACnC,MAAM,GAAG,GAAG,CAAC,OAAO,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;YAC/C,KAAK,KAAK,OAAO,CAAC,GAAG,CAAC;gBACpB,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,OAAO,IAAI,GAAG,GAAG,eAAe,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,IAAI,GAAG,GAAG,oBAAoB,EAAE,CAAC;gBAC7H,GAAG,CAAC,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,IAAI,GAAG,GAAG,8BAA8B,CAAC;aACvF,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;YAC5B,IAAI,KAAkB,CAAC;YACvB,IAAI,CAAC;gBACH,KAAK,GAAG,MAAM,KAAK,CAAC;YACtB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,KAAK,GAAG,IAAI,CAAC,CAAC,uCAAuC;gBACrD,MAAM,GAAG,CAAC;YACZ,CAAC;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC/C,OAAO,EAAE,CAAC;YACV,MAAM,MAAM,GAAG,GAAG,CAAC,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACvE,MAAM,WAAW,GAAG,GAAG,CAAC,4BAA4B,EAAE,CAAC;YACvD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC1B,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;YACtD,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAC9D,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACjC,WAAW,CAAC,GAAG,CAAC,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,KAAK,CAAC,OAAO;YACX,OAAO,EAAE,CAAC;YACV,IAAI,eAAe,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACvD,KAAK,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,SAAS,CAAU;oBAAE,QAAQ,CAAC,mBAAmB,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YACjI,CAAC;YACD,eAAe,GAAG,IAAI,CAAC;YACvB,MAAM,GAAG,GAAG,OAAO,CAAC;YACpB,OAAO,GAAG,IAAI,CAAC;YACf,KAAK,GAAG,IAAI,CAAC;YACb,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/esm/processors.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Track processors (docs/implementation-progress/RTC_PERF_PROGRESS.md P3-4, P3-5): the published microphone or
+ * camera sent through something that changes it first -- noise suppression, a blurred or replaced background, beauty.
+ * LiveKit (`setProcessor`: Krisp, background blur), Agora and TRTC (extensions and plugins) do it the same way: the
+ * device's track goes in, a processed track goes out and is published in its place; the device's own track stays the
+ * one watched for unplugging, given new constraints and released at the end.
+ */
+/** Something the microphone passes through before it is sent. */
+export interface AudioTrackProcessor {
+    /** A short name, for diagnostics. */
+    readonly name: string;
+    /**
+     * Process `track` and return the track to send. Called again whenever the microphone's track changes (another
+     * device, a reconnect): the processor then lets go of what it made for the previous one.
+     */
+    process(track: MediaStreamTrack): Promise<MediaStreamTrack>;
+    /** Let go of everything (the processor was removed, or the session ended). */
+    destroy(): Promise<void> | void;
+}
+/** Something the camera passes through before it is sent (and shown in `client.local`). */
+export interface VideoTrackProcessor {
+    /** A short name, for diagnostics. */
+    readonly name: string;
+    /**
+     * Process `track` and return the track to send, at the same size and frame rate. Called again when the camera's
+     * track changes (another camera, `replaceVideoTrack`): the processor then lets go of what it made for the previous
+     * one. A picture the SDK no longer sends is stopped by the SDK; stop drawing it once its `readyState` is 'ended',
+     * and skip the work while it is switched off (`enabled` false: the camera is paused).
+     */
+    process(track: MediaStreamTrack): Promise<MediaStreamTrack>;
+    /** Let go of everything (the processor was removed, or the session ended). */
+    destroy(): Promise<void> | void;
+}
+//# sourceMappingURL=processors.d.ts.map

package/dist/esm/processors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processors.d.ts","sourceRoot":"","sources":["../../src/processors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,iEAAiE;AACjE,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,8EAA8E;IAC9E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACjC;AAED,2FAA2F;AAC3F,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC5D,8EAA8E;IAC9E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACjC"}

package/dist/esm/processors.js

@@ -0,0 +1,9 @@
+/**
+ * Track processors (docs/implementation-progress/RTC_PERF_PROGRESS.md P3-4, P3-5): the published microphone or
+ * camera sent through something that changes it first -- noise suppression, a blurred or replaced background, beauty.
+ * LiveKit (`setProcessor`: Krisp, background blur), Agora and TRTC (extensions and plugins) do it the same way: the
+ * device's track goes in, a processed track goes out and is published in its place; the device's own track stays the
+ * one watched for unplugging, given new constraints and released at the end.
+ */
+export {};
+//# sourceMappingURL=processors.js.map

package/dist/esm/processors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processors.js","sourceRoot":"","sources":["../../src/processors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/dist/esm/video-effects.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Virtual background and beauty for the camera (docs/implementation-progress/RTC_PERF_PROGRESS.md P3-5): a blurred or
+ * replaced background and skin smoothing, as LiveKit's track processors, Agora's and ZEGOCLOUD's virtual background and
+ * beauty extensions, and Tencent TRTC's video effect plugin do -- in the browser, on the GPU.
+ *
+ * Imported on its own (`@voltkit-rtc/client/video-effects`), so an app that does not use it never ships it:
+ *
+ *   import { createVideoEffects } from '@voltkit-rtc/client/video-effects';
+ *   const effects = createVideoEffects({ background: 'blur', beauty: true });
+ *   await client.setVideoProcessor(effects);
+ *   await effects.update({ background: { image: '/office.jpg' } });   // live, no pause for viewers
+ *
+ * Finding the person takes Google's MediaPipe selfie segmenter: install `@mediapipe/tasks-vision@0.10.35` next to the
+ * SDK (an optional peer dependency, 0.10.35 exactly -- later versions report usage to Google). Its wasm (3 MB
+ * compressed) and the model (250 kB) load the first time a background effect is used: the wasm from jsDelivr at that
+ * version and the model from Google, unless you serve them yourself (`wasmPath`, `modelUrl`). Beauty alone needs none
+ * of it.
+ *
+ * Chrome and Edge process each camera frame as it arrives (insertable streams: smooth, and it keeps going in a
+ * background tab). Firefox and Safari draw from a hidden video on a worker's timer into a captured canvas -- what
+ * LiveKit, Twilio and Amazon Chime fall back to -- which a background tab can slow down.
+ */
+import { type BackgroundSetting, type BeautyOptions, type BeautySettings } from './effects-core.js';
+import type { VideoTrackProcessor } from './processors.js';
+export type { BackgroundImageSource, BackgroundSetting, BeautyOptions, BeautySettings } from './effects-core.js';
+/** The `@mediapipe/tasks-vision` version this SDK was tested with; the default wasm URL points at it. */
+export declare const MEDIAPIPE_VERSION = "0.10.35";
+/** Google's selfie segmenter for portrait and square pictures (phones), at a fixed version. */
+export declare const DEFAULT_SEGMENTER_MODEL = "https://storage.googleapis.com/mediapipe-models/image_segmenter/selfie_segmenter/float16/1/selfie_segmenter.tflite";
+/**
+ * Its landscape version, for wide pictures (webcams): fed a 16:9 frame, the square model leaves patches of the room
+ * beside the head, the landscape one traces it cleanly (as LiveKit, Twilio, Chime and TRTC use for webcams).
+ */
+export declare const DEFAULT_LANDSCAPE_MODEL = "https://storage.googleapis.com/mediapipe-models/image_segmenter/selfie_segmenter_landscape/float16/1/selfie_segmenter_landscape.tflite";
+export interface VideoEffectsOptions {
+    /** `'none'` (default), `'blur'`, or `{ image }`: a URL, Blob, image, canvas or ImageBitmap, fitted to cover. */
+    background?: BackgroundSetting;
+    /** Blur strength, 1 (light) to 10 (strong). Default 5. */
+    blur?: number;
+    /** Beauty: `true` for the defaults, or each of `smooth`, `brighten`, `redness`, `sharpen` (0-1). Off by default. */
+    beauty?: BeautyOptions | boolean | null;
+    /** A folder serving `vision_wasm_internal.{js,wasm}` and `vision_wasm_nosimd_internal.{js,wasm}` (from
+     *  `node_modules/@mediapipe/tasks-vision/wasm`). Default: jsDelivr at MEDIAPIPE_VERSION. */
+    wasmPath?: string;
+    /** Where the segmentation model is served, for every picture. Default: DEFAULT_LANDSCAPE_MODEL for wide pictures,
+     *  DEFAULT_SEGMENTER_MODEL for portrait and square ones. */
+    modelUrl?: string;
+    /** The most frames a second to process; the camera's rate by default. */
+    maxFrameRate?: number;
+    /**
+     * Told when this device cannot keep up even finding the person only every few frames (Agora's `onoverload`): turn
+     * the background off, or lower the camera's frame rate or size. Told again with `false` when it can.
+     */
+    onOverload?: (overloaded: boolean) => void;
+}
+/** What `update` can change while the effects run. */
+export type VideoEffectsUpdate = Pick<VideoEffectsOptions, 'background' | 'blur' | 'beauty'>;
+export interface VideoEffects extends VideoTrackProcessor {
+    /**
+     * Change the effects while they run: no new camera, no pause for viewers. Resolves once the change shows; a picture
+     * that cannot be loaded, or a segmenter that cannot start, rejects and leaves the effects as they were.
+     */
+    update(changes: VideoEffectsUpdate): Promise<void>;
+    /** The effects in force now. */
+    readonly settings: {
+        background: 'none' | 'blur' | 'image';
+        blur: number;
+        beauty: BeautySettings | null;
+    };
+    /** How hard the device works: the person is found every `segmentEvery` frames, in `segmentMs` on average. */
+    readonly stats: {
+        segmentEvery: number;
+        segmentMs: number;
+        overloaded: boolean;
+    };
+}
+/** What finds the person: MediaPipe's ImageSegmenter, or a stand-in in tests. */
+export interface PersonSegmenter {
+    /** Find the person in `input`; `use` gets the confidence (0-1) of each pixel being the person, at `input`'s size. */
+    segment(input: TexImageSource, timestampMs: number, use: (confidence: Float32Array) => void): void;
+    close(): void;
+}
+/** Stood in for by tests. */
+export interface VideoEffectsDeps {
+    loadSegmenter(wasmPath: string, modelUrl: string): Promise<PersonSegmenter>;
+    /** How frames are taken and given back; chosen from the browser's features when absent. */
+    pump?: 'insertable' | 'canvas';
+}
+/** Whether this browser can run the effects (WebGL2, and a way to take and give back frames). */
+export declare function isVideoEffectsSupported(): boolean;
+/** Virtual background and beauty, for `client.setVideoProcessor()`. */
+export declare function createVideoEffects(options?: VideoEffectsOptions, stand?: Partial<VideoEffectsDeps>): VideoEffects;
+//# sourceMappingURL=video-effects.d.ts.map

package/dist/esm/video-effects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"video-effects.d.ts","sourceRoot":"","sources":["../../src/video-effects.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,OAAO,EAWL,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE3D,YAAY,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEjH,yGAAyG;AACzG,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C,+FAA+F;AAC/F,eAAO,MAAM,uBAAuB,uHAAuH,CAAC;AAC5J;;;GAGG;AACH,eAAO,MAAM,uBAAuB,2IAA2I,CAAC;AAEhL,MAAM,WAAW,mBAAmB;IAClC,gHAAgH;IAChH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oHAAoH;IACpH,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,GAAG,IAAI,CAAC;IACxC;gGAC4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;gEAC4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;CAC5C;AAED,sDAAsD;AACtD,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,EAAE,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC,CAAC;AAE7F,MAAM,WAAW,YAAa,SAAQ,mBAAmB;IACvD;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE;QAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;KAAE,CAAC;IAC1G,6GAA6G;IAC7G,QAAQ,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,OAAO,CAAA;KAAE,CAAC;CAClF;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,qHAAqH;IACrH,OAAO,CAAC,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI,CAAC;IACnG,KAAK,IAAI,IAAI,CAAC;CACf;AAED,6BAA6B;AAC7B,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5E,2FAA2F;IAC3F,IAAI,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC;CAChC;AAED,iGAAiG;AACjG,wBAAgB,uBAAuB,IAAI,OAAO,CAWjD;AAwND,uEAAuE;AACvE,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,mBAAwB,EAAE,KAAK,GAAE,OAAO,CAAC,gBAAgB,CAAM,GAAG,YAAY,CA0NzH"}