Agora C++ API Reference for All Platforms
|
9 #pragma once // NOLINT(build/header_guard)
11 #include "AgoraBase.h"
12 #include <api/aosl_ref.h>
14 #ifndef OPTIONAL_OVERRIDE
15 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
16 #define OPTIONAL_OVERRIDE override
18 #define OPTIONAL_OVERRIDE
25 class IVideoEncodedFrameObserver;
26 class IMediaPacketReceiver;
118 const char*
id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
132 const char*
id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
183 virtual int enableVideoFilter(
const char*
id,
bool enable, aosl_ref_t ares = AOSL_REF_INVALID) {
return -1; }
194 virtual int setFilterProperty(
const char*
id,
const char* key,
const char* json_value, aosl_ref_t ares = AOSL_REF_INVALID) {
return -1; }
205 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; }
377 virtual int setEnabled(
bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
uint32_t frames_encoded
Definition: NGIAgoraVideoTrack.h:236
uint32_t decoder_type
Definition: NGIAgoraVideoTrack.h:533
int avSyncTimeMs
Definition: NGIAgoraVideoTrack.h:499
int totalFrozenTime
Definition: NGIAgoraVideoTrack.h:482
virtual bool getTrackInfo(VideoTrackInfo &info)=0
virtual LOCAL_VIDEO_STREAM_STATE getState()=0
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2899
~IRemoteVideoTrack()
Definition: NGIAgoraVideoTrack.h:616
int frameLossRate
Definition: NGIAgoraVideoTrack.h:469
int packetLossRate
Definition: NGIAgoraVideoTrack.h:472
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint32_t totalDecodedFrames
Definition: NGIAgoraVideoTrack.h:494
int decoderInputFrameRate
Definition: NGIAgoraVideoTrack.h:460
Definition: NGIAgoraVideoTrack.h:40
int bitrate_kbps
Definition: NGIAgoraVideoTrack.h:43
Definition: NGIAgoraVideoTrack.h:97
Definition: AgoraRefPtr.h:44
Definition: NGIAgoraVideoTrack.h:211
uint64_t bytes_minor_stream
Definition: NGIAgoraVideoTrack.h:232
uint64_t totalActiveTime
Definition: NGIAgoraVideoTrack.h:513
int height
Definition: AgoraBase.h:1094
@ STREAM_LAYER_1
Definition: NGIAgoraVideoTrack.h:30
@ STREAM_LAYER_4
Definition: NGIAgoraVideoTrack.h:33
int width
Definition: NGIAgoraVideoTrack.h:296
int media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:272
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:425
int vqa_avg_cost_ms
Definition: NGIAgoraVideoTrack.h:525
VideoDimensions dimensions
Definition: NGIAgoraVideoTrack.h:41
SIMULCAST_STREAM_MODE
Definition: AgoraBase.h:2060
CAPTURE_BRIGHTNESS_LEVEL_TYPE capture_brightness_level
Definition: NGIAgoraVideoTrack.h:322
uid_t uid
Definition: NGIAgoraVideoTrack.h:437
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1557
int bitrate
Definition: NGIAgoraVideoTrack.h:215
virtual VideoTrackType getType()=0
Definition: AgoraBase.h:1868
uint64_t number_of_streams
Definition: NGIAgoraVideoTrack.h:224
@ LOCAL_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:89
int framerate
Definition: AgoraBase.h:2147
virtual bool addRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool getStatistics(RemoteVideoTrackStats &stats)=0
@ ADAPT_NONE
Definition: AgoraBase.h:2472
QUALITY_ADAPT_INDICATION
Definition: AgoraBase.h:2468
VIDEO_STREAM_TYPE rxStreamType
Definition: NGIAgoraVideoTrack.h:476
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:205
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *videoReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint32_t frame_render_delay_ms
Definition: NGIAgoraVideoTrack.h:508
@ REMOTE_VIDEO_IMAGE_TRACK
Definition: NGIAgoraVideoTrack.h:91
int regulated_capture_width
Definition: NGIAgoraVideoTrack.h:288
Definition: AgoraAtomicOps.h:21
int height
Definition: NGIAgoraVideoTrack.h:453
void reset()
Definition: NGIAgoraVideoTrack.h:58
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:3136
int total_bitrate_bps
Definition: NGIAgoraVideoTrack.h:276
uint32_t ssrc_major_stream
Definition: NGIAgoraVideoTrack.h:240
unsigned short txPacketLossRate
Definition: NGIAgoraVideoTrack.h:318
@ STREAM_LAYER_COUNT_MAX
Definition: NGIAgoraVideoTrack.h:37
uint32_t decoder_vender_id
Definition: NGIAgoraVideoTrack.h:529
virtual int setSimulcastStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastConfigInternal &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
int e2eDelay
Definition: NGIAgoraVideoTrack.h:445
StreamLayerConfigInternal(const StreamLayerConfigInternal &other)
Definition: NGIAgoraVideoTrack.h:46
const int STANDARD_BITRATE
Definition: AgoraBase.h:1107
@ STREAM_LAYER_2
Definition: NGIAgoraVideoTrack.h:31
int input_frame_rate
Definition: NGIAgoraVideoTrack.h:256
CAPTURE_BRIGHTNESS_LEVEL_TYPE
Definition: AgoraBase.h:2789
SimulcastStreamProfile simulcast_stream_profile[STREAM_LAYER_COUNT_MAX]
Definition: NGIAgoraVideoTrack.h:324
uint32_t encoder_vender_id
Definition: NGIAgoraVideoTrack.h:306
int framerate
Definition: NGIAgoraVideoTrack.h:42
@ STREAM_LAYER_3
Definition: NGIAgoraVideoTrack.h:32
Definition: NGIAgoraVideoTrack.h:366
bool enable
Definition: NGIAgoraVideoTrack.h:44
bool operator==(const SimulcastConfigInternal &rhs) const
Definition: NGIAgoraVideoTrack.h:76
int capture_width
Definition: NGIAgoraVideoTrack.h:280
void reset()
Definition: NGIAgoraVideoTrack.h:70
virtual bool getStatistics(LocalVideoTrackStats &stats)=0
Definition: AgoraBase.h:2139
StreamLayerConfigInternal simulcastlayerConfigs[STREAM_LAYER_COUNT_MAX]
Definition: NGIAgoraVideoTrack.h:68
int rendererOutputFrameRate
Definition: NGIAgoraVideoTrack.h:466
int delay
Definition: NGIAgoraVideoTrack.h:441
@ STREAM_LAYER_5
Definition: NGIAgoraVideoTrack.h:34
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:613
virtual bool removeRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ REMOTE_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:90
virtual int setFilterProperty(const char *id, const char *key, const char *json_value, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:194
uint32_t ssrc_minor_stream
Definition: NGIAgoraVideoTrack.h:244
@ STREAM_LOW
Definition: NGIAgoraVideoTrack.h:36
Definition: NGIAgoraVideoTrack.h:67
int frozenRate
Definition: NGIAgoraVideoTrack.h:486
@ CAPTURE_BRIGHTNESS_LEVEL_INVALID
Definition: AgoraBase.h:2793
int width
Definition: AgoraBase.h:1090
virtual int enableVideoFilter(const char *id, bool enable, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:183
Definition: NGIAgoraVideoTrack.h:546
~ILocalVideoTrack()
Definition: NGIAgoraVideoTrack.h:428
int height
Definition: NGIAgoraVideoTrack.h:213
int render_frame_rate
Definition: NGIAgoraVideoTrack.h:264
LocalVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:326
Definition: NGIAgoraVideoTrack.h:433
uint32_t downlink_process_time_ms
Definition: NGIAgoraVideoTrack.h:504
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
virtual int setEnabled(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
int capture_frame_rate
Definition: NGIAgoraVideoTrack.h:248
int width
Definition: NGIAgoraVideoTrack.h:212
Definition: AgoraRefPtr.h:31
virtual bool hasVideoFilter(const char *id, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER)=0
uint64_t publishDuration
Definition: NGIAgoraVideoTrack.h:517
int regulated_capture_height
Definition: NGIAgoraVideoTrack.h:292
int framerate
Definition: NGIAgoraVideoTrack.h:214
virtual REMOTE_VIDEO_STATE getState()=0
StreamLayerConfigInternal & operator=(const SimulcastConfig::StreamLayerConfig &slc)
Definition: NGIAgoraVideoTrack.h:51
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1553
VideoTrackType
Definition: NGIAgoraVideoTrack.h:88
int receivedBitrate
Definition: NGIAgoraVideoTrack.h:457
int capture_height
Definition: NGIAgoraVideoTrack.h:284
RemoteVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:535
Definition: AgoraBase.h:1086
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
~IVideoTrack()
Definition: NGIAgoraVideoTrack.h:208
int decoderOutputFrameRate
Definition: NGIAgoraVideoTrack.h:463
bool operator==(const StreamLayerConfigInternal &rhs) const
Definition: NGIAgoraVideoTrack.h:47
Definition: AgoraBase.h:3248
unsigned int uid_t
Definition: AgoraMediaBase.h:28
VideoDimensions dimensions
Definition: AgoraBase.h:2143
int width
Definition: NGIAgoraVideoTrack.h:449
int target_media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:268
uint32_t encoder_type
Definition: NGIAgoraVideoTrack.h:301
@ STREAM_LAYER_6
Definition: NGIAgoraVideoTrack.h:35
QUALITY_ADAPT_INDICATION quality_adapt_indication
Definition: NGIAgoraVideoTrack.h:314
int regulated_capture_frame_rate
Definition: NGIAgoraVideoTrack.h:252
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver)=0
int encode_frame_rate
Definition: NGIAgoraVideoTrack.h:260
uint64_t bytes_major_stream
Definition: NGIAgoraVideoTrack.h:228
uint32_t hw_encoder_accelerating
Definition: NGIAgoraVideoTrack.h:302
uint32_t uplink_cost_time_ms
Definition: NGIAgoraVideoTrack.h:310
Definition: video_node_i.h:28
StreamLayerIndexInternal
Definition: NGIAgoraVideoTrack.h:29
int vqa_mos
Definition: NGIAgoraVideoTrack.h:521
int height
Definition: NGIAgoraVideoTrack.h:300
Definition: NGIAgoraVideoTrack.h:220
uint32_t received_bytes
Definition: NGIAgoraVideoTrack.h:490
StreamLayerConfigInternal()
Definition: NGIAgoraVideoTrack.h:45
bool enable
Definition: AgoraBase.h:2151