@webex/web-media-effects-types 2.32.9 → 2.33.0

package/index.d.ts

@@ -39,13 +39,15 @@ declare enum EffectEvent {
     TrackUpdated = "track-updated",
     Enabled = "enabled",
     Disabled = "disabled",
-    Disposed = "disposed"
+    Disposed = "disposed",
+    ModelChanged = "model-changed"
 }
 interface EffectEventCallback {
     [EffectEvent.TrackUpdated]: (track: MediaStreamTrack) => void;
     [EffectEvent.Enabled]: () => void;
     [EffectEvent.Disabled]: () => void;
     [EffectEvent.Disposed]: () => void;
+    [EffectEvent.ModelChanged]: (model: string) => void;
 }
 interface EffectOptions {
     baseUrl?: string;
@@ -115,15 +117,23 @@ declare enum NoiseReductionMode {
     Legacy = "LEGACY",
     Worklet = "WORKLET"
 }
+declare const NoiseReductionModels: {
+    readonly BNR: "bnr";
+    readonly ST: "st";
+};
+declare type NoiseReductionModel = (typeof NoiseReductionModels)[keyof typeof NoiseReductionModels];
+declare const DEFAULT_NOISE_REDUCTION_MODEL: NoiseReductionModel;
 interface NoiseReductionEffectOptions extends EffectOptions {
     audioContext?: AudioContext;
     avoidSimd?: boolean;
     mode?: NoiseReductionMode;
     legacyProcessorUrl?: string;
     workletProcessorUrl?: string;
+    model?: NoiseReductionModel;
 }
 
 declare class NoiseReductionEffect extends BaseMicrophoneEffect {
+    private static readonly UNKNOWN_MODEL_LABEL;
     static readonly kind = "noise-reduction-effect";
     static supportsSimd: () => Promise<boolean>;
     static Events: {
@@ -132,6 +142,8 @@ declare class NoiseReductionEffect extends BaseMicrophoneEffect {
         Disposed: string;
         Enabled: string;
         Error: string;
+        ModelChanged: string;
+        Warning: string;
     };
     sourceNode?: MediaStreamAudioSourceNode;
     workletNode?: AudioWorkletNode;
@@ -139,12 +151,16 @@ declare class NoiseReductionEffect extends BaseMicrophoneEffect {
     legacyScriptNode?: ScriptProcessorNode;
     isReady: boolean;
     options: Partial<NoiseReductionEffectOptions>;
+    private currentModel;
+    private previousAgcState;
+    private modelChangeFuture?;
     private disableFuture;
     private enableFuture;
     private processorLoadFuture?;
     private loadFuture?;
     private disposeFuture?;
     get isLoaded(): boolean;
+    get model(): NoiseReductionModel;
     constructor(options?: Partial<NoiseReductionEffectOptions>);
     private fetchUrl;
     loadMediaStream(input: MediaStream): Promise<MediaStream>;
@@ -161,6 +177,9 @@ declare class NoiseReductionEffect extends BaseMicrophoneEffect {
     dispose(): Promise<void>;
     handleDisabled(): Promise<void>;
     handleEnabled(): Promise<void>;
+    setModel(model: NoiseReductionModel): Promise<void>;
+    private handleModelChanged;
+    private handleAgcForModel;
     private logInputDiagnostics;
     private logOutputResampleCheck;
     updateSampleRate(sampleRate: number): void;
@@ -715,4 +734,4 @@ declare function setLogLevel(level: ILogLevel): void;
 declare function setLogHandler(logHandler: ILogHandler): void;
 //# sourceMappingURL=logger.d.ts.map
 
-export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_DEBUG_OVERLAY_OPTIONS, DEFAULT_FRAME_RATE, DebugOverlay, DebugOverlayCoreOptions, DebugOverlayPlugin, DebugOverlayPluginOptions, 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, setLogHandler, setLogLevel };
+export { AdaptiveFrameSkipper, BaseCameraEffect, BaseEffect, BaseMicrophoneEffect, BeRightBack, BeRightBackAction, BeRightBackDebugInfo, BeRightBackEvent, BeRightBackEventCallback, BeRightBackOptions, BeRightBackPlugin, BeRightBackPluginMode, BeRightBackPluginOptions, BeRightBackState, DEFAULT_DEBUG_OVERLAY_OPTIONS, DEFAULT_FRAME_RATE, DEFAULT_NOISE_REDUCTION_MODEL, DebugOverlay, DebugOverlayCoreOptions, DebugOverlayPlugin, DebugOverlayPluginOptions, EffectEnv, EffectEvent, EffectEventCallback, EffectOptions, EffectState, FrameSkipperDebugInfo, FrameSkipperInferenceReason, FrameSkipperOptions, FrameSkipperPlugin, FrameSkipperPluginMode, FrameSkipperPluginOptions, GainEffect, LadonOverrides, MediaStreamOrTrack, NoiseReductionEffect, NoiseReductionEffectOptions, NoiseReductionMode, NoiseReductionModel, NoiseReductionModels, RateEstimatedValues, RateEstimationPlugin, RateEstimationPluginOptions, RateEstimator, RateEstimatorEvent, RateEstimatorEventCallback, RateEstimatorOptions, RateEstimatorStatus, SkippedFrameRatePlugin, TrackEffect, VirtualBackgroundEffect, VirtualBackgroundEffectOptions, VirtualBackgroundMode, createEffect, createNoiseReductionEffect, createVirtualBackgroundEffect, getOptionsByMode, logger, makeBeRightBackOptions, makeFrameSkipperOptions, setLogHandler, setLogLevel };

package/package.json

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