Skip to content

VideoFilterManager

Adnan Mujagić edited this page Jul 5, 2024 · 1 revision

The video filter manager handles all frame encoding and decoding, and manages the lifecycle of video filters. It ensures that video filter implementations only need to provide the image transformation logic and emit filtered frames.



getCurrentFramerate()

Description

Returns the effective framerate at which the currently active video filter produces frames.

Arguments

  • none

Returns

  • N/A



getVideoFilter()

Description

Returns the inner video filter performing the filtering logic.

Arguments

  • none

Returns



configureFramerate(filterFps)

Description

Configures what framerate the video filter should request filtered frames with. Doesn't affect the source framerate. The effective framerate is min(sourceFramerate, filterFramerate). If the filter is configured to operate on a lower framerate than the source generates, frameskipping will occur. For example, if the source feed is 30 fps, while the video filter is configured to operate at 15 fps, every second frame will be skipped to avoid hiccups while still meeting the requirements.

Arguments

  • filterFps: number - The requested framerate.

Returns

  • N/A

Tutorials

Migration guides

Reference documentation

Clone this wiki locally