-
Notifications
You must be signed in to change notification settings - Fork 3
VideoFilter
Note: Your video filter implementation needs to implement this protocol. For example implementations that fit common use cases, take a look at our
RTC extensions library.
start(_ resolution: CGSize, _ sourceFps: Int, _ videoFilterManager: VideoFilterManager) throwsapplyFilter(_ ciImage: CIImage, _ rotation: Int, _ timeStampNs: Int, _ completion: @escaping (_ ciImage: CIImage) -> Void) throwsstop()
Initialize the video filter with the specified parameters and prepare to process video frames.
-
resolution:CGSize- A structure that contains width and height values of the source camera stream. -
sourceFps:Int- The framerate of the source camera stream. -
videoFilterManager:VideoFilterManager- The video filter manager currently using this video filter.
N/A
Called once per frame. This should execute the filter logic and generate a new frame containing the filtered frame to use as video output. Once the filtered frame is ready, the video filter should be notified through completion handler. The supplied frame is encoded and sent as video output.
-
ciImage:CIImage?- The raw image that the filtering logic should be performed on. -
rotation:Int- The rotation of the frame. Useful if your filtering logic needs to know whether the video isn't upright (e.g. device is upside down). -
timeStampNs:Int- Timestamp of the frame in nanoseconds. -
completion:(ciImage: CIImage) -> Void- The completion which should be called to supply a filtered image. The suppliedCIImageis then encoded and sent as video output.
N/A
Stop the video filter. All associated resources should be deallocated as the video filter may not be started again and
the instance could be discarded. A stopped filter may be started again, using the start method. This method is
guaranteed to be called exactly once after each invocation of start, including if the initialization fails.
none
N/A