Interface BackgroundReplacementProcessor

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

interface BackgroundReplacementProcessor {
    addObserver(
        observer: BackgroundReplacementVideoFrameProcessorObserver,
    ): void;
    destroy(): Promise<void>;
    loadAssets(): Promise<void>;
    process(buffers: VideoFrameBuffer[]): Promise<VideoFrameBuffer[]>;
    removeObserver(
        observer: BackgroundReplacementVideoFrameProcessorObserver,
    ): void;
    setEventController(eventController: EventController): void;
    setImageBlob(blob: Blob): Promise<void>;
}

Hierarchy (View Summary)

VideoFrameProcessor
- BackgroundReplacementProcessor

Index

Methods

addObserver destroy loadAssets process removeObserver setEventController? setImageBlob

Methods

addObserver

addObserver(observer: BackgroundReplacementVideoFrameProcessorObserver): void
Add an observer to receive notifications about Amazon background replacement processor events. See BackgroundReplacementVideoFrameProcessorObserver for details. If the observer has already been added, this method call has no effect.
Parameters
- observer: BackgroundReplacementVideoFrameProcessorObserver
Returns void
- Defined in src/backgroundreplacementprocessor/BackgroundReplacementProcessor.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/backgroundreplacementprocessor/BackgroundReplacementProcessor.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: BackgroundReplacementVideoFrameProcessorObserver): void
Remove an existing observer. If the observer has not been previously added via addObserver, this method call has no effect.
Parameters
- observer: BackgroundReplacementVideoFrameProcessorObserver
Returns void
- Defined in src/backgroundreplacementprocessor/BackgroundReplacementProcessor.ts:22

`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

setImageBlob

setImageBlob(blob: Blob): Promise<void>
The method will allow the builder to update the image blob mid stream.
Parameters
- blob: Blob
Returns Promise<void>
- Defined in src/backgroundreplacementprocessor/BackgroundReplacementProcessor.ts:28