Inherits IVideoTrack.
|
virtual bool | getStatistics (RemoteVideoTrackStats &stats)=0 |
|
virtual REMOTE_VIDEO_STATE | getState ()=0 |
|
virtual bool | getTrackInfo (VideoTrackInfo &info)=0 |
|
virtual int | registerVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *encodedObserver)=0 |
|
virtual int | unregisterVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *encodedObserver)=0 |
|
virtual int | registerMediaPacketReceiver (IMediaPacketReceiver *videoReceiver)=0 |
|
virtual int | unregisterMediaPacketReceiver (IMediaPacketReceiver *videoReceiver)=0 |
|
virtual VideoTrackType | getType () OPTIONAL_OVERRIDE |
|
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_POST_FILTERS)=0 |
|
virtual bool | removeRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_FILTERS)=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) |
|
◆ ~IRemoteVideoTrack()
◆ getStatistics()
Gets the statistics of the remote video track.
- Parameters
-
[out] | stats | The reference to the statistics of the remote video track. |
- Returns
true
: Success.
false
: Failure.
◆ getState()
Gets the state of the remote video track.
- Returns
- The state of the remote video track.
◆ getTrackInfo()
Gets the information of the remote video track.
- Parameters
-
[out] | info | The reference to the information of the remote video track. |
- Returns
true
: Success.
false
: Failure.
◆ registerVideoEncodedFrameObserver()
Registers an IVideoEncodedFrameObserver object.
You need to implement the IVideoEncodedFrameObserver
class in this method. Once you successfully register the encoded image receiver, the SDK triggers the OnEncodedVideoFrameReceived callback when it receives the encoded video image.
- Parameters
-
encodedObserver | The pointer to the IVideoEncodedFrameObserver object. |
- Returns
- 0: Success.
- < 0: Failure.
◆ unregisterVideoEncodedFrameObserver()
Releases the IVideoEncodedFrameObserver object.
- Parameters
-
encodedObserver | The pointer to the IVideoEncodedFrameObserver object. |
- Returns
- 0: Success.
- < 0: Failure.
◆ registerMediaPacketReceiver()
◆ unregisterMediaPacketReceiver()
◆ getType()
Get the track type of the video track
- Returns
-
Implements IVideoTrack.
◆ 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.
◆ enableVideoFilter()
virtual int enableVideoFilter |
( |
const char * |
id, |
|
|
bool |
enable |
|
) |
| |
|
inlinevirtualinherited |
Enable / Disable specified video filter
- Parameters
-
id | id of the filter |
enable | enable / disable the filter with given id |
- Returns
-
◆ setFilterProperty()
virtual int setFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
const char * |
json_value |
|
) |
| |
|
inlinevirtualinherited |
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 getFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
char * |
json_value, |
|
|
size_t |
buf_size |
|
) |
| |
|
inlinevirtualinherited |
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
-
◆ AddRef()
virtual void AddRef |
( |
| ) |
const |
|
pure virtualinherited |
◆ Release()
◆ HasOneRef()
virtual bool HasOneRef |
( |
| ) |
const |
|
pure virtualinherited |