|
Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
8 #pragma once // NOLINT(build/header_guard)
11 #include <api/aosl_ref.h>
13 #ifndef OPTIONAL_OVERRIDE
14 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
15 #define OPTIONAL_OVERRIDE override
17 #define OPTIONAL_OVERRIDE
24 class IVideoEncodedFrameObserver;
25 class IMediaPacketReceiver;
122 const char*
id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
136 const char*
id = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
187 virtual int enableVideoFilter(
const char*
id,
bool enable, aosl_ref_t ares = AOSL_REF_INVALID) {
return -1; }
198 virtual int setFilterProperty(
const char*
id,
const char* key,
const char* json_value, aosl_ref_t ares = AOSL_REF_INVALID) {
return -1; }
209 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; }
405 virtual int setEnabled(
bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
int bitrate_kbps
Definition: NGIAgoraVideoTrack.h:42
virtual int enableVideoFilter(const char *id, bool enable, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:187
VIDEO_STREAM_TYPE rxStreamType
Definition: NGIAgoraVideoTrack.h:504
int e2eDelay
Definition: NGIAgoraVideoTrack.h:473
StreamLayerConfigInternal()
Definition: NGIAgoraVideoTrack.h:44
Definition: NGIAgoraVideoTrack.h:39
uint64_t number_of_streams
Definition: NGIAgoraVideoTrack.h:250
int width
Definition: NGIAgoraVideoTrack.h:322
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ STREAM_LAYER_6
Definition: NGIAgoraVideoTrack.h:34
@ STREAM_LOW
Definition: NGIAgoraVideoTrack.h:35
int frozenRate
Definition: NGIAgoraVideoTrack.h:514
int capture_frame_rate
Definition: NGIAgoraVideoTrack.h:274
int encode_frame_rate
Definition: NGIAgoraVideoTrack.h:286
Definition: NGIAgoraVideoTrack.h:101
unsigned int uid_t
Definition: AgoraMediaBase.h:28
uint32_t downlink_process_time_ms
Definition: NGIAgoraVideoTrack.h:532
Definition: AgoraRefPtr.h:44
Definition: NGIAgoraVideoTrack.h:237
QUALITY_ADAPT_INDICATION
Definition: AgoraBase.h:2894
int regulated_capture_height
Definition: NGIAgoraVideoTrack.h:318
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
@ REMOTE_VIDEO_IMAGE_TRACK
Definition: NGIAgoraVideoTrack.h:95
StreamLayerIndexInternal
Definition: NGIAgoraVideoTrack.h:28
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *videoReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ ADAPT_NONE
Definition: AgoraBase.h:2898
bool operator==(const StreamLayerConfigInternal &rhs) const
Definition: NGIAgoraVideoTrack.h:46
~IVideoTrack()
Definition: NGIAgoraVideoTrack.h:234
int framerate
Definition: NGIAgoraVideoTrack.h:41
bool publish_on_demand
Definition: NGIAgoraVideoTrack.h:70
unsigned short txPacketLossRate
Definition: NGIAgoraVideoTrack.h:345
int framerate
Definition: NGIAgoraVideoTrack.h:240
VideoDimensions dimensions
Definition: NGIAgoraVideoTrack.h:40
bool enable
Definition: AgoraBase.h:2255
int vqa_mos
Definition: NGIAgoraVideoTrack.h:549
int vqa_avg_cost_ms
Definition: NGIAgoraVideoTrack.h:553
int width
Definition: NGIAgoraVideoTrack.h:238
~ILocalVideoTrack()
Definition: NGIAgoraVideoTrack.h:456
int target_media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:294
@ STREAM_LAYER_1
Definition: NGIAgoraVideoTrack.h:29
int render_frame_rate
Definition: NGIAgoraVideoTrack.h:290
uint32_t encoder_frame_depth
Definition: NGIAgoraVideoTrack.h:329
Definition: AgoraBase.h:1960
virtual bool getTrackInfo(VideoTrackInfo &info)=0
int input_frame_rate
Definition: NGIAgoraVideoTrack.h:282
uint32_t received_bytes
Definition: NGIAgoraVideoTrack.h:518
StreamLayerConfigInternal & operator=(const SimulcastConfig::StreamLayerConfig &slc)
Definition: NGIAgoraVideoTrack.h:50
int regulated_capture_width
Definition: NGIAgoraVideoTrack.h:314
virtual bool hasVideoFilter(const char *id, media::base::VIDEO_MODULE_POSITION position=media::base::POSITION_POST_CAPTURER)=0
~IRemoteVideoTrack()
Definition: NGIAgoraVideoTrack.h:623
int height
Definition: NGIAgoraVideoTrack.h:481
int totalFrozenTime
Definition: NGIAgoraVideoTrack.h:510
uint64_t totalActiveTime
Definition: NGIAgoraVideoTrack.h:541
@ STREAM_LAYER_2
Definition: NGIAgoraVideoTrack.h:30
int height
Definition: NGIAgoraVideoTrack.h:239
VideoTrackType
Definition: NGIAgoraVideoTrack.h:92
int height
Definition: AgoraBase.h:1147
uint32_t hw_encoder_accelerating
Definition: NGIAgoraVideoTrack.h:328
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
Definition: AgoraAtomicOps.h:21
int capture_width
Definition: NGIAgoraVideoTrack.h:306
CAPTURE_BRIGHTNESS_LEVEL_TYPE
Definition: AgoraBase.h:3225
virtual bool removeRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
SIMULCAST_STREAM_MODE
Definition: AgoraBase.h:2157
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:3580
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:209
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:453
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:3337
virtual VideoTrackType getType()=0
virtual int setEnabled(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint32_t ssrc_major_stream
Definition: NGIAgoraVideoTrack.h:266
@ STREAM_LAYER_3
Definition: NGIAgoraVideoTrack.h:31
int regulated_capture_frame_rate
Definition: NGIAgoraVideoTrack.h:278
int decoderInputFrameRate
Definition: NGIAgoraVideoTrack.h:488
void reset()
Definition: NGIAgoraVideoTrack.h:57
CAPTURE_BRIGHTNESS_LEVEL_TYPE capture_brightness_level
Definition: NGIAgoraVideoTrack.h:349
uint32_t totalDecodedFrames
Definition: NGIAgoraVideoTrack.h:522
uint32_t ssrc_minor_stream
Definition: NGIAgoraVideoTrack.h:270
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *videoReceiver)=0
int delay
Definition: NGIAgoraVideoTrack.h:469
virtual int setFilterProperty(const char *id, const char *key, const char *json_value, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:198
Definition: NGIAgoraVideoTrack.h:394
uint32_t frames_encoded
Definition: NGIAgoraVideoTrack.h:262
uint32_t uplink_cost_time_ms
Definition: NGIAgoraVideoTrack.h:337
Definition: AgoraBase.h:2241
bool publish_fallback_enable
Definition: NGIAgoraVideoTrack.h:69
RemoteVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:563
uint32_t encoder_vender_id
Definition: NGIAgoraVideoTrack.h:333
#define OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:17
int decoderOutputFrameRate
Definition: NGIAgoraVideoTrack.h:491
void reset()
Definition: NGIAgoraVideoTrack.h:72
int framerate
Definition: AgoraBase.h:2249
uint32_t decoder_type
Definition: NGIAgoraVideoTrack.h:561
@ CAPTURE_BRIGHTNESS_LEVEL_INVALID
Definition: AgoraBase.h:3230
bool operator==(const SimulcastConfigInternal &rhs) const
Definition: NGIAgoraVideoTrack.h:78
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1617
virtual REMOTE_VIDEO_STATE getState()=0
uint32_t frame_render_delay_ms
Definition: NGIAgoraVideoTrack.h:536
virtual VideoTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraVideoTrack.h:620
int frameLossRate
Definition: NGIAgoraVideoTrack.h:497
Definition: NGIAgoraVideoTrack.h:66
VideoDimensions dimensions
Definition: AgoraBase.h:2245
QUALITY_ADAPT_INDICATION quality_adapt_indication
Definition: NGIAgoraVideoTrack.h:341
StreamLayerConfigInternal(const StreamLayerConfigInternal &other)
Definition: NGIAgoraVideoTrack.h:45
@ STREAM_LAYER_4
Definition: NGIAgoraVideoTrack.h:32
@ STREAM_LAYER_5
Definition: NGIAgoraVideoTrack.h:33
uint64_t publishDuration
Definition: NGIAgoraVideoTrack.h:545
Definition: NGIAgoraVideoTrack.h:574
virtual bool addRenderer(agora_refptr< IVideoSinkBase > videoRenderer, media::base::VIDEO_MODULE_POSITION position, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setSimulcastStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastConfigInternal &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
int capture_height
Definition: NGIAgoraVideoTrack.h:310
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1613
virtual bool getStatistics(LocalVideoTrackStats &stats)=0
bool enable
Definition: NGIAgoraVideoTrack.h:43
uint32_t decoder_vender_id
Definition: NGIAgoraVideoTrack.h:557
int width
Definition: NGIAgoraVideoTrack.h:477
Definition: NGIAgoraVideoTrack.h:461
virtual bool getStatistics(RemoteVideoTrackStats &stats)=0
uint32_t encoder_type
Definition: NGIAgoraVideoTrack.h:327
int width
Definition: AgoraBase.h:1143
const int STANDARD_BITRATE
Definition: AgoraBase.h:1160
uint64_t bytes_major_stream
Definition: NGIAgoraVideoTrack.h:254
Definition: AgoraRefPtr.h:31
int total_bitrate_bps
Definition: NGIAgoraVideoTrack.h:302
SimulcastStreamProfile simulcast_stream_profile[STREAM_LAYER_COUNT_MAX]
Definition: NGIAgoraVideoTrack.h:351
SimulcastConfigInternal()
Definition: NGIAgoraVideoTrack.h:89
Definition: AgoraBase.h:1139
@ STREAM_LAYER_COUNT_MAX
Definition: NGIAgoraVideoTrack.h:36
int packetLossRate
Definition: NGIAgoraVideoTrack.h:500
uint64_t bytes_minor_stream
Definition: NGIAgoraVideoTrack.h:258
int avSyncTimeMs
Definition: NGIAgoraVideoTrack.h:527
LocalVideoTrackStats()
Definition: NGIAgoraVideoTrack.h:353
int media_bitrate_bps
Definition: NGIAgoraVideoTrack.h:298
Definition: AgoraBase.h:3694
@ REMOTE_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:94
int height
Definition: NGIAgoraVideoTrack.h:326
StreamLayerConfigInternal simulcastlayerConfigs[STREAM_LAYER_COUNT_MAX]
Definition: NGIAgoraVideoTrack.h:67
virtual LOCAL_VIDEO_STREAM_STATE getState()=0
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraVideoTrack.h:223
int rendererOutputFrameRate
Definition: NGIAgoraVideoTrack.h:494
uid_t uid
Definition: NGIAgoraVideoTrack.h:465
@ LOCAL_VIDEO_TRACK
Definition: NGIAgoraVideoTrack.h:93
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *encodedObserver)
Definition: NGIAgoraVideoTrack.h:231
int bitrate
Definition: NGIAgoraVideoTrack.h:241
int receivedBitrate
Definition: NGIAgoraVideoTrack.h:485
Definition: NGIAgoraVideoTrack.h:246