@webex/web-media-effects-types 2.28.2 → 2.29.0

package/index.d.ts

@@ -1,6 +1,6 @@
 import TypedEmitter from 'typed-emitter';
-import { IFrameInferenceResult, Generator, Quality, BlurStrength, Pipeline } from '@webex/ladon-ts';
-export { BlurStrength, Generator, Quality } from '@webex/ladon-ts';
+import { IFrameInferenceResult, Quality, BlurStrength, Pipeline } from '@webex/ladon-ts';
+export { BlurStrength, Quality } from '@webex/ladon-ts';
 import * as js_logger from 'js-logger';
 export { default as Logger } from 'js-logger';
 
@@ -276,6 +276,7 @@ declare type LadonOverrides = {
     modelRank?: number;
     workerUri?: string;
     executionProviders?: string[];
+    generationIntervalMs?: number;
     inputSize?: {
         width: number;
         height: number;
@@ -291,7 +292,6 @@ declare type LadonOverrides = {
     modelUrlResolver?: (modelPath: string) => Promise<string>;
 };
 interface VirtualBackgroundEffectOptions extends EffectOptions {
-    generator: Generator;
     mode: VirtualBackgroundMode;
     quality: Quality;
     frameRate?: number;
@@ -324,8 +324,8 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     private preloadFuture?;
     private loadFuture?;
     private disposeFuture?;
+    private updateFuture?;
     private lastFrameTime;
-    private frameInterval;
     private restoreEffectOnTrackEnable;
     private setTimeoutId?;
     private rafId?;
@@ -339,6 +339,7 @@ declare class VirtualBackgroundEffect extends BaseCameraEffect {
     get isReady(): boolean;
     get isLoaded(): boolean;
     get frameRate(): number;
+    get frameInterval(): number;
     constructor(options?: Partial<VirtualBackgroundEffectOptions>);
     preloadAssets(): Promise<void>;
     loadMediaStream(input: MediaStream): Promise<MediaStream>;
@@ -384,6 +385,7 @@ declare abstract class BaseInferencePlugin<T, O> {
     protected core: T;
     protected options: O;
     protected isEffectEnabled: boolean;
+    protected baseInferenceCleanup?: () => void;
     isInitialized: boolean;
     constructor(options?: Partial<O>);
     initialize(effect: VirtualBackgroundEffect): void;
@@ -408,6 +410,7 @@ declare abstract class BaseEventEmitterPlugin<T extends EventEmitter<unknown>, O
 }
 
 declare abstract class BaseAfterInferencePlugin<T extends EventEmitter<unknown> = EventEmitter<unknown>, O extends object = Record<string, never>> extends BaseEventEmitterPlugin<T, O> {
+    private afterInferenceCleanup?;
     constructor(options?: Partial<O>);
     initialize(effect: VirtualBackgroundEffect): void;
     dispose(): void;
@@ -515,6 +518,7 @@ interface RateEstimatedValues {
     rate?: number;
     status: RateEstimatorStatus;
     threshold: number;
+    targetRate: number;
 }
 interface RateEstimatorOptions {
     hysteresisMargin: number;
@@ -522,6 +526,7 @@ interface RateEstimatorOptions {
     lowThreshold: number;
     minSamples: number;
     maxSamples: number;
+    targetRate: number;
 }
 declare enum RateEstimatorEvent {
     RateOk = "rate-ok",
@@ -567,9 +572,11 @@ declare class RateEstimationPlugin extends BaseAfterInferencePlugin<RateEstimato
     onEffectEnabled(): void;
     destroyCore(): void;
     onAfterInference(timestamp: number): Promise<void>;
+    onOptionsUpdated(): void;
     getRate(): number | undefined;
     getThreshold(): number | undefined;
     getStatus(): RateEstimatorStatus | undefined;
+    getTargetRate(): number | undefined;
 }
 
 declare class SkippedFrameRatePlugin extends BaseAfterInferencePlugin {

package/package.json

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