Interface VideoFrameProcessor

[[VideoFrameProcessor]] is defined as a unit of video processing. It transforms an array of VideoFrameBuffer and produces an array of VideoFrameBuffer. It can be chained together to be used with VideoFrameProcessorPipeline.

interface VideoFrameProcessor {
    destroy(): Promise<void>;
    process(buffers: VideoFrameBuffer[]): Promise<VideoFrameBuffer[]>;
    setEventController(eventController: EventController): void;
}

Hierarchy (View Summary)

Destroyable
- VideoFrameProcessor
  - BackgroundBlurProcessor
  - BackgroundReplacementProcessor

Implemented by

Index

Methods

destroy process setEventController?

Methods

destroy

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

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

process

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

`Optional`setEventController

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