@stream-io/video-filters-web 0.8.7 → 0.9.0

package/dist/src/VirtualBackground.d.ts

@@ -1,4 +1,4 @@
-import { BackgroundOptions, VideoTrackProcessorHooks } from './types';
+import { BackgroundEffectOptions, BackgroundOptions, VideoTrackProcessorHooks } from './types';
 import { BaseVideoProcessor } from './BaseVideoProcessor';
 /**
  * Wraps a video MediaStreamTrack in a real-time processing pipeline.
@@ -6,7 +6,7 @@ import { BaseVideoProcessor } from './BaseVideoProcessor';
  * on a new MediaStreamVideoTrack for downstream consumption.
  */
 export declare class VirtualBackground extends BaseVideoProcessor {
-    private readonly options;
+    private options;
     private segmenter;
     private isSegmenterReady;
     private webGlRenderer;
@@ -15,6 +15,7 @@ export declare class VirtualBackground extends BaseVideoProcessor {
     private latestConfidenceMask;
     private lastFrameTime;
     constructor(track: MediaStreamVideoTrack, options?: BackgroundOptions, hooks?: VideoTrackProcessorHooks);
+    updateOptions(options: BackgroundEffectOptions): Promise<void>;
     protected initialize(): Promise<void>;
     private initializeSegmenter;
     protected transform(frame: VideoFrame): Promise<VideoFrame>;

package/dist/src/types.d.ts

@@ -43,17 +43,19 @@ export interface SegmenterOptions {
     isSelfieMode: boolean;
     segmentationOptions?: SegmentationOptions;
 }
+export interface BackgroundEffectOptions {
+    backgroundFilter?: BackgroundFilter;
+    backgroundBlurLevel?: BackgroundBlurLevel;
+    backgroundImage?: string | undefined;
+    segmentationOptions?: SegmentationOptions;
+}
 /**
  * Static configuration for the processor, defining which background
  * effect should be applied and how it should behave.
  */
-export interface BackgroundOptions {
+export interface BackgroundOptions extends BackgroundEffectOptions {
     basePath?: string;
     modelPath?: string;
-    backgroundFilter?: BackgroundFilter;
-    backgroundBlurLevel?: BackgroundBlurLevel;
-    backgroundImage?: string | undefined;
-    segmentationOptions?: SegmentationOptions;
 }
 /**
  * Performance statistics for video processing.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-filters-web",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "main": "./dist/index.cjs.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/index.d.ts",

package/src/VirtualBackground.ts

@@ -1,5 +1,6 @@
 import {
   BACKGROUND_BLUR_MAP,
+  BackgroundEffectOptions,
   BackgroundOptions,
   SegmenterOptions,
   VideoTrackProcessorHooks,
@@ -27,12 +28,35 @@ export class VirtualBackground extends BaseVideoProcessor {
 
   constructor(
     track: MediaStreamVideoTrack,
-    private readonly options: BackgroundOptions = {},
+    private options: BackgroundOptions = {},
     hooks: VideoTrackProcessorHooks = {},
   ) {
     super(track, hooks);
   }
 
+  async updateOptions(options: BackgroundEffectOptions): Promise<void> {
+    const { basePath, modelPath } = this.options;
+    const previous = this.options;
+    const next = { basePath, modelPath, ...options };
+    this.options = next;
+    try {
+      const opts = await this.initializeSegmenterOptions();
+      if (this.options === next) {
+        const previousMedia = this.opts?.backgroundSource?.media;
+        this.opts = opts;
+        if (
+          previousMedia instanceof ImageBitmap &&
+          previousMedia !== opts.backgroundSource?.media
+        ) {
+          previousMedia.close();
+        }
+      }
+    } catch (error) {
+      if (this.options === next) this.options = previous;
+      throw error;
+    }
+  }
+
   protected async initialize(): Promise<void> {
     this.webGlRenderer = new WebGLRenderer(this.canvas);
 
@@ -146,6 +170,10 @@ export class VirtualBackground extends BaseVideoProcessor {
 
   private async loadBackground(url?: string) {
     if (!url) return null;
+
+    const current = this.opts?.backgroundSource;
+    if (current?.url === url) return current;
+
     const result = await fetch(url, { signal: this.abortController.signal });
     if (!result.ok) {
       throw new Error(

package/src/types.ts

@@ -47,17 +47,20 @@ export interface SegmenterOptions {
   isSelfieMode: boolean;
   segmentationOptions?: SegmentationOptions;
 }
+export interface BackgroundEffectOptions {
+  backgroundFilter?: BackgroundFilter;
+  backgroundBlurLevel?: BackgroundBlurLevel;
+  backgroundImage?: string | undefined;
+  segmentationOptions?: SegmentationOptions;
+}
+
 /**
  * Static configuration for the processor, defining which background
  * effect should be applied and how it should behave.
  */
-export interface BackgroundOptions {
+export interface BackgroundOptions extends BackgroundEffectOptions {
   basePath?: string;
   modelPath?: string;
-  backgroundFilter?: BackgroundFilter;
-  backgroundBlurLevel?: BackgroundBlurLevel;
-  backgroundImage?: string | undefined;
-  segmentationOptions?: SegmentationOptions;
 }
 
 /**