Skip to content

VideoFilterManager

Adnan Mujagić edited this page Jun 21, 2024 · 2 revisions

The video filter manager, mainly used to emit video filter specific errors that do not occur synchronously, and to perform operations on the dedicated video filter DispatchQueue.



videoFilter

Description

Read-only property representing the inner VideoFilter performing the filtering logic.

Returns



filterQueue

Description

Read-only property representing the video filter DispatchQueue. Use this reference for operations that must be performed on the same queue as video filtering (e.g. changing your video filter options). Only valid while the video filter is running (i.e. after start and before stop have been invoked).

Returns

  • DispatchQueue - A reference to the dispatch queue responsible for performing video filter specific operations.



notifyError(videoFilterError)

Description

If the video filter encounters an unrecoverable error which wasn't thrown synchronously during initialization, it should be reported through this method. Once called, the video filter will be stopped and removed, falling back to the unfiltered video stream.

Returns

  • N/A



configureFramerate(filterFps)

Description

Configure 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 at a lower framerate than the source, 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.

Returns

  • N/A

Tutorials

Migration guides

Reference documentation

Clone this wiki locally