Inherits agora::RefCountInterface.
Inherited by agora::rtc::ILocalVideoTrack, and agora::rtc::IRemoteVideoTrack.
|
virtual bool | addVideoFilter (agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL)=0 |
|
virtual bool | removeVideoFilter (agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL)=0 |
|
virtual bool | hasVideoFilter (const char *id, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER)=0 |
|
virtual bool | addRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_PRE_RENDERER)=0 |
|
virtual bool | removeRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_PRE_RENDERER)=0 |
|
virtual VideoTrackType | getType ()=0 |
|
virtual int | enableVideoFilter (const char *id, bool enable) |
|
virtual int | setFilterProperty (const char *id, const char *key, const char *json_value) |
|
virtual int | getFilterProperty (const char *id, const char *key, char *json_value, size_t buf_size) |
|
virtual void | AddRef () const =0 |
|
virtual RefCountReleaseStatus | Release () const =0 |
|
virtual bool | HasOneRef () const =0 |
|
The IVideoTrack
class defines the behavior and status of a video track.
◆ ~IVideoTrack()
agora::rtc::IVideoTrack::~IVideoTrack |
( |
| ) |
|
|
inlineprotected |
◆ addVideoFilter()
Adds a video filter to the video track.
Add a video filter in either of the following ways:
To add multiple filters, call this method multiple times. The order of the added filters depends on when the app successfully adds the filter.
- Parameters
-
filter | The video filter that you want to add to the video track. |
position | The position where the filter is added. |
id | id of the filter |
- Returns
true
: The video filter is added successfully.
false
: The video filter fails to be added.
◆ removeVideoFilter()
Removes the video filter added by addVideoFilter
from the video track.
- Parameters
-
filter | The video filter that you want to remove: IVideoFilter . |
position | The position of the filter. @id id of the filter |
- Returns
true
: The video filter is removed successfully.
false
: The video filter fails to be removed.
◆ hasVideoFilter()
Whether a video filter exists
- Parameters
-
- Returns
- true: exist
- false: not exist
◆ addRenderer()
Adds a video renderer to the video track.
Add a video renderer in either of the following ways:
- Parameters
-
videoRenderer | The video renderer that you want to add: IVideoSinkBase. |
position | The position where the renderer is added. |
- Returns
true
: The video renderer is added successfully.
false
: The video renderer fails to be added.
◆ removeRenderer()
Removes the video renderer added by addRenderer
from the video track.
- Parameters
-
- Returns
true
: The video renderer is removed successfully.
false
: The video renderer fails to be removed.
◆ getType()
◆ enableVideoFilter()
virtual int agora::rtc::IVideoTrack::enableVideoFilter |
( |
const char * |
id, |
|
|
bool |
enable |
|
) |
| |
|
inlinevirtual |
Enable / Disable specified video filter
- Parameters
-
id | id of the filter |
enable | enable / disable the filter with given id |
- Returns
-
◆ setFilterProperty()
virtual int agora::rtc::IVideoTrack::setFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
const char * |
json_value |
|
) |
| |
|
inlinevirtual |
set the properties of the specified video filter
- Parameters
-
id | id of the filter |
key | key of the property |
json_value | json str value of the property |
- Returns
-
◆ getFilterProperty()
virtual int agora::rtc::IVideoTrack::getFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
char * |
json_value, |
|
|
size_t |
buf_size |
|
) |
| |
|
inlinevirtual |
get the properties of the specified video filter
- Parameters
-
id | id of the filter |
key | key of the property |
json_value | json str value of the property |
- Returns
-