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 #include <api/aosl_ref.h>
13 
14 #ifndef OPTIONAL_OVERRIDE
15 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
16 #define OPTIONAL_OVERRIDE override
17 #else
18 #define OPTIONAL_OVERRIDE
19 #endif
20 #endif
21 
22 namespace agora {
23 namespace rtc {
24 class IVideoFilter;
25 class IVideoEncodedFrameObserver;
26 class IMediaPacketReceiver;
27 class IVideoSinkBase;
28 
29 enum VideoTrackType {
30  LOCAL_VIDEO_TRACK,
31  REMOTE_VIDEO_TRACK,
32  REMOTE_VIDEO_IMAGE_TRACK,
33 };
34 
39  public:
57  virtual bool addVideoFilter(
58  agora_refptr<IVideoFilter> filter, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_CAPTURER,
59  const char* id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
60 
71  virtual bool removeVideoFilter(
72  agora_refptr<IVideoFilter> filter, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_CAPTURER,
73  const char* id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
74 
82  virtual bool hasVideoFilter(const char* id, media::base::VIDEO_MODULE_POSITION position = media::base::POSITION_POST_CAPTURER) = 0;
83 
98  virtual bool addRenderer(agora_refptr<IVideoSinkBase> videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
108  virtual bool removeRenderer(agora_refptr<IVideoSinkBase> videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
114  virtual VideoTrackType getType() = 0;
115 
124  virtual int enableVideoFilter(const char* id, bool enable, aosl_ref_t ares = AOSL_REF_INVALID) { return -1; }
125 
135  virtual int setFilterProperty(const char* id, const char* key, const char* json_value, aosl_ref_t ares = AOSL_REF_INVALID) { return -1; }
136 
146  virtual int getFilterProperty(const char* id, const char* key, char* json_value, size_t buf_size, aosl_ref_t ares = AOSL_REF_INVALID) { return -1; }
147 
148  protected:
149  ~IVideoTrack() {}
150 };
151 
171  uint32_t frames_encoded;
211  int total_bitrate_bps; // Include FEC
231  int width;
235  int height;
236  uint32_t encoder_type;
237  uint32_t hw_encoder_accelerating;
238  /*
239  * encoder vender id, VideoCodecVenderId
240  */
241  uint32_t encoder_vender_id;
249  QUALITY_ADAPT_INDICATION quality_adapt_indication;
253  unsigned short txPacketLossRate;
254 
257  CAPTURE_BRIGHTNESS_LEVEL_TYPE capture_brightness_level;
258 
262  frames_encoded(0),
267  input_frame_rate(0),
273  capture_width(0),
274  capture_height(0),
277  width(0),
278  height(0),
279  encoder_type(0),
280  hw_encoder_accelerating(0),
281  encoder_vender_id(0),
283  quality_adapt_indication(ADAPT_NONE),
284  txPacketLossRate(0),
285  capture_brightness_level(CAPTURE_BRIGHTNESS_LEVEL_INVALID) {}
286 };
287 
300  public:
310  virtual int setEnabled(bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
311 
328  virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
329 
339  virtual int setSimulcastStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig& config, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
340 
346  virtual LOCAL_VIDEO_STREAM_STATE getState() = 0;
347 
356  virtual bool getStatistics(LocalVideoTrackStats& stats) = 0;
357 
358  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return LOCAL_VIDEO_TRACK; }
359 
360  protected:
361  ~ILocalVideoTrack() {}
362 };
370  uid_t uid;
374  int delay;
378  int e2eDelay;
382  int width;
386  int height;
406  VIDEO_STREAM_TYPE rxStreamType;
420  uint32_t received_bytes;
443  uint64_t totalActiveTime;
447  uint64_t publishDuration;
451  int vqa_mos;
460 
461  RemoteVideoTrackStats() : uid(0), delay(0), width(0), height(0),
463  frameLossRate(0), packetLossRate(0), rxStreamType(VIDEO_STREAM_HIGH),
467 };
468 
473  public:
481  virtual bool getStatistics(RemoteVideoTrackStats& stats) = 0;
486  virtual REMOTE_VIDEO_STATE getState() = 0;
494  virtual bool getTrackInfo(VideoTrackInfo& info) = 0;
507  virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver* encodedObserver, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
516 
529  virtual int registerMediaPacketReceiver(IMediaPacketReceiver* videoReceiver, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
537  virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver* videoReceiver) = 0;
538 
539  virtual VideoTrackType getType() OPTIONAL_OVERRIDE { return REMOTE_VIDEO_TRACK; }
540 
541  protected:
542  ~IRemoteVideoTrack() {}
543 };
544 
545 } // namespace rtc
546 } // namespace agora
agora::rtc::LocalVideoTrackStats::frames_encoded
uint32_t frames_encoded
Definition: NGIAgoraVideoTrack.h:171
agora::rtc::RemoteVideoTrackStats::avSyncTimeMs
int avSyncTimeMs
Definition: NGIAgoraVideoTrack.h:429
agora::rtc::RemoteVideoTrackStats::totalFrozenTime
int totalFrozenTime
Definition: NGIAgoraVideoTrack.h:412
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:399
agora::rtc::RemoteVideoTrackStats::packetLossRate
int packetLossRate
Definition: NGIAgoraVideoTrack.h:402
agora::rtc::IRemoteVideoTrack::registerVideoEncodedFrameObserver
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::RemoteVideoTrackStats::totalDecodedFrames
uint32_t totalDecodedFrames
Definition: NGIAgoraVideoTrack.h:424
agora::rtc::IVideoTrack
Definition: NGIAgoraVideoTrack.h:38
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::LocalVideoTrackStats::bytes_minor_stream
uint64_t bytes_minor_stream
Definition: NGIAgoraVideoTrack.h:167
agora::rtc::RemoteVideoTrackStats::totalActiveTime
uint64_t totalActiveTime
Definition: NGIAgoraVideoTrack.h:443
agora::rtc::LocalVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:231
agora::rtc::LocalVideoTrackStats::media_bitrate_bps
int media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:207
agora::rtc::ILocalVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:358
agora::rtc::RemoteVideoTrackStats::vqa_avg_cost_ms
int vqa_avg_cost_ms
Definition: NGIAgoraVideoTrack.h:455
agora::rtc::LocalVideoTrackStats::capture_brightness_level
CAPTURE_BRIGHTNESS_LEVEL_TYPE capture_brightness_level
Definition: NGIAgoraVideoTrack.h:257
agora::rtc::RemoteVideoTrackStats::uid
uid_t uid
Definition: NGIAgoraVideoTrack.h:370
agora::rtc::IVideoTrack::getType
virtual VideoTrackType getType()=0
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1813
agora::rtc::LocalVideoTrackStats::number_of_streams
uint64_t number_of_streams
Definition: NGIAgoraVideoTrack.h:159
agora::rtc::IVideoTrack::addRenderer
virtual bool addRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::IRemoteVideoTrack::getStatistics
virtual bool getStatistics(RemoteVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rxStreamType
VIDEO_STREAM_TYPE rxStreamType
Definition: NGIAgoraVideoTrack.h:406
agora::rtc::IVideoTrack::getFilterProperty
virtual int getFilterProperty(const char *id, const char *key, char *json_value, size_t buf_size, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:146
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2023
agora::rtc::IRemoteVideoTrack::unregisterMediaPacketReceiver
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
agora::rtc::ILocalVideoTrack::setSimulcastStreamMode
virtual int setSimulcastStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::IRemoteVideoTrack::registerMediaPacketReceiver
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *videoReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::RemoteVideoTrackStats::frame_render_delay_ms
uint32_t frame_render_delay_ms
Definition: NGIAgoraVideoTrack.h:438
agora::rtc::LocalVideoTrackStats::regulated_capture_width
int regulated_capture_width
Definition: NGIAgoraVideoTrack.h:223
agora::rtc::RemoteVideoTrackStats::height
int height
Definition: NGIAgoraVideoTrack.h:386
agora::rtc::ILocalVideoTrack::setVideoEncoderConfiguration
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::LocalVideoTrackStats::total_bitrate_bps
int total_bitrate_bps
Definition: NGIAgoraVideoTrack.h:211
agora::rtc::LocalVideoTrackStats::ssrc_major_stream
uint32_t ssrc_major_stream
Definition: NGIAgoraVideoTrack.h:175
agora::rtc::LocalVideoTrackStats::txPacketLossRate
unsigned short txPacketLossRate
Definition: NGIAgoraVideoTrack.h:253
agora::rtc::RemoteVideoTrackStats::decoder_vender_id
uint32_t decoder_vender_id
Definition: NGIAgoraVideoTrack.h:459
agora::rtc::RemoteVideoTrackStats::e2eDelay
int e2eDelay
Definition: NGIAgoraVideoTrack.h:378
agora::rtc::LocalVideoTrackStats::input_frame_rate
int input_frame_rate
Definition: NGIAgoraVideoTrack.h:191
agora::rtc::ILocalVideoTrack
Definition: NGIAgoraVideoTrack.h:299
agora::rtc::LocalVideoTrackStats::capture_width
int capture_width
Definition: NGIAgoraVideoTrack.h:215
agora::rtc::ILocalVideoTrack::getStatistics
virtual bool getStatistics(LocalVideoTrackStats &stats)=0
agora::rtc::RemoteVideoTrackStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: NGIAgoraVideoTrack.h:396
agora::rtc::RemoteVideoTrackStats::delay
int delay
Definition: NGIAgoraVideoTrack.h:374
agora::rtc::IRemoteVideoTrack::getType
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:539
agora::rtc::IMediaPacketReceiver
Definition: NGIAgoraMediaNode.h:580
agora::rtc::IVideoTrack::removeRenderer
virtual bool removeRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::IVideoTrack::setFilterProperty
virtual int setFilterProperty(const char *id, const char *key, const char *json_value, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:135
agora::rtc::LocalVideoTrackStats::ssrc_minor_stream
uint32_t ssrc_minor_stream
Definition: NGIAgoraVideoTrack.h:179
agora::rtc::RemoteVideoTrackStats::frozenRate
int frozenRate
Definition: NGIAgoraVideoTrack.h:416
agora::rtc::IVideoTrack::enableVideoFilter
virtual int enableVideoFilter(const char *id, bool enable, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:124
agora::rtc::IRemoteVideoTrack
Definition: NGIAgoraVideoTrack.h:472
agora::rtc::LocalVideoTrackStats::render_frame_rate
int render_frame_rate
Definition: NGIAgoraVideoTrack.h:199
agora::rtc::RemoteVideoTrackStats
Definition: NGIAgoraVideoTrack.h:366
agora::rtc::RemoteVideoTrackStats::downlink_process_time_ms
uint32_t downlink_process_time_ms
Definition: NGIAgoraVideoTrack.h:434
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::ILocalVideoTrack::setEnabled
virtual int setEnabled(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::rtc::LocalVideoTrackStats::capture_frame_rate
int capture_frame_rate
Definition: NGIAgoraVideoTrack.h:183
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::RemoteVideoTrackStats::publishDuration
uint64_t publishDuration
Definition: NGIAgoraVideoTrack.h:447
agora::rtc::LocalVideoTrackStats::regulated_capture_height
int regulated_capture_height
Definition: NGIAgoraVideoTrack.h:227
agora::rtc::IRemoteVideoTrack::getState
virtual REMOTE_VIDEO_STATE getState()=0
agora::rtc::RemoteVideoTrackStats::receivedBitrate
int receivedBitrate
Definition: NGIAgoraVideoTrack.h:390
agora::rtc::LocalVideoTrackStats::capture_height
int capture_height
Definition: NGIAgoraVideoTrack.h:219
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::media::IVideoEncodedFrameObserver
Definition: AgoraMediaBase.h:1285
agora::rtc::RemoteVideoTrackStats::decoderOutputFrameRate
int decoderOutputFrameRate
Definition: NGIAgoraVideoTrack.h:393
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:3124
agora::rtc::RemoteVideoTrackStats::width
int width
Definition: NGIAgoraVideoTrack.h:382
agora::rtc::LocalVideoTrackStats::target_media_bitrate_bps
int target_media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:203
agora::rtc::LocalVideoTrackStats::quality_adapt_indication
QUALITY_ADAPT_INDICATION quality_adapt_indication
Definition: NGIAgoraVideoTrack.h:249
agora::rtc::LocalVideoTrackStats::regulated_capture_frame_rate
int regulated_capture_frame_rate
Definition: NGIAgoraVideoTrack.h:187
agora::rtc::IRemoteVideoTrack::unregisterVideoEncodedFrameObserver
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver)=0
agora::rtc::LocalVideoTrackStats::encode_frame_rate
int encode_frame_rate
Definition: NGIAgoraVideoTrack.h:195
agora::rtc::LocalVideoTrackStats::bytes_major_stream
uint64_t bytes_major_stream
Definition: NGIAgoraVideoTrack.h:163
agora::rtc::LocalVideoTrackStats::uplink_cost_time_ms
uint32_t uplink_cost_time_ms
Definition: NGIAgoraVideoTrack.h:245
agora::rtc::RemoteVideoTrackStats::vqa_mos
int vqa_mos
Definition: NGIAgoraVideoTrack.h:451
agora::rtc::LocalVideoTrackStats::height
int height
Definition: NGIAgoraVideoTrack.h:235
agora::rtc::LocalVideoTrackStats
Definition: NGIAgoraVideoTrack.h:155
agora::rtc::RemoteVideoTrackStats::received_bytes
uint32_t received_bytes
Definition: NGIAgoraVideoTrack.h:420