Agora C++ API Reference for All Platforms
NGIAgoraVideoTrack.h
1 
2 // Copyright (c) 2019 Agora.io. All rights reserved
3 
4 // This program is confidential and proprietary to Agora.io.
5 // And may not be copied, reproduced, modified, disclosed to others, published
6 // or used, in whole or in part, without the express prior written permission
7 // of Agora.io.
8 
9 #pragma once // NOLINT(build/header_guard)
10 
11 #include "AgoraBase.h"
12 
13 #ifndef OPTIONAL_OVERRIDE
14 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
15 #define OPTIONAL_OVERRIDE override
16 #else
17 #define OPTIONAL_OVERRIDE
18 #endif
19 #endif
20 
21 namespace agora {
22 namespace rtc {
23 class IVideoFilter;
24 class IVideoEncodedImageReceiver;
25 class IMediaPacketReceiver;
26 class IVideoSinkBase;
27 
31 };
32 
37  public:
55  virtual bool addVideoFilter(
57  const char* id = NULL) = 0;
58 
69  virtual bool removeVideoFilter(
71  const char* id = NULL) = 0;
72 
81 
112  virtual VideoTrackType getType() = 0;
113 
122  virtual int enableVideoFilter(const char* id, bool enable) { return -1; }
123 
133  virtual int setFilterProperty(const char* id, const char* key, const char* json_value) { return -1; }
134 
144  virtual int getFilterProperty(const char* id, const char* key, char* json_value, size_t buf_size) { return -1; }
145 
146  protected:
148 };
149 
169  uint32_t frames_encoded;
201  int total_bitrate_bps; // Include FEC
205  int width;
209  int height;
210  uint32_t encoder_type;
215 
219  frames_encoded(0),
222  input_frame_rate(0),
228  width(0),
229  height(0),
230  encoder_type(0),
231  uplink_cost_time_ms(0) {}
232 };
233 
246  public:
256  virtual void setEnabled(bool enable) = 0;
257 
275 
287  virtual int enableSimulcastStream(bool enabled, const SimulcastStreamConfig& config) = 0;
288 
298  virtual int updateSimulcastStreamConfig(const SimulcastStreamConfig& config) = 0;
299 
306 
315  virtual bool getStatistics(LocalVideoTrackStats& stats) = 0;
316 
317  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return LOCAL_VIDEO_TRACK; }
318 
319  protected:
321 };
333  int delay;
337  int width;
341  int height;
390 
396 };
397 
402  public:
403 
411  virtual bool getStatistics(RemoteVideoTrackStats& stats) = 0;
424  virtual bool getTrackInfo(VideoTrackInfo& info) = 0;
446 
459  virtual int registerMediaPacketReceiver(IMediaPacketReceiver* videoReceiver) = 0;
467  virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver* videoReceiver) = 0;
468 
469  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return REMOTE_VIDEO_TRACK; }
470 
471  protected:
473 };
474 
475 } // namespace rtc
476 } // namespace agora
agora::rtc::LocalVideoTrackStats::frames_encoded
uint32_t frames_encoded
Definition: NGIAgoraVideoTrack.h:169
agora::rtc::RemoteVideoTrackStats::avSyncTimeMs
int avSyncTimeMs
Definition: NGIAgoraVideoTrack.h:380
agora::rtc::RemoteVideoTrackStats::totalFrozenTime
int totalFrozenTime
Definition: NGIAgoraVideoTrack.h:367
agora::rtc::IRemoteVideoTrack::getTrackInfo
virtual bool getTrackInfo(VideoTrackInfo &info)=0
agora::rtc::ILocalVideoTrack::getState
virtual LOCAL_VIDEO_STREAM_STATE getState()=0
agora::rtc::LOCAL_VIDEO_STREAM_STATE
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2543
agora::rtc::IRemoteVideoTrack::~IRemoteVideoTrack
~IRemoteVideoTrack()
Definition: NGIAgoraVideoTrack.h:472
agora::rtc::RemoteVideoTrackStats::frameLossRate
int frameLossRate
Definition: NGIAgoraVideoTrack.h:354
agora::rtc::RemoteVideoTrackStats::packetLossRate
int packetLossRate
Definition: NGIAgoraVideoTrack.h:357
agora::rtc::RemoteVideoTrackStats::totalDecodedFrames
uint32_t totalDecodedFrames
Definition: NGIAgoraVideoTrack.h:375
agora::rtc::ILocalVideoTrack::setEnabled
virtual void setEnabled(bool enable)=0
agora::rtc::IVideoTrack
Definition: NGIAgoraVideoTrack.h:36
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::LocalVideoTrackStats::bytes_minor_stream
uint64_t bytes_minor_stream
Definition: NGIAgoraVideoTrack.h:165
agora::media::base::POSITION_POST_CAPTURER
@ POSITION_POST_CAPTURER
Definition: AgoraMediaBase.h:543
agora::rtc::LocalVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:205
agora::rtc::LocalVideoTrackStats::media_bitrate_bps
int media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:197
agora::rtc::ILocalVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:317
agora::rtc::IVideoTrack::addVideoFilter
virtual bool addVideoFilter(agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL)=0
agora::rtc::IVideoTrack::removeVideoFilter
virtual bool removeVideoFilter(agora_refptr< IVideoFilter > filter, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER, const char *id=NULL)=0
agora::rtc::RemoteVideoTrackStats::uid
uid_t uid
Definition: NGIAgoraVideoTrack.h:329
agora::rtc::VIDEO_STREAM_HIGH
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1690
agora::rtc::IVideoTrack::getType
virtual VideoTrackType getType()=0
agora::rtc::ILocalVideoTrack::updateSimulcastStreamConfig
virtual int updateSimulcastStreamConfig(const SimulcastStreamConfig &config)=0
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1797
agora::rtc::LocalVideoTrackStats::number_of_streams
uint64_t number_of_streams
Definition: NGIAgoraVideoTrack.h:157
agora::rtc::LOCAL_VIDEO_TRACK
@ LOCAL_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:29
agora::rtc::IRemoteVideoTrack::getStatistics
virtual bool getStatistics(RemoteVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rxStreamType
VIDEO_STREAM_TYPE rxStreamType
Definition: NGIAgoraVideoTrack.h:361
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:1949
agora::rtc::IRemoteVideoTrack::unregisterMediaPacketReceiver
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
agora::rtc::RemoteVideoTrackStats::frame_render_delay_ms
uint32_t frame_render_delay_ms
Definition: NGIAgoraVideoTrack.h:389
agora::rtc::IRemoteVideoTrack::unregisterVideoEncodedImageReceiver
virtual int unregisterVideoEncodedImageReceiver(IVideoEncodedImageReceiver *videoReceiver)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IVideoTrack::removeRenderer
virtual bool removeRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_FILTERS)=0
agora::rtc::RemoteVideoTrackStats::height
int height
Definition: NGIAgoraVideoTrack.h:341
agora::rtc::REMOTE_VIDEO_STATE
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:2665
agora::rtc::LocalVideoTrackStats::total_bitrate_bps
int total_bitrate_bps
Definition: NGIAgoraVideoTrack.h:201
agora::rtc::LocalVideoTrackStats::ssrc_major_stream
uint32_t ssrc_major_stream
Definition: NGIAgoraVideoTrack.h:173
agora::rtc::IRemoteVideoTrack::registerMediaPacketReceiver
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
agora::rtc::LocalVideoTrackStats::input_frame_rate
int input_frame_rate
Definition: NGIAgoraVideoTrack.h:181
agora::rtc::ILocalVideoTrack
Definition: NGIAgoraVideoTrack.h:245
agora::rtc::ILocalVideoTrack::getStatistics
virtual bool getStatistics(LocalVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: NGIAgoraVideoTrack.h:351
agora::rtc::RemoteVideoTrackStats::delay
int delay
Definition: NGIAgoraVideoTrack.h:333
agora::rtc::ILocalVideoTrack::setVideoEncoderConfiguration
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
agora::rtc::IRemoteVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:469
agora::rtc::IMediaPacketReceiver
Definition: NGIAgoraMediaNode.h:461
agora::rtc::REMOTE_VIDEO_TRACK
@ REMOTE_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:30
agora::rtc::IVideoTrack::addRenderer
virtual bool addRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_FILTERS)=0
agora::rtc::LocalVideoTrackStats::ssrc_minor_stream
uint32_t ssrc_minor_stream
Definition: NGIAgoraVideoTrack.h:177
agora::media::base::POSITION_POST_FILTERS
@ POSITION_POST_FILTERS
Definition: AgoraMediaBase.h:546
agora::rtc::IVideoTrack::setFilterProperty
virtual int setFilterProperty(const char *id, const char *key, const char *json_value)
Definition: NGIAgoraVideoTrack.h:133
agora::rtc::ILocalVideoTrack::enableSimulcastStream
virtual int enableSimulcastStream(bool enabled, const SimulcastStreamConfig &config)=0
agora::rtc::IVideoTrack::enableVideoFilter
virtual int enableVideoFilter(const char *id, bool enable)
Definition: NGIAgoraVideoTrack.h:122
agora::media::base::VIDEO_MODULE_POSITION
VIDEO_MODULE_POSITION
Definition: AgoraMediaBase.h:542
agora::rtc::RemoteVideoTrackStats::frozenRate
int frozenRate
Definition: NGIAgoraVideoTrack.h:371
agora::rtc::IVideoEncodedImageReceiver
Definition: AgoraBase.h:2903
agora::rtc::IRemoteVideoTrack
Definition: NGIAgoraVideoTrack.h:401
agora::rtc::ILocalVideoTrack::~ILocalVideoTrack
~ILocalVideoTrack()
Definition: NGIAgoraVideoTrack.h:320
agora::rtc::LocalVideoTrackStats::render_frame_rate
int render_frame_rate
Definition: NGIAgoraVideoTrack.h:189
agora::rtc::IRemoteVideoTrack::registerVideoEncodedImageReceiver
virtual int registerVideoEncodedImageReceiver(IVideoEncodedImageReceiver *videoReceiver)=0
agora::rtc::LocalVideoTrackStats::LocalVideoTrackStats
LocalVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:216
agora::rtc::RemoteVideoTrackStats
Definition: NGIAgoraVideoTrack.h:325
agora::rtc::RemoteVideoTrackStats::downlink_process_time_ms
uint32_t downlink_process_time_ms
Definition: NGIAgoraVideoTrack.h:385
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IVideoTrack::hasVideoFilter
virtual bool hasVideoFilter(const char *id, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER)=0
agora::rtc::IRemoteVideoTrack::getState
virtual REMOTE_VIDEO_STATE getState()=0
agora::rtc::VIDEO_STREAM_TYPE
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1686
agora::rtc::VideoTrackType
VideoTrackType
Definition: NGIAgoraVideoTrack.h:28
agora::rtc::RemoteVideoTrackStats::receivedBitrate
int receivedBitrate
Definition: NGIAgoraVideoTrack.h:345
agora::rtc::RemoteVideoTrackStats::RemoteVideoTrackStats
RemoteVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:391
agora::rtc::IVideoTrack::~IVideoTrack
~IVideoTrack()
Definition: NGIAgoraVideoTrack.h:147
agora::rtc::RemoteVideoTrackStats::decoderOutputFrameRate
int decoderOutputFrameRate
Definition: NGIAgoraVideoTrack.h:348
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:2759
agora::rtc::uid_t
unsigned int uid_t
Definition: AgoraMediaBase.h:25
agora::rtc::RemoteVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:337
agora::rtc::LocalVideoTrackStats::target_media_bitrate_bps
int target_media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:193
agora::rtc::LocalVideoTrackStats::encoder_type
uint32_t encoder_type
Definition: NGIAgoraVideoTrack.h:210
agora::rtc::LocalVideoTrackStats::encode_frame_rate
int encode_frame_rate
Definition: NGIAgoraVideoTrack.h:185
agora::rtc::LocalVideoTrackStats::bytes_major_stream
uint64_t bytes_major_stream
Definition: NGIAgoraVideoTrack.h:161
agora::rtc::LocalVideoTrackStats::uplink_cost_time_ms
uint32_t uplink_cost_time_ms
Definition: NGIAgoraVideoTrack.h:214
agora::rtc::IVideoTrack::getFilterProperty
virtual int getFilterProperty(const char *id, const char *key, char *json_value, size_t buf_size)
Definition: NGIAgoraVideoTrack.h:144
rtc
Definition: video_node_i.h:27
agora::rtc::LocalVideoTrackStats::height
int height
Definition: NGIAgoraVideoTrack.h:209
agora::rtc::LocalVideoTrackStats
Definition: NGIAgoraVideoTrack.h:153