@webex/web-media-effects-types 2.21.4 → 2.22.0

package/index.d.ts

@@ -47,6 +47,9 @@ interface EffectEventCallback {
     [EffectEvent.Disposed]: () => void;
 }
 interface EffectOptions {
+    baseUrl?: string;
+    authToken?: string;
+    env?: EffectEnv;
     [key: string]: unknown;
 }
 declare abstract class BaseEffect extends EventEmitter<EffectEventCallback> implements TrackEffect {
@@ -111,14 +114,13 @@ declare enum NoiseReductionMode {
     Worklet = "WORKLET"
 }
 interface NoiseReductionEffectOptions extends EffectOptions {
-    authToken: string;
     audioContext?: AudioContext;
-    mode?: NoiseReductionMode;
-    env?: EffectEnv;
     avoidSimd?: boolean;
-    workletProcessorUrl?: string;
+    mode?: NoiseReductionMode;
     legacyProcessorUrl?: string;
-}
+    workletProcessorUrl?: string;
+}
+
 declare class NoiseReductionEffect extends BaseMicrophoneEffect {
     static readonly kind = "noise-reduction-effect";
     static supportsSimd: () => Promise<boolean>;
@@ -264,6 +266,25 @@ declare enum VirtualBackgroundMode {
     Image = "IMAGE",
     Video = "VIDEO"
 }
+type LadonOverrides = {
+    modelUri?: string;
+    modelRank?: number;
+    workerUri?: string;
+    executionProviders?: string[];
+    inputSize?: {
+        width: number;
+        height: number;
+    };
+    outputSize?: {
+        width: number;
+        height: number;
+    };
+    upscaleSize?: {
+        width: number;
+        height: number;
+    };
+    modelUrlResolver?: (modelPath: string) => Promise<string>;
+};
 interface VirtualBackgroundEffectOptions extends EffectOptions {
     generator: Generator;
     mode: VirtualBackgroundMode;
@@ -272,12 +293,10 @@ interface VirtualBackgroundEffectOptions extends EffectOptions {
     blurStrength?: BlurStrength;
     bgImageUrl?: string;
     bgVideoUrl?: string;
-    authToken: string;
     mirror: boolean;
-    env?: EffectEnv;
     preventBackgroundThrottling?: boolean;
-    useLocalSegmentationWorker?: boolean;
     canvasResolutionScaling?: number;
+    modelOverrides?: LadonOverrides;
 }
 
 declare const DEFAULT_FRAME_RATE = 24;
@@ -310,6 +329,7 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     private afterInferenceCallbacks;
     private offscreenCanvas?;
     private inputCanvasContext?;
+    private configBuilder;
     get isReady(): boolean;
     get isLoaded(): boolean;
     get frameRate(): number;
@@ -323,6 +343,7 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     private requestAnimationFrameWrapper;
     private setTimeoutWrapper;
     private clearTimers;
+    private configureBuilder;
     private createPipeline;
     private loadModel;
     private handleFrame;
@@ -335,7 +356,7 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     private handleOrientationChange;
     private handleVideoLoadedMetadata;
     private handleVideoResize;
-    private handleModelResolver;
+    private handleAssetUrlResolver;
     enable(): Promise<boolean>;
     disable(): Promise<boolean>;
     dispose(): Promise<void>;
@@ -556,4 +577,4 @@ declare class SkippedFrameRatePlugin extends BaseAfterInferencePlugin {
 declare const logger: js_logger.ILogger;
 //# sourceMappingURL=logger.d.ts.map
 
-export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_FRAME_RATE, EffectEnv, EffectEvent, EffectEventCallback, EffectOptions, EffectState, FrameSkipperDebugInfo, FrameSkipperInferenceReason, FrameSkipperOptions, FrameSkipperPlugin, FrameSkipperPluginMode, FrameSkipperPluginOptions, GainEffect, MediaStreamOrTrack, NoiseReductionEffect, NoiseReductionEffectOptions, NoiseReductionMode, RateEstimatedValues, RateEstimationPlugin, RateEstimationPluginOptions, RateEstimator, RateEstimatorEvent, RateEstimatorEventCallback, RateEstimatorOptions, RateEstimatorStatus, SkippedFrameRatePlugin, TrackEffect, VirtualBackgroundEffect, VirtualBackgroundEffectOptions, VirtualBackgroundMode, createEffect, createNoiseReductionEffect, createVirtualBackgroundEffect, getOptionsByMode, logger, makeBeRightBackOptions, makeFrameSkipperOptions };
+export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_FRAME_RATE, EffectEnv, EffectEvent, EffectEventCallback, EffectOptions, EffectState, FrameSkipperDebugInfo, FrameSkipperInferenceReason, FrameSkipperOptions, FrameSkipperPlugin, FrameSkipperPluginMode, FrameSkipperPluginOptions, GainEffect, LadonOverrides, MediaStreamOrTrack, NoiseReductionEffect, NoiseReductionEffectOptions, NoiseReductionMode, RateEstimatedValues, RateEstimationPlugin, RateEstimationPluginOptions, RateEstimator, RateEstimatorEvent, RateEstimatorEventCallback, RateEstimatorOptions, RateEstimatorStatus, SkippedFrameRatePlugin, TrackEffect, VirtualBackgroundEffect, VirtualBackgroundEffectOptions, VirtualBackgroundMode, createEffect, createNoiseReductionEffect, createVirtualBackgroundEffect, getOptionsByMode, logger, makeBeRightBackOptions, makeFrameSkipperOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/web-media-effects-types",
-  "version": "2.21.4",
+  "version": "2.22.0",
   "description": "TypeScript definitions for @webex/web-media-effects",
   "main": "",
   "types": "index.d.ts",