Inherits IVideoFilter.
◆ setEnabled()
virtual void setEnabled |
( |
bool |
enable | ) |
|
|
inlinevirtualinherited |
Enables or disables the video filter.
- Parameters
-
enable | Whether to enable the video filter:
true : (Default) Enable the video filter.
false : Do not enable the video filter. If the filter is disabled, frames will be passed without adaption.
|
◆ isEnabled()
virtual bool isEnabled |
( |
| ) |
|
|
inlinevirtualinherited |
Checks whether the video filter is enabled.
- Returns
true
: The video filter is enabled.
false
: The video filter is not enabled.
◆ setProperty()
virtual int setProperty |
( |
const char * |
key, |
|
|
const void * |
buf, |
|
|
size_t |
buf_size |
|
) |
| |
|
inlinevirtualinherited |
Sets a private property in the IVideoFilter
class.
- Parameters
-
key | The pointer to the property name. |
buf | The pointer to the buffer of this private property. |
buf_size | The buffer size of this private property. |
- Returns
- The actual size of the private property, if the method call succeeds.
- -1, if the method call fails.
◆ getProperty()
virtual int getProperty |
( |
const char * |
key, |
|
|
void * |
buf, |
|
|
size_t |
buf_size |
|
) |
| |
|
inlinevirtualinherited |
Gets a private property in the IVideoFilter class.
- Parameters
-
key | The pointer to the property name. |
buf | The pointer to the buffer of this private property. |
buf_size | The buffer size of this private property. |
- Returns
- The actual size of the private property, if the method call succeeds.
- -1, if the method call fails.
◆ onDataStreamWillStart()
virtual bool onDataStreamWillStart |
( |
| ) |
|
|
inlinevirtualinherited |
This function is invoked right before data stream starts. Custom filter can override this function for initialization.
- Returns
true
: The initialization succeeds.
false
: The initialization fails.
◆ onDataStreamWillStop()
virtual void onDataStreamWillStop |
( |
| ) |
|
|
inlinevirtualinherited |
This function is invoked right before data stream stops. Custom filter can override this function for deinitialization.
◆ isExternal()
virtual bool isExternal |
( |
| ) |
|
|
inlinevirtualinherited |
This function indicates if the filter is for internal use.
- Note
- Do not override this function.
- Returns
true
: The filter is implemented by external users.
false
: The filter is implemented by internal users.
◆ isExtensionFilter()
virtual bool isExtensionFilter |
( |
| ) |
|
|
inlinevirtualinherited |
This function indicates if the filter is implemented by third-party providers.
- Note
- Do not override this function.
- Returns
true
: The filter is implemented by third-party providers.
false
: otherwise.
Reimplemented in IExtensionVideoFilter.
◆ adaptVideoFrame()
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 IExtensionVideoFilter.
◆ AddRef()
virtual void AddRef |
( |
| ) |
const |
|
pure virtualinherited |
◆ Release()
◆ HasOneRef()
virtual bool HasOneRef |
( |
| ) |
const |
|
pure virtualinherited |