Agora Java API Reference for Android
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 
28 enum VideoTrackType {
29  LOCAL_VIDEO_TRACK,
30  REMOTE_VIDEO_TRACK,
31 };
32 
37  public:
55  virtual bool addVideoFilter(
56  agora_refptr<IVideoFilter> filter, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_CAPTURER,
57  const char* id = NULL) = 0;
68  virtual bool removeVideoFilter(
69  agora_refptr<IVideoFilter> filter, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_CAPTURER,
70  const char* id = NULL) = 0;
85  virtual bool addRenderer(agora_refptr<IVideoSinkBase> videoRenderer, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_FILTERS) = 0;
95  virtual bool removeRenderer(agora_refptr<IVideoSinkBase> videoRenderer, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_FILTERS) = 0;
101  virtual VideoTrackType getType() = 0;
102 
111  virtual int enableVideoFilter(const char* id, bool enable) { return -1; }
112 
122  virtual int setFilterProperty(const char* id, const char* key, const char* json_value) { return -1; }
123 
133  virtual int getFilterProperty(const char* id, const char* key, char* json_value, size_t buf_size) { return -1; }
134 
135  protected:
136  ~IVideoTrack() {}
137 };
138 
158  uint32_t frames_encoded;
190  int total_bitrate_bps; // Include FEC
194  int width;
198  int height;
199  uint32_t encoder_type;
204 
208  frames_encoded(0),
211  input_frame_rate(0),
217  width(0),
218  height(0),
219  encoder_type(0),
220  uplink_cost_time_ms(0) {}
221 };
222 
235  public:
245  virtual void setEnabled(bool enable) = 0;
246 
264 
276  virtual int enableSimulcastStream(bool enabled, const SimulcastStreamConfig& config) = 0;
277 
287  virtual int updateSimulcastStreamConfig(const SimulcastStreamConfig& config) = 0;
288 
294  virtual LOCAL_VIDEO_STREAM_STATE getState() = 0;
295 
304  virtual bool getStatistics(LocalVideoTrackStats& stats) = 0;
305 
306  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return LOCAL_VIDEO_TRACK; }
307 
308  protected:
309  ~ILocalVideoTrack() {}
310 };
318  uid_t uid;
322  int delay;
326  int width;
330  int height;
350  VIDEO_STREAM_TYPE rxStreamType;
379 
380  RemoteVideoTrackStats() : uid(0), delay(0), width(0), height(0),
382  frameLossRate(0), packetLossRate(0), rxStreamType(VIDEO_STREAM_HIGH),
385 };
386 
391  public:
392 
400  virtual bool getStatistics(RemoteVideoTrackStats& stats) = 0;
405  virtual REMOTE_VIDEO_STATE getState() = 0;
413  virtual bool getTrackInfo(VideoTrackInfo& info) = 0;
435 
448  virtual int registerMediaPacketReceiver(IMediaPacketReceiver* videoReceiver) = 0;
456  virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver* videoReceiver) = 0;
457 
458  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return REMOTE_VIDEO_TRACK; }
459 
460  protected:
461  ~IRemoteVideoTrack() {}
462 };
463 
464 } // namespace rtc
465 } // namespace agora
agora::rtc::LocalVideoTrackStats::frames_encoded
uint32_t frames_encoded
Definition: NGIAgoraVideoTrack.h:158
agora::rtc::RemoteVideoTrackStats::avSyncTimeMs
int avSyncTimeMs
Definition: NGIAgoraVideoTrack.h:369
agora::rtc::RemoteVideoTrackStats::totalFrozenTime
int totalFrozenTime
Definition: NGIAgoraVideoTrack.h:356
agora::rtc::IRemoteVideoTrack::getTrackInfo
virtual bool getTrackInfo(VideoTrackInfo &info)=0
agora::rtc::ILocalVideoTrack::getState
virtual LOCAL_VIDEO_STREAM_STATE getState()=0
agora::rtc::RemoteVideoTrackStats::frameLossRate
int frameLossRate
Definition: NGIAgoraVideoTrack.h:343
agora::rtc::RemoteVideoTrackStats::packetLossRate
int packetLossRate
Definition: NGIAgoraVideoTrack.h:346
agora::rtc::RemoteVideoTrackStats::totalDecodedFrames
uint32_t totalDecodedFrames
Definition: NGIAgoraVideoTrack.h:364
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:154
agora::rtc::LocalVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:194
agora::rtc::LocalVideoTrackStats::media_bitrate_bps
int media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:186
agora::rtc::ILocalVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:306
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:318
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:1788
agora::rtc::LocalVideoTrackStats::number_of_streams
uint64_t number_of_streams
Definition: NGIAgoraVideoTrack.h:146
agora::rtc::IRemoteVideoTrack::getStatistics
virtual bool getStatistics(RemoteVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rxStreamType
VIDEO_STREAM_TYPE rxStreamType
Definition: NGIAgoraVideoTrack.h:350
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:1940
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:378
agora::rtc::IRemoteVideoTrack::unregisterVideoEncodedImageReceiver
virtual int unregisterVideoEncodedImageReceiver(IVideoEncodedImageReceiver *videoReceiver)=0
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:330
agora::rtc::LocalVideoTrackStats::total_bitrate_bps
int total_bitrate_bps
Definition: NGIAgoraVideoTrack.h:190
agora::rtc::LocalVideoTrackStats::ssrc_major_stream
uint32_t ssrc_major_stream
Definition: NGIAgoraVideoTrack.h:162
agora::rtc::IRemoteVideoTrack::registerMediaPacketReceiver
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
agora::rtc::LocalVideoTrackStats::input_frame_rate
int input_frame_rate
Definition: NGIAgoraVideoTrack.h:170
agora::rtc::ILocalVideoTrack
Definition: NGIAgoraVideoTrack.h:234
agora::rtc::ILocalVideoTrack::getStatistics
virtual bool getStatistics(LocalVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: NGIAgoraVideoTrack.h:340
agora::rtc::RemoteVideoTrackStats::delay
int delay
Definition: NGIAgoraVideoTrack.h:322
agora::rtc::ILocalVideoTrack::setVideoEncoderConfiguration
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
agora::rtc::IRemoteVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:458
agora::rtc::IMediaPacketReceiver
Definition: NGIAgoraMediaNode.h:298
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:166
agora::rtc::IVideoTrack::setFilterProperty
virtual int setFilterProperty(const char *id, const char *key, const char *json_value)
Definition: NGIAgoraVideoTrack.h:122
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:111
agora::rtc::RemoteVideoTrackStats::frozenRate
int frozenRate
Definition: NGIAgoraVideoTrack.h:360
agora::rtc::IVideoEncodedImageReceiver
Definition: AgoraBase.h:2889
agora::rtc::IRemoteVideoTrack
Definition: NGIAgoraVideoTrack.h:390
agora::rtc::LocalVideoTrackStats::render_frame_rate
int render_frame_rate
Definition: NGIAgoraVideoTrack.h:178
agora::rtc::IRemoteVideoTrack::registerVideoEncodedImageReceiver
virtual int registerVideoEncodedImageReceiver(IVideoEncodedImageReceiver *videoReceiver)=0
agora::rtc::RemoteVideoTrackStats
Definition: NGIAgoraVideoTrack.h:314
agora::rtc::RemoteVideoTrackStats::downlink_process_time_ms
uint32_t downlink_process_time_ms
Definition: NGIAgoraVideoTrack.h:374
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IRemoteVideoTrack::getState
virtual REMOTE_VIDEO_STATE getState()=0
agora::rtc::RemoteVideoTrackStats::receivedBitrate
int receivedBitrate
Definition: NGIAgoraVideoTrack.h:334
agora::rtc::RemoteVideoTrackStats::decoderOutputFrameRate
int decoderOutputFrameRate
Definition: NGIAgoraVideoTrack.h:337
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:2745
agora::rtc::RemoteVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:326
agora::rtc::LocalVideoTrackStats::target_media_bitrate_bps
int target_media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:182
agora::rtc::LocalVideoTrackStats::encode_frame_rate
int encode_frame_rate
Definition: NGIAgoraVideoTrack.h:174
agora::rtc::LocalVideoTrackStats::bytes_major_stream
uint64_t bytes_major_stream
Definition: NGIAgoraVideoTrack.h:150
agora::rtc::LocalVideoTrackStats::uplink_cost_time_ms
uint32_t uplink_cost_time_ms
Definition: NGIAgoraVideoTrack.h:203
agora::rtc::IVideoTrack::getFilterProperty
virtual int getFilterProperty(const char *id, const char *key, char *json_value, size_t buf_size)
Definition: NGIAgoraVideoTrack.h:133
agora::rtc::LocalVideoTrackStats::height
int height
Definition: NGIAgoraVideoTrack.h:198
agora::rtc::LocalVideoTrackStats
Definition: NGIAgoraVideoTrack.h:142