Agora C++ API Reference for All Platforms
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
agora::rtc::ILocalVideoTrackEx Class Referenceabstract

Inherits agora::rtc::ILocalVideoTrack.

Classes

struct  AttachInfo
 
struct  DetachInfo
 
struct  RsfecConfig
 
struct  VQCParametersCollection
 

Public Types

enum  DetachReason { MANUAL, TRACK_DESTROY, NETWORK_DESTROY }
 

Public Member Functions

 ILocalVideoTrackEx ()
 
virtual ~ILocalVideoTrackEx ()
 
virtual bool hasPublished ()=0
 
virtual int SetVideoConfigEx (const VideoConfigurationEx &configEx, utils::ConfigPriority priority=utils::CONFIG_PRIORITY_USER)=0
 
virtual int GetConfigExs (std::vector< VideoConfigurationEx > &configs)=0
 
virtual int setUserId (uid_t uid)
 
virtual uid_t getUserId ()
 
virtual int getObserverSize ()
 
virtual int GetActiveStreamsCount ()=0
 
virtual int prepareNodes ()=0
 
virtual bool attach (const AttachInfo &info)=0
 
virtual bool detach (const DetachInfo &info)=0
 
virtual bool registerTrackObserver (std::shared_ptr< IVideoTrackObserver > observer)
 
virtual bool unregisterTrackObserver (IVideoTrackObserver *observer)
 
virtual bool getStatisticsEx (LocalVideoTrackStatsEx &statsEx)=0
 
virtual int32_t Width () const =0
 
virtual int32_t Height () const =0
 
virtual bool Enabled () const =0
 
virtual int addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)
 
virtual int clearVideoWatermarks ()
 
virtual VideoTrackConfigurator * GetVideoTrackConfigurator ()
 
virtual InternalVideoSourceType getInternalVideoSourceType ()
 
int TrackId () const
 
void setUniqueId (const std::string &unique_id)
 
- Public Member Functions inherited from agora::rtc::ILocalVideoTrack
virtual void setEnabled (bool enable)=0
 
virtual int setVideoEncoderConfiguration (const VideoEncoderConfiguration &config)=0
 
virtual int enableSimulcastStream (bool enabled, const SimulcastStreamConfig &config)=0
 
virtual int updateSimulcastStreamConfig (const SimulcastStreamConfig &config)=0
 
virtual LOCAL_VIDEO_STREAM_STATE getState ()=0
 
virtual bool getStatistics (LocalVideoTrackStats &stats)=0
 
virtual VideoTrackType getType () OPTIONAL_OVERRIDE
 
- Public Member Functions inherited from agora::rtc::IVideoTrack
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)
 
- Public Member Functions inherited from agora::RefCountInterface
virtual void AddRef () const =0
 
virtual RefCountReleaseStatus Release () const =0
 
virtual bool HasOneRef () const =0
 

Static Public Member Functions

static void resetIdGenerator ()
 

Protected Attributes

int id_
 
utils::WeakObservers< IVideoTrackObservertrack_observers_
 
uid_t user_id_
 
std::string unique_id_
 

Additional Inherited Members

- Protected Member Functions inherited from agora::rtc::ILocalVideoTrack
 ~ILocalVideoTrack ()
 
- Protected Member Functions inherited from agora::rtc::IVideoTrack
 ~IVideoTrack ()
 
- Protected Member Functions inherited from agora::RefCountInterface
virtual ~RefCountInterface ()
 

Member Enumeration Documentation

◆ DetachReason

Enumerator
MANUAL 
TRACK_DESTROY 
NETWORK_DESTROY 

Constructor & Destructor Documentation

◆ ILocalVideoTrackEx()

agora::rtc::ILocalVideoTrackEx::ILocalVideoTrackEx ( )
inline

◆ ~ILocalVideoTrackEx()

virtual agora::rtc::ILocalVideoTrackEx::~ILocalVideoTrackEx ( )
inlinevirtual

Member Function Documentation

◆ hasPublished()

virtual bool agora::rtc::ILocalVideoTrackEx::hasPublished ( )
pure virtual

◆ SetVideoConfigEx()

virtual int agora::rtc::ILocalVideoTrackEx::SetVideoConfigEx ( const VideoConfigurationEx configEx,
utils::ConfigPriority  priority = utils::CONFIG_PRIORITY_USER 
)
pure virtual

◆ GetConfigExs()

virtual int agora::rtc::ILocalVideoTrackEx::GetConfigExs ( std::vector< VideoConfigurationEx > &  configs)
pure virtual

◆ setUserId()

virtual int agora::rtc::ILocalVideoTrackEx::setUserId ( uid_t  uid)
inlinevirtual

◆ getUserId()

virtual uid_t agora::rtc::ILocalVideoTrackEx::getUserId ( )
inlinevirtual

◆ getObserverSize()

virtual int agora::rtc::ILocalVideoTrackEx::getObserverSize ( )
inlinevirtual

◆ GetActiveStreamsCount()

virtual int agora::rtc::ILocalVideoTrackEx::GetActiveStreamsCount ( )
pure virtual

◆ prepareNodes()

virtual int agora::rtc::ILocalVideoTrackEx::prepareNodes ( )
pure virtual

◆ attach()

virtual bool agora::rtc::ILocalVideoTrackEx::attach ( const AttachInfo info)
pure virtual

◆ detach()

virtual bool agora::rtc::ILocalVideoTrackEx::detach ( const DetachInfo info)
pure virtual

◆ registerTrackObserver()

virtual bool agora::rtc::ILocalVideoTrackEx::registerTrackObserver ( std::shared_ptr< IVideoTrackObserver observer)
inlinevirtual

◆ unregisterTrackObserver()

virtual bool agora::rtc::ILocalVideoTrackEx::unregisterTrackObserver ( IVideoTrackObserver observer)
inlinevirtual

◆ getStatisticsEx()

virtual bool agora::rtc::ILocalVideoTrackEx::getStatisticsEx ( LocalVideoTrackStatsEx statsEx)
pure virtual

◆ Width()

virtual int32_t agora::rtc::ILocalVideoTrackEx::Width ( ) const
pure virtual

◆ Height()

virtual int32_t agora::rtc::ILocalVideoTrackEx::Height ( ) const
pure virtual

◆ Enabled()

virtual bool agora::rtc::ILocalVideoTrackEx::Enabled ( ) const
pure virtual

◆ addVideoWatermark()

virtual int agora::rtc::ILocalVideoTrackEx::addVideoWatermark ( const char *  watermarkUrl,
const WatermarkOptions options 
)
inlinevirtual

◆ clearVideoWatermarks()

virtual int agora::rtc::ILocalVideoTrackEx::clearVideoWatermarks ( )
inlinevirtual

◆ GetVideoTrackConfigurator()

virtual VideoTrackConfigurator* agora::rtc::ILocalVideoTrackEx::GetVideoTrackConfigurator ( )
inlinevirtual

◆ getInternalVideoSourceType()

virtual InternalVideoSourceType agora::rtc::ILocalVideoTrackEx::getInternalVideoSourceType ( )
inlinevirtual

◆ TrackId()

int agora::rtc::ILocalVideoTrackEx::TrackId ( ) const
inline

◆ setUniqueId()

void agora::rtc::ILocalVideoTrackEx::setUniqueId ( const std::string &  unique_id)
inline

◆ resetIdGenerator()

static void agora::rtc::ILocalVideoTrackEx::resetIdGenerator ( )
static

Member Data Documentation

◆ id_

int agora::rtc::ILocalVideoTrackEx::id_
protected

◆ track_observers_

utils::WeakObservers<IVideoTrackObserver> agora::rtc::ILocalVideoTrackEx::track_observers_
protected

◆ user_id_

uid_t agora::rtc::ILocalVideoTrackEx::user_id_
protected

◆ unique_id_

std::string agora::rtc::ILocalVideoTrackEx::unique_id_
protected