Agora C++ API Reference for All Platforms

Public Member Functions | List of all members
agora::rtc::IVideoFilterBase Class Referenceabstract

Inherits agora::RefCountInterface.

Inherited by agora::rtc::IVideoFilter.

## Public Member Functions
virtual bool | adaptVideoFrame (const media::base::VideoFrame &capturedFrame, media::base::VideoFrame &adaptedFrame)=0
Public Member Functions inherited from agora::RefCountInterface
virtual void | AddRef () const =0
virtual RefCountReleaseStatus | Release () const =0
virtual bool | HasOneRef () const =0

## Additional Inherited Members
Protected Member Functions inherited from agora::RefCountInterface
virtual | ~RefCountInterface ()

## Detailed Description

The `IVideoFilterBase` class is the base class for video filters. You can use this class to implement your own filter and add the filter to a video track.

## Member Function Documentation

## ◆ adaptVideoFrame()

virtual bool agora::rtc::IVideoFilterBase::adaptVideoFrame | ( | const media::base::VideoFrame & | capturedFrame,
|  | media::base::VideoFrame & | adaptedFrame
| ) |  |
| pure virtual

Adapts the video frame.

Parameters

  capturedFrame | The reference to the captured video frame that you want to adapt.
  adaptedFrame | The reference to the adapted video frame.

Returns
  - `true`: Success.
  - `false`: Failure, if, for example, the `IVideofilter` object drops the video frame.

Implemented in agora::rtc::IExtensionVideoFilter.