Interface BackgroundBlurProcessor

Interface to define extra methods that need to be implemented for background blur processing

interface BackgroundBlurProcessor {
    addObserver(observer: BackgroundBlurVideoFrameProcessorObserver): void;
    destroy(): Promise<void>;
    loadAssets(): Promise<void>;
    process(buffers: VideoFrameBuffer[]): Promise<VideoFrameBuffer[]>;
    removeObserver(observer: BackgroundBlurVideoFrameProcessorObserver): void;
    setBlurStrength(blurStrength: number): void;
    setEventController(eventController: EventController): void;
}

Hierarchy (View Summary)

VideoFrameProcessor
- BackgroundBlurProcessor

Index

Methods

addObserver destroy loadAssets process removeObserver setBlurStrength setEventController?

Methods

addObserver

addObserver(observer: BackgroundBlurVideoFrameProcessorObserver): void
Add an observer to receive notifications about Amazon background blur processor events. See BackgroundBlurVideoFrameProcessorObserver for details. If the observer has already been added, this method call has no effect.
Parameters
- observer: BackgroundBlurVideoFrameProcessorObserver
Returns void
- Defined in src/backgroundblurprocessor/BackgroundBlurProcessor.ts:16

destroy

destroy(): Promise<void>
Destroys the processor.

Returns Promise<void>
Inherited from VideoFrameProcessor.destroy
- Defined in src/videoframeprocessor/VideoFrameProcessor.ts:22

loadAssets

loadAssets(): Promise<void>
internal method to load assets like WASM files, web workers, and ML models.

Returns Promise<void>
- Defined in src/backgroundblurprocessor/BackgroundBlurProcessor.ts:34

process

process(buffers: VideoFrameBuffer[]): Promise<VideoFrameBuffer[]>
Processes the array of VideoFrameBuffer and returns an array of VideoFrameBuffer.
Parameters
- buffers: VideoFrameBuffer[]
Returns Promise<VideoFrameBuffer[]>
Inherited from VideoFrameProcessor.process
- Defined in src/videoframeprocessor/VideoFrameProcessor.ts:17

removeObserver

removeObserver(observer: BackgroundBlurVideoFrameProcessorObserver): void
Remove an existing observer. If the observer has not been previously added via addObserver, this method call has no effect.
Parameters
- observer: BackgroundBlurVideoFrameProcessorObserver
Returns void
- Defined in src/backgroundblurprocessor/BackgroundBlurProcessor.ts:22

setBlurStrength

setBlurStrength(blurStrength: number): void
This setter will allow setting the blur strength mid stream. The process method will use this setting on the next frame that is processed.
Parameters
- blurStrength: number
Returns void
- Defined in src/backgroundblurprocessor/BackgroundBlurProcessor.ts:28

`Optional`setEventController

setEventController(eventController: EventController): void
Set the EventController to the VideoFrameProcessor
Parameters
- eventController: EventController
Returns void
Inherited from VideoFrameProcessor.setEventController
- Defined in src/videoframeprocessor/VideoFrameProcessor.ts:28