agora::rtc::IRemoteVideoTrack Class Reference

#include <NGIAgoraVideoTrack.h>

Public Member Functions
virtual bool	getStatistics (RemoteVideoTrackStats &stats)=0
virtual REMOTE_VIDEO_STATE	getState ()=0
virtual bool	getTrackInfo (VideoTrackInfo &info)=0
virtual int	registerVideoEncodedImageReceiver (IVideoEncodedImageReceiver *videoReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int	unregisterVideoEncodedImageReceiver (IVideoEncodedImageReceiver *videoReceiver)=0
Public Member Functions inherited from agora::rtc::IVideoTrack
virtual bool	addRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_FILTERS, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool	removeRenderer (agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_FILTERS, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual VideoTrackType	getType ()=0

Protected Member Functions
	~IRemoteVideoTrack ()
Protected Member Functions inherited from agora::rtc::IVideoTrack
	~IVideoTrack ()

Detailed Description

The IRemoteVideoTrack class.

Constructor & Destructor Documentation

~IRemoteVideoTrack()

agora::rtc::IRemoteVideoTrack::~IRemoteVideoTrack ( )

inlineprotected

Member Function Documentation

getState()

virtual REMOTE_VIDEO_STATE agora::rtc::IRemoteVideoTrack::getState ( )

pure virtual

Gets the state of the remote video track.

Returns

The state of the remote video track.

getStatistics()

virtual bool agora::rtc::IRemoteVideoTrack::getStatistics ( RemoteVideoTrackStats &  stats )

pure virtual

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.

getTrackInfo()

virtual bool agora::rtc::IRemoteVideoTrack::getTrackInfo ( VideoTrackInfo &  info )

pure virtual

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.

registerVideoEncodedImageReceiver()

virtual int agora::rtc::IRemoteVideoTrack::registerVideoEncodedImageReceiver ( IVideoEncodedImageReceiver *  videoReceiver, aosl_ref_t  ares = AOSL_REF_INVALID  )

pure virtual

Registers an IVideoEncodedImageReceiver object.

You need to implement the IVideoEncodedImageReceiver class in this method. Once you successfully register the encoded image receiver, the SDK triggers the onEncodedVideoImageReceived callback when it receives the encoded video image.

Parameters

videoReceiver	The pointer to the IVideoEncodedImageReceiver object.
ares	This parameter is used for the SDK lifecycle protection. Fill in the default value.

Returns

• 0: Success.
• < 0: Failure.

unregisterVideoEncodedImageReceiver()

virtual int agora::rtc::IRemoteVideoTrack::unregisterVideoEncodedImageReceiver ( IVideoEncodedImageReceiver *  videoReceiver )

pure virtual

Releases the IVideoEncodedImageReceiver object.

Parameters

videoReceiver

The pointer to the IVideoEncodedImageReceiver object.

Returns

• 0: Success.
• < 0: Failure.

---

The documentation for this class was generated from the following file:

• NGIAgoraVideoTrack.h