Agora Java API Reference for Android
IAgoraRtcEngine.h
1 //
2 // Agora Rtc Engine SDK
3 //
4 // Copyright (c) 2018 Agora.io. All rights reserved.
5 //
6 #pragma once
7 
8 #include "AgoraBase.h"
9 #include "AgoraMediaBase.h"
10 #include "IAgoraLog.h"
11 #include "AgoraOptional.h"
12 #include "IAudioDeviceManager.h"
13 #include "IAgoraRhythmPlayer.h"
14 #include "IAgoraMediaEngine.h"
15 #include "IAgoraH265Transcoder.h"
16 
17 namespace agora {
18 namespace rtm {
19 class IStreamChannel;
20 }
21 namespace rtc {
22 
23 template <typename T>
24 static void SetFrom(Optional<T>* s, const Optional<T>& o) {
25  if (o) {
26  *s = o;
27  }
28 }
29 
30 template <typename T>
31 static void ReplaceBy(Optional<T>* s, const Optional<T>& o) {
32  *s = o;
33 }
34 
35 //class IAudioDeviceManager;
36 
40 enum MEDIA_DEVICE_TYPE {
44  UNKNOWN_AUDIO_DEVICE = -1,
48  AUDIO_PLAYOUT_DEVICE = 0,
52  AUDIO_RECORDING_DEVICE = 1,
56  VIDEO_RENDER_DEVICE = 2,
60  VIDEO_CAPTURE_DEVICE = 3,
64  AUDIO_APPLICATION_PLAYOUT_DEVICE = 4,
68  AUDIO_VIRTUAL_PLAYOUT_DEVICE = 5,
72  AUDIO_VIRTUAL_RECORDING_DEVICE = 6,
73 };
74 
78 enum AUDIO_MIXING_STATE_TYPE {
80  AUDIO_MIXING_STATE_PLAYING = 710,
82  AUDIO_MIXING_STATE_PAUSED = 711,
84  AUDIO_MIXING_STATE_STOPPED = 713,
87  AUDIO_MIXING_STATE_FAILED = 714,
88 };
89 
93 enum AUDIO_MIXING_REASON_TYPE {
95  AUDIO_MIXING_REASON_CAN_NOT_OPEN = 701,
97  AUDIO_MIXING_REASON_TOO_FREQUENT_CALL = 702,
99  AUDIO_MIXING_REASON_INTERRUPTED_EOF = 703,
101  AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED = 721,
103  AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED = 723,
105  AUDIO_MIXING_REASON_STOPPED_BY_USER = 724,
107  AUDIO_MIXING_REASON_RESUMED_BY_USER = 726,
109  AUDIO_MIXING_REASON_OK = 0,
110 };
111 
115 enum INJECT_STREAM_STATUS {
119  INJECT_STREAM_STATUS_START_SUCCESS = 0,
123  INJECT_STREAM_STATUS_START_ALREADY_EXISTS = 1,
127  INJECT_STREAM_STATUS_START_UNAUTHORIZED = 2,
131  INJECT_STREAM_STATUS_START_TIMEDOUT = 3,
135  INJECT_STREAM_STATUS_START_FAILED = 4,
139  INJECT_STREAM_STATUS_STOP_SUCCESS = 5,
143  INJECT_STREAM_STATUS_STOP_NOT_FOUND = 6,
147  INJECT_STREAM_STATUS_STOP_UNAUTHORIZED = 7,
151  INJECT_STREAM_STATUS_STOP_TIMEDOUT = 8,
155  INJECT_STREAM_STATUS_STOP_FAILED = 9,
159  INJECT_STREAM_STATUS_BROKEN = 10,
160 };
161 
165 enum AUDIO_EQUALIZATION_BAND_FREQUENCY {
169  AUDIO_EQUALIZATION_BAND_31 = 0,
173  AUDIO_EQUALIZATION_BAND_62 = 1,
177  AUDIO_EQUALIZATION_BAND_125 = 2,
181  AUDIO_EQUALIZATION_BAND_250 = 3,
185  AUDIO_EQUALIZATION_BAND_500 = 4,
189  AUDIO_EQUALIZATION_BAND_1K = 5,
193  AUDIO_EQUALIZATION_BAND_2K = 6,
197  AUDIO_EQUALIZATION_BAND_4K = 7,
201  AUDIO_EQUALIZATION_BAND_8K = 8,
205  AUDIO_EQUALIZATION_BAND_16K = 9,
206 };
207 
211 enum AUDIO_REVERB_TYPE {
215  AUDIO_REVERB_DRY_LEVEL = 0,
219  AUDIO_REVERB_WET_LEVEL = 1,
223  AUDIO_REVERB_ROOM_SIZE = 2,
227  AUDIO_REVERB_WET_DELAY = 3,
231  AUDIO_REVERB_STRENGTH = 4,
232 };
233 
234 enum STREAM_FALLBACK_OPTIONS {
239  STREAM_FALLBACK_OPTION_DISABLED = 0,
244  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW = 1,
248  STREAM_FALLBACK_OPTION_AUDIO_ONLY = 2,
253  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1 = 3,
254  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2 = 4,
255  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3 = 5,
256  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4 = 6,
257  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5 = 7,
258  STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6 = 8,
259 };
260 
261 enum PRIORITY_TYPE {
264  PRIORITY_HIGH = 50,
267  PRIORITY_NORMAL = 100,
268 };
269 
270 struct RtcConnection;
271 
274 struct LocalVideoStats
275 {
279  uid_t uid;
283  int sentBitrate;
287  int sentFrameRate;
290  int captureFrameRate;
293  int captureFrameWidth;
296  int captureFrameHeight;
300  int regulatedCaptureFrameRate;
304  int regulatedCaptureFrameWidth;
308  int regulatedCaptureFrameHeight;
311  int encoderOutputFrameRate;
314  int encodedFrameWidth;
317  int encodedFrameHeight;
320  int rendererOutputFrameRate;
323  int targetBitrate;
326  int targetFrameRate;
330  QUALITY_ADAPT_INDICATION qualityAdaptIndication;
334  int encodedBitrate;
337  int encodedFrameCount;
340  VIDEO_CODEC_TYPE codecType;
344  unsigned short txPacketLossRate;
347  CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel;
351  bool dualStreamEnabled;
356  int hwEncoderAccelerating;
359  VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX];
360 };
361 
365 struct RemoteAudioStats
366 {
370  uid_t uid;
374  int quality;
378  int networkTransportDelay;
384  int jitterBufferDelay;
388  int audioLossRate;
392  int numChannels;
396  int receivedSampleRate;
401  int receivedBitrate;
408  int totalFrozenTime;
413  int frozenRate;
430  int mosValue;
435  uint32_t frozenRateByCustomPlcCount;
439  uint32_t plcCount;
440 
444  uint32_t frozenCntByCustom;
445 
449  uint32_t frozenTimeByCustom;
450 
455  int totalActiveTime;
459  int publishDuration;
463  int qoeQuality;
467  int qualityChangedReason;
471  unsigned int rxAudioBytes;
475  int e2eDelay;
476 
477  RemoteAudioStats()
478  : uid(0),
479  quality(0),
480  networkTransportDelay(0),
481  jitterBufferDelay(0),
482  audioLossRate(0),
483  numChannels(0),
484  receivedSampleRate(0),
485  receivedBitrate(0),
486  totalFrozenTime(0),
487  frozenRate(0),
488  mosValue(0),
489  frozenRateByCustomPlcCount(0),
490  plcCount(0),
491  frozenCntByCustom(0),
492  frozenTimeByCustom(0),
493  totalActiveTime(0),
494  publishDuration(0),
495  qoeQuality(0),
496  qualityChangedReason(0),
497  rxAudioBytes(0),
498  e2eDelay(0) {}
499 };
500 
504 struct RemoteVideoStats {
508  uid_t uid;
516  int delay __deprecated;
520  int e2eDelay;
524  int width;
528  int height;
532  int receivedBitrate;
535  int decoderInputFrameRate;
538  int decoderOutputFrameRate;
541  int rendererOutputFrameRate;
544  int frameLossRate;
547  int packetLossRate;
551  VIDEO_STREAM_TYPE rxStreamType;
557  int totalFrozenTime;
561  int frozenRate;
566  int avSyncTimeMs;
571  int totalActiveTime;
575  int publishDuration;
583  int mosValue;
587  unsigned int rxVideoBytes;
588 };
589 
590 struct VideoCompositingLayout {
591  struct Region {
594  uid_t uid;
597  double x; // [0,1]
600  double y; // [0,1]
604  double width; // [0,1]
606  double height; // [0,1]
610  int zOrder; // optional, [0, 100] //0 (default): bottom most, 100: top most
611 
615  double alpha;
616 
617  media::base::RENDER_MODE_TYPE renderMode; // RENDER_MODE_HIDDEN: Crop, RENDER_MODE_FIT: Zoom to fit
618 
619  Region()
620  : uid(0),
621  x(0),
622  y(0),
623  width(0),
624  height(0),
625  zOrder(0),
626  alpha(1.0),
627  renderMode(media::base::RENDER_MODE_HIDDEN) {}
628  };
629 
634  int canvasWidth;
639  int canvasHeight;
642  const char* backgroundColor; // e.g. "#C0C0C0" in RGB
646  const Region* regions;
649  int regionCount;
652  const char* appData;
655  int appDataLength;
656 
657  VideoCompositingLayout()
658  : canvasWidth(0),
659  canvasHeight(0),
660  backgroundColor(OPTIONAL_NULLPTR),
661  regions(NULL),
662  regionCount(0),
663  appData(OPTIONAL_NULLPTR),
664  appDataLength(0) {}
665 };
666 
669 struct InjectStreamConfig {
673  int width;
677  int height;
681  int videoGop;
685  int videoFramerate;
689  int videoBitrate;
693  AUDIO_SAMPLE_RATE_TYPE audioSampleRate;
697  int audioBitrate;
700  int audioChannels;
701 
702  // width / height default set to 0 means pull the stream with its original
703  // resolution
704  InjectStreamConfig()
705  : width(0),
706  height(0),
707  videoGop(30),
708  videoFramerate(15),
709  videoBitrate(400),
710  audioSampleRate(AUDIO_SAMPLE_RATE_48000),
711  audioBitrate(48),
712  audioChannels(1) {}
713 };
714 
717 enum RTMP_STREAM_LIFE_CYCLE_TYPE {
720  RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1,
723  RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2,
724 };
725 
728 struct PublisherConfiguration {
732  int width;
736  int height;
740  int framerate;
744  int bitrate;
750  int defaultLayout;
753  int lifecycle;
758  bool owner;
761  int injectStreamWidth;
764  int injectStreamHeight;
767  const char* injectStreamUrl;
771  const char* publishUrl;
775  const char* rawStreamUrl;
778  const char* extraInfo;
779 
780  PublisherConfiguration()
781  : width(640),
782  height(360),
783  framerate(15),
784  bitrate(500),
785  defaultLayout(1),
786  lifecycle(RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL),
787  owner(true),
788  injectStreamWidth(0),
789  injectStreamHeight(0),
790  injectStreamUrl(NULL),
791  publishUrl(NULL),
792  rawStreamUrl(NULL),
793  extraInfo(NULL) {}
794 };
795 
799 enum CAMERA_DIRECTION {
801  CAMERA_REAR = 0,
803  CAMERA_FRONT = 1,
804 };
805 
810 enum CLOUD_PROXY_TYPE {
813  NONE_PROXY = 0,
816  UDP_PROXY = 1,
818 
820  TCP_PROXY = 2,
822 };
823 
825 struct CameraCapturerConfiguration {
827 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
828 
831  Optional<CAMERA_DIRECTION> cameraDirection;
832 
833  /*- CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_DEFAULT:
834  For iOS, if iPhone/iPad has 3 or 2 back camera, it means combination of triple (wide + ultra wide + telephoto) camera
835  or dual wide(wide + ultra wide) camera.In this situation, you can apply for ultra wide len by set smaller zoom fator
836  and bigger zoom fator for telephoto len.Otherwise, it always means wide back/front camera.
837 
838  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_WIDE_ANGLE:wide camera
839  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_ULTRA_WIDE:ultra wide camera
840  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_TELEPHOTO:telephoto camera*/
841  Optional<CAMERA_FOCAL_LENGTH_TYPE> cameraFocalLengthType;
842 #else
843 
844  Optional<const char *> deviceId;
845 #endif
846 
847 #if defined(__ANDROID__)
848 
851  Optional<const char *> cameraId;
852 #endif
853  Optional<bool> followEncodeDimensionRatio;
855  VideoFormat format;
856  CameraCapturerConfiguration() : format(VideoFormat(0, 0, 0)) {}
857 };
861 struct ScreenCaptureConfiguration {
867  bool isCaptureWindow; // true - capture window, false - capture display
871  uint32_t displayId;
876  Rectangle screenRect; //Windows only
881  view_t windowId;
885  ScreenCaptureParameters params;
893  Rectangle regionRect;
894 
895  ScreenCaptureConfiguration() : isCaptureWindow(false), displayId(0), windowId(0) {}
896 };
897 
898 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
899 
901 struct SIZE {
904  int width;
907  int height;
908 
909  SIZE() : width(0), height(0) {}
910  SIZE(int ww, int hh) : width(ww), height(hh) {}
911 };
912 #endif
913 
914 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
915 
920 struct ThumbImageBuffer {
924  const char* buffer;
928  unsigned int length;
932  unsigned int width;
936  unsigned int height;
937  ThumbImageBuffer() : buffer(nullptr), length(0), width(0), height(0) {}
938 };
942 enum ScreenCaptureSourceType {
944  ScreenCaptureSourceType_Unknown = -1,
946  ScreenCaptureSourceType_Window = 0,
948  ScreenCaptureSourceType_Screen = 1,
950  ScreenCaptureSourceType_Custom = 2,
951 };
953 struct ScreenCaptureSourceInfo {
957  ScreenCaptureSourceType type;
961  view_t sourceId;
965  const char* sourceName;
969  ThumbImageBuffer thumbImage;
973  ThumbImageBuffer iconImage;
977  const char* processPath;
981  const char* sourceTitle;
987  bool primaryMonitor;
988  bool isOccluded;
992  Rectangle position;
993 #if defined(_WIN32)
994 
997  bool minimizeWindow;
1004  view_t sourceDisplayId;
1005  ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(nullptr), sourceName(nullptr),
1006  processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false), minimizeWindow(false), sourceDisplayId((view_t)-2) {}
1007 #else
1008  ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(nullptr), sourceName(nullptr), processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false) {}
1009 #endif
1010 };
1014 class IScreenCaptureSourceList {
1015  protected:
1016  virtual ~IScreenCaptureSourceList(){};
1017 
1018  public:
1024  virtual unsigned int getCount() = 0;
1034  virtual ScreenCaptureSourceInfo getSourceInfo(unsigned int index) = 0;
1041  virtual void release() = 0;
1042 };
1043 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
1044 
1047 struct AdvancedAudioOptions {
1051  Optional<int> audioProcessingChannels;
1052 
1053  AdvancedAudioOptions() {}
1054  ~AdvancedAudioOptions() {}
1055 };
1056 
1057 struct ImageTrackOptions {
1058  const char* imageUrl;
1059  int fps;
1060  VIDEO_MIRROR_MODE_TYPE mirrorMode;
1061  ImageTrackOptions() : imageUrl(NULL), fps(1), mirrorMode(VIDEO_MIRROR_MODE_DISABLED) {}
1062 };
1063 
1072 struct ChannelMediaOptions {
1078  Optional<bool> publishCameraTrack;
1084  Optional<bool> publishSecondaryCameraTrack;
1090  Optional<bool> publishThirdCameraTrack;
1096  Optional<bool> publishFourthCameraTrack;
1102  Optional<bool> publishMicrophoneTrack;
1103 
1104  #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1105 
1110  Optional<bool> publishScreenCaptureVideo;
1116  Optional<bool> publishScreenCaptureAudio;
1117  #else
1118 
1123  Optional<bool> publishScreenTrack;
1129  Optional<bool> publishSecondaryScreenTrack;
1135  Optional<bool> publishThirdScreenTrack;
1141  Optional<bool> publishFourthScreenTrack;
1142  #endif
1143 
1149  Optional<bool> publishCustomAudioTrack;
1153  Optional<int> publishCustomAudioTrackId;
1159  Optional<bool> publishCustomVideoTrack;
1165  Optional<bool> publishEncodedVideoTrack;
1171  Optional<bool> publishMediaPlayerAudioTrack;
1177  Optional<bool> publishMediaPlayerVideoTrack;
1183  Optional<bool> publishTranscodedVideoTrack;
1189  Optional<bool> publishMixedAudioTrack;
1195  Optional<bool> publishLipSyncTrack;
1201  Optional<bool> autoSubscribeAudio;
1207  Optional<bool> autoSubscribeVideo;
1213  Optional<bool> enableAudioRecordingOrPlayout;
1217  Optional<int> publishMediaPlayerId;
1222  Optional<CLIENT_ROLE_TYPE> clientRoleType;
1226  Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel;
1231  Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType;
1236  Optional<CHANNEL_PROFILE_TYPE> channelProfile;
1241  Optional<int> audioDelayMs;
1246  Optional<int> mediaPlayerAudioDelayMs;
1255  Optional<const char*> token;
1263  Optional<bool> enableBuiltInMediaEncryption;
1269  Optional<bool> publishRhythmPlayerTrack;
1277  Optional<bool> isInteractiveAudience;
1282  Optional<video_track_id_t> customVideoTrackId;
1288  Optional<bool> isAudioFilterable;
1289 
1294  Optional<const char*> parameters;
1295 
1296  ChannelMediaOptions() {}
1297  ~ChannelMediaOptions() {}
1298 
1299  void SetAll(const ChannelMediaOptions& change) {
1300 #define SET_FROM(X) SetFrom(&X, change.X)
1301 
1302  SET_FROM(publishCameraTrack);
1303  SET_FROM(publishSecondaryCameraTrack);
1304  SET_FROM(publishThirdCameraTrack);
1305  SET_FROM(publishFourthCameraTrack);
1306  SET_FROM(publishMicrophoneTrack);
1307 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1308  SET_FROM(publishScreenCaptureVideo);
1309  SET_FROM(publishScreenCaptureAudio);
1310 #else
1311  SET_FROM(publishScreenTrack);
1312  SET_FROM(publishSecondaryScreenTrack);
1313  SET_FROM(publishThirdScreenTrack);
1314  SET_FROM(publishFourthScreenTrack);
1315 #endif
1316  SET_FROM(publishTranscodedVideoTrack);
1317  SET_FROM(publishMixedAudioTrack);
1318  SET_FROM(publishLipSyncTrack);
1319  SET_FROM(publishCustomAudioTrack);
1320  SET_FROM(publishCustomAudioTrackId);
1321  SET_FROM(publishCustomVideoTrack);
1322  SET_FROM(publishEncodedVideoTrack);
1323  SET_FROM(publishMediaPlayerAudioTrack);
1324  SET_FROM(publishMediaPlayerVideoTrack);
1325  SET_FROM(autoSubscribeAudio);
1326  SET_FROM(autoSubscribeVideo);
1327  SET_FROM(publishMediaPlayerId);
1328  SET_FROM(enableAudioRecordingOrPlayout);
1329  SET_FROM(clientRoleType);
1330  SET_FROM(audienceLatencyLevel);
1331  SET_FROM(defaultVideoStreamType);
1332  SET_FROM(channelProfile);
1333  SET_FROM(audioDelayMs);
1334  SET_FROM(mediaPlayerAudioDelayMs);
1335  SET_FROM(token);
1336  SET_FROM(enableBuiltInMediaEncryption);
1337  SET_FROM(publishRhythmPlayerTrack);
1338  SET_FROM(customVideoTrackId);
1339  SET_FROM(isAudioFilterable);
1340  SET_FROM(isInteractiveAudience);
1341  SET_FROM(parameters);
1342 #undef SET_FROM
1343  }
1344 
1345  bool operator==(const ChannelMediaOptions& o) const {
1346 #define BEGIN_COMPARE() bool b = true
1347 #define ADD_COMPARE(X) b = (b && (X == o.X))
1348 #define END_COMPARE()
1349 
1350  BEGIN_COMPARE();
1351  ADD_COMPARE(publishCameraTrack);
1352  ADD_COMPARE(publishSecondaryCameraTrack);
1353  ADD_COMPARE(publishThirdCameraTrack);
1354  ADD_COMPARE(publishFourthCameraTrack);
1355  ADD_COMPARE(publishMicrophoneTrack);
1356 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1357  ADD_COMPARE(publishScreenCaptureVideo);
1358  ADD_COMPARE(publishScreenCaptureAudio);
1359 #else
1360  ADD_COMPARE(publishScreenTrack);
1361  ADD_COMPARE(publishSecondaryScreenTrack);
1362  ADD_COMPARE(publishThirdScreenTrack);
1363  ADD_COMPARE(publishFourthScreenTrack);
1364 #endif
1365  ADD_COMPARE(publishTranscodedVideoTrack);
1366  ADD_COMPARE(publishMixedAudioTrack);
1367  ADD_COMPARE(publishLipSyncTrack);
1368  ADD_COMPARE(publishCustomAudioTrack);
1369  ADD_COMPARE(publishCustomAudioTrackId);
1370  ADD_COMPARE(publishCustomVideoTrack);
1371  ADD_COMPARE(publishEncodedVideoTrack);
1372  ADD_COMPARE(publishMediaPlayerAudioTrack);
1373  ADD_COMPARE(publishMediaPlayerVideoTrack);
1374  ADD_COMPARE(autoSubscribeAudio);
1375  ADD_COMPARE(autoSubscribeVideo);
1376  ADD_COMPARE(publishMediaPlayerId);
1377  ADD_COMPARE(enableAudioRecordingOrPlayout);
1378  ADD_COMPARE(clientRoleType);
1379  ADD_COMPARE(audienceLatencyLevel);
1380  ADD_COMPARE(defaultVideoStreamType);
1381  ADD_COMPARE(channelProfile);
1382  ADD_COMPARE(audioDelayMs);
1383  ADD_COMPARE(mediaPlayerAudioDelayMs);
1384  ADD_COMPARE(token);
1385  ADD_COMPARE(enableBuiltInMediaEncryption);
1386  ADD_COMPARE(publishRhythmPlayerTrack);
1387  ADD_COMPARE(customVideoTrackId);
1388  ADD_COMPARE(isAudioFilterable);
1389  ADD_COMPARE(isInteractiveAudience);
1390  ADD_COMPARE(parameters);
1391  END_COMPARE();
1392 
1393 #undef BEGIN_COMPARE
1394 #undef ADD_COMPARE
1395 #undef END_COMPARE
1396  return b;
1397  }
1398 
1399  ChannelMediaOptions& operator=(const ChannelMediaOptions& replace) {
1400  if (this != &replace) {
1401 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
1402 
1403  REPLACE_BY(publishCameraTrack);
1404  REPLACE_BY(publishSecondaryCameraTrack);
1405  REPLACE_BY(publishThirdCameraTrack);
1406  REPLACE_BY(publishFourthCameraTrack);
1407  REPLACE_BY(publishMicrophoneTrack);
1408 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1409  REPLACE_BY(publishScreenCaptureVideo);
1410  REPLACE_BY(publishScreenCaptureAudio);
1411 #else
1412  REPLACE_BY(publishScreenTrack);
1413  REPLACE_BY(publishSecondaryScreenTrack);
1414  REPLACE_BY(publishThirdScreenTrack);
1415  REPLACE_BY(publishFourthScreenTrack);
1416 #endif
1417  REPLACE_BY(publishTranscodedVideoTrack);
1418  REPLACE_BY(publishMixedAudioTrack);
1419  REPLACE_BY(publishLipSyncTrack);
1420  REPLACE_BY(publishCustomAudioTrack);
1421  REPLACE_BY(publishCustomAudioTrackId);
1422  REPLACE_BY(publishCustomVideoTrack);
1423  REPLACE_BY(publishEncodedVideoTrack);
1424  REPLACE_BY(publishMediaPlayerAudioTrack);
1425  REPLACE_BY(publishMediaPlayerVideoTrack);
1426  REPLACE_BY(autoSubscribeAudio);
1427  REPLACE_BY(autoSubscribeVideo);
1428  REPLACE_BY(publishMediaPlayerId);
1429  REPLACE_BY(enableAudioRecordingOrPlayout);
1430  REPLACE_BY(clientRoleType);
1431  REPLACE_BY(audienceLatencyLevel);
1432  REPLACE_BY(defaultVideoStreamType);
1433  REPLACE_BY(channelProfile);
1434  REPLACE_BY(audioDelayMs);
1435  REPLACE_BY(mediaPlayerAudioDelayMs);
1436  REPLACE_BY(token);
1437  REPLACE_BY(enableBuiltInMediaEncryption);
1438  REPLACE_BY(publishRhythmPlayerTrack);
1439  REPLACE_BY(customVideoTrackId);
1440  REPLACE_BY(isAudioFilterable);
1441  REPLACE_BY(isInteractiveAudience);
1442  REPLACE_BY(parameters);
1443 #undef REPLACE_BY
1444  }
1445  return *this;
1446  }
1447 };
1448 
1449 enum PROXY_TYPE {
1452  NONE_PROXY_TYPE = 0,
1455  UDP_PROXY_TYPE = 1,
1458  TCP_PROXY_TYPE = 2,
1461  LOCAL_PROXY_TYPE = 3,
1464  TCP_PROXY_AUTO_FALLBACK_TYPE = 4,
1467  HTTP_PROXY_TYPE = 5,
1470  HTTPS_PROXY_TYPE = 6,
1471 };
1472 
1473 enum FeatureType {
1474  VIDEO_VIRTUAL_BACKGROUND = 1,
1475  VIDEO_BEAUTY_EFFECT = 2,
1476 };
1477 
1481 struct LeaveChannelOptions {
1487  bool stopAudioMixing;
1493  bool stopAllEffect;
1499  bool stopMicrophoneRecording;
1500 
1501  LeaveChannelOptions() : stopAudioMixing(true), stopAllEffect(true), stopMicrophoneRecording(true) {}
1502 };
1503 
1514 class IRtcEngineEventHandler {
1515  public:
1516  virtual ~IRtcEngineEventHandler() {}
1517 
1518  virtual const char* eventHandlerType() const { return "event_handler"; }
1519 
1529  virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1530  (void)channel;
1531  (void)uid;
1532  (void)elapsed;
1533  }
1534 
1545  virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1546  (void)channel;
1547  (void)uid;
1548  (void)elapsed;
1549  }
1550 
1558  virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) {
1559  (void)channel;
1560  (void)uid;
1561  (void)proxyType;
1562  (void)localProxyIp;
1563  (void)elapsed;
1564  }
1565 
1571  virtual void onError(int err, const char* msg) {
1572  (void)err;
1573  (void)msg;
1574  }
1575 
1591  virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated {
1592  (void)uid;
1593  (void)quality;
1594  (void)delay;
1595  (void)lost;
1596  }
1597 
1603  virtual void onLastmileProbeResult(const LastmileProbeResult& result) {
1604  (void)result;
1605  }
1606 
1633  virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber,
1634  int totalVolume) {
1635  (void)speakers;
1636  (void)speakerNumber;
1637  (void)totalVolume;
1638  }
1639 
1648  virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; }
1649 
1657  virtual void onRtcStats(const RtcStats& stats) { (void)stats; }
1658 
1672  virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
1673  (void)deviceId;
1674  (void)deviceType;
1675  (void)deviceState;
1676  }
1677 
1684  virtual void onAudioMixingPositionChanged(int64_t position) {}
1685 
1692  virtual void onAudioMixingFinished() __deprecated {}
1693 
1701  virtual void onAudioEffectFinished(int soundId) {}
1702 
1712  virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
1713  (void)deviceId;
1714  (void)deviceType;
1715  (void)deviceState;
1716  }
1717 
1718 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
1719  virtual void onPipStateChanged(PIP_STATE state) {
1720  (void)state;
1721  };
1722 #endif
1723 
1746  virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) {
1747  (void)uid;
1748  (void)txQuality;
1749  (void)rxQuality;
1750  }
1751 
1758  virtual void onIntraRequestReceived() {}
1759 
1770  virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) {
1771  (void)info;
1772  }
1773 
1781  virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo& info) {
1782  (void)info;
1783  }
1784 
1797  virtual void onLastmileQuality(int quality) { (void)quality; }
1798 
1809  virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) {
1810  (void)source;
1811  (void)width;
1812  (void)height;
1813  (void)elapsed;
1814  }
1815 
1826  virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) {
1827  (void)source;
1828  (void)elapsed;
1829  }
1830 
1847  virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated {
1848  (void)uid;
1849  (void)width;
1850  (void)height;
1851  (void)elapsed;
1852  }
1853 
1862  virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
1863  (void)uid;
1864  (void)width;
1865  (void)height;
1866  (void)rotation;
1867  }
1868 
1895  virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason) {
1896  (void)source;
1897  (void)state;
1898  (void)reason;
1899  }
1900 
1912  virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) {
1913  (void)uid;
1914  (void)state;
1915  (void)reason;
1916  (void)elapsed;
1917  }
1918 
1926  virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed) {
1927  (void)uid;
1928  (void)width;
1929  (void)height;
1930  (void)elapsed;
1931  }
1932 
1952  virtual void onUserJoined(uid_t uid, int elapsed) {
1953  (void)uid;
1954  (void)elapsed;
1955  }
1956 
1971  virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) {
1972  (void)uid;
1973  (void)reason;
1974  }
1975 
1988  virtual void onUserMuteAudio(uid_t uid, bool muted) {
1989  (void)uid;
1990  (void)muted;
1991  }
1992 
2007  virtual void onUserMuteVideo(uid_t uid, bool muted) {
2008  (void)uid;
2009  (void)muted;
2010  }
2011 
2024  virtual void onUserEnableVideo(uid_t uid, bool enabled) {
2025  (void)uid;
2026  (void)enabled;
2027  }
2028 
2034  virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state) {
2035  (void)uid;
2036  (void)state;
2037  }
2038 
2049  virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated {
2050  (void)uid;
2051  (void)enabled;
2052  }
2053 
2061  virtual void onRemoteAudioStats(const RemoteAudioStats& stats) {
2062  (void)stats;
2063  }
2064 
2072  virtual void onLocalAudioStats(const LocalAudioStats& stats) {
2073  (void)stats;
2074  }
2075 
2089  virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) {
2090  (void)source;
2091  (void)stats;
2092  }
2093 
2102  virtual void onRemoteVideoStats(const RemoteVideoStats& stats) {
2103  (void)stats;
2104  }
2105 
2111  virtual void onCameraReady() __deprecated {}
2112 
2123  virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) {
2124  (void)x;
2125  (void)y;
2126  (void)width;
2127  (void)height;
2128  }
2137  virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) {
2138  (void)x;
2139  (void)y;
2140  (void)width;
2141  (void)height;
2142  }
2143 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
2144 
2174  virtual void onFacePositionChanged(int imageWidth, int imageHeight,
2175  const Rectangle* vecRectangle, const int* vecDistance,
2176  int numFaces) {
2177  (void) imageWidth;
2178  (void) imageHeight;
2179  (void) vecRectangle;
2180  (void) vecDistance;
2181  (void) numFaces;
2182  }
2183 #endif
2184 
2191  virtual void onVideoStopped() __deprecated {}
2192 
2200  virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) {
2201  (void)state;
2202  (void)reason;
2203  }
2204 
2213  virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason) {
2214  (void)state;
2215  (void)reason;
2216  }
2217 
2226  virtual void onConnectionLost() {}
2227 
2239  virtual void onConnectionInterrupted() __deprecated {}
2240 
2244  virtual void onConnectionBanned() __deprecated {}
2245 
2257  virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length, uint64_t sentTs) {
2258  (void)uid;
2259  (void)streamId;
2260  (void)data;
2261  (void)length;
2262  (void)sentTs;
2263  }
2264 
2277  virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached) {
2278  (void)uid;
2279  (void)streamId;
2280  (void)code;
2281  (void)missed;
2282  (void)cached;
2283  }
2284 
2294  virtual void onRequestToken() {}
2295 
2307  virtual void onTokenPrivilegeWillExpire(const char* token) {
2308  (void)token;
2309  }
2310 
2316  virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error) {
2317  (void)error;
2318  }
2319 
2330  virtual void onFirstLocalAudioFramePublished(int elapsed) {
2331  (void)elapsed;
2332  }
2333 
2350  virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated {
2351  (void)uid;
2352  (void)elapsed;
2353  }
2354 
2362  virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated {
2363  (void)uid;
2364  (void)elapsed;
2365  }
2366 
2381  virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason) {
2382  (void)state;
2383  (void)reason;
2384  }
2385 
2402  virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
2403  (void)uid;
2404  (void)state;
2405  (void)reason;
2406  (void)elapsed;
2407  }
2408 
2422  virtual void onActiveSpeaker(uid_t uid) {
2423  (void)uid;
2424  }
2425 
2430  virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; }
2431 
2449  virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) {
2450  (void)uid;
2451  (void)filePath;
2452  (void)width;
2453  (void)height;
2454  (void)errCode;
2455  }
2456 
2464  virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
2465  (void)oldRole;
2466  (void)newRole;
2467  (void)newRoleOptions;
2468  }
2469 
2477  virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) {
2478  (void)reason;
2479  (void)currentRole;
2480  }
2481 
2489  virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) {
2490  (void)deviceType;
2491  (void)volume;
2492  (void)muted;
2493  }
2494 
2506  virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state,
2507  RTMP_STREAM_PUBLISH_REASON reason) {
2508  (void)url;
2509  (void)state;
2510  (void)reason;
2511  }
2512 
2518  virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) {
2519  (void)url;
2520  (void)eventCode;
2521  }
2522 
2533  virtual void onTranscodingUpdated() {}
2534 
2548  virtual void onAudioRoutingChanged(int routing) { (void)routing; }
2549 
2581  virtual void onChannelMediaRelayStateChanged(int state, int code) {
2582  (void)state;
2583  (void)code;
2584  }
2585 
2599  virtual void onLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover) {
2600  (void)isFallbackOrRecover;
2601  }
2602 
2620  virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover) {
2621  (void)uid;
2622  (void)isFallbackOrRecover;
2623  }
2624 
2639  virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated {
2640  (void)uid;
2641  (void)delay;
2642  (void)lost;
2643  (void)rxKBitRate;
2644  }
2645 
2663  virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated {
2664  (void)uid;
2665  (void)delay;
2666  (void)lost;
2667  (void)rxKBitRate;
2668  }
2669 
2678  virtual void onConnectionStateChanged(
2679  CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) {
2680  (void)state;
2681  (void)reason;
2682  }
2683 
2690  virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char* wlAccMsg) {
2691  (void)reason;
2692  (void)action;
2693  (void)wlAccMsg;
2694  }
2695 
2701  virtual void onWlAccStats(const WlAccStats& currentStats, const WlAccStats& averageStats) {
2702  (void)currentStats;
2703  (void)averageStats;
2704  }
2705 
2715  virtual void onNetworkTypeChanged(NETWORK_TYPE type) {
2716  (void)type;
2717  }
2718 
2726  virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) {
2727  (void)errorType;
2728  }
2729 
2739  virtual void onPermissionError(PERMISSION_TYPE permissionType) {
2740  (void)permissionType;
2741  }
2742 
2743 #if defined(__ANDROID__)
2744 
2748  virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {}
2749 #endif
2750 
2760  virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
2761  (void)uid;
2762  (void)userAccount;
2763  }
2764 
2773  virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) {
2774  (void)uid;
2775  (void)info;
2776  }
2777 
2784  virtual void onUserAccountUpdated(uid_t uid, const char* userAccount){
2785  (void)uid;
2786  (void)userAccount;
2787  }
2788 
2796  virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {
2797  (void)uid;
2798  (void)currentEvent;
2799  (void)tracingInfo;
2800  }
2801 
2808  virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){
2809  (void)stream;
2810  (void)error;
2811  }
2812 
2819  virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
2820  (void)requestId;
2821  (void)success;
2822  (void)reason;
2823  }
2824 
2834  virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
2835  (void)channel;
2836  (void)uid;
2837  (void)oldState;
2838  (void)newState;
2839  (void)elapseSinceLastState;
2840  }
2841 
2851  virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
2852  (void)channel;
2853  (void)uid;
2854  (void)oldState;
2855  (void)newState;
2856  (void)elapseSinceLastState;
2857  }
2858 
2867  virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
2868  (void)channel;
2869  (void)oldState;
2870  (void)newState;
2871  (void)elapseSinceLastState;
2872  }
2873 
2883  virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
2884  (void)source;
2885  (void)channel;
2886  (void)oldState;
2887  (void)newState;
2888  (void)elapseSinceLastState;
2889  }
2890 
2900  virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
2901  (void)uid;
2902  (void)width;
2903  (void)height;
2904  (void)layoutCount;
2905  (void)layoutlist;
2906  }
2907 
2916  virtual void onAudioMetadataReceived(uid_t uid, const char* metadata, size_t length) {
2917  (void)uid;
2918  (void)metadata;
2919  (void)length;
2920  }
2921 
2932  virtual void onExtensionEvent(const char* provider, const char* extension, const char* key, const char* value) {
2933  (void)provider;
2934  (void)extension;
2935  (void)key;
2936  (void)value;
2937  }
2938 
2947  virtual void onExtensionStarted(const char* provider, const char* extension) {
2948  (void)provider;
2949  (void)extension;
2950  }
2951 
2960  virtual void onExtensionStopped(const char* provider, const char* extension) {
2961  (void)provider;
2962  (void)extension;
2963  }
2964 
2976  virtual void onExtensionError(const char* provider, const char* extension, int error, const char* message) {
2977  (void)provider;
2978  (void)extension;
2979  (void)error;
2980  (void)message;
2981  }
2982 
2989  virtual void onSetRtmFlagResult(int code) {
2990  (void)code;
2991  }
2992 };
2993 
2997 class IVideoDeviceCollection {
2998  public:
2999  virtual ~IVideoDeviceCollection() {}
3000 
3006  virtual int getCount() = 0;
3007 
3017  virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3018 
3029  virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
3030  char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3031 
3035  virtual void release() = 0;
3036 };
3037 
3041 class IVideoDeviceManager {
3042  public:
3043  virtual ~IVideoDeviceManager() {}
3055  virtual IVideoDeviceCollection* enumerateVideoDevices() = 0;
3056 
3067  virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3068 
3077  virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3078 
3079 #if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__)) || \
3080  (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
3081 
3098  virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;
3099 
3117  virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;
3118 #endif
3119 
3132  virtual int startDeviceTest(view_t hwnd) = 0;
3133 
3140  virtual int stopDeviceTest() = 0;
3141 
3145  virtual void release() = 0;
3146 };
3147 
3151 struct RtcEngineContext {
3155  IRtcEngineEventHandler* eventHandler;
3162  const char* appId;
3168  void* context;
3172  CHANNEL_PROFILE_TYPE channelProfile;
3173 
3177  const char* license;
3178 
3186  AUDIO_SCENARIO_TYPE audioScenario;
3195  unsigned int areaCode;
3196 
3212  commons::LogConfig logConfig;
3213 
3217  Optional<THREAD_PRIORITY_TYPE> threadPriority;
3218 
3226  bool useExternalEglContext;
3227 
3233  bool domainLimit;
3234 
3240  bool autoRegisterAgoraExtensions;
3241 
3242  RtcEngineContext()
3243  : eventHandler(NULL), appId(NULL), context(NULL), channelProfile(CHANNEL_PROFILE_LIVE_BROADCASTING),
3244  license(NULL), audioScenario(AUDIO_SCENARIO_DEFAULT), areaCode(AREA_CODE_GLOB),
3245  logConfig(), useExternalEglContext(false), domainLimit(false), autoRegisterAgoraExtensions(true) {}
3246 };
3247 
3250 class IMetadataObserver {
3251 public:
3252  virtual ~IMetadataObserver() {}
3253 
3258  enum METADATA_TYPE
3259  {
3262  UNKNOWN_METADATA = -1,
3265  VIDEO_METADATA = 0,
3266  };
3270  enum MAX_METADATA_SIZE_TYPE
3271  {
3272  INVALID_METADATA_SIZE_IN_BYTE = -1,
3273  DEFAULT_METADATA_SIZE_IN_BYTE = 512,
3274  MAX_METADATA_SIZE_IN_BYTE = 1024
3275  };
3276 
3279  struct Metadata
3280  {
3285  unsigned int uid;
3288  unsigned int size;
3291  unsigned char* buffer;
3295  long long timeStampMs;
3296 
3297  Metadata() : uid(0), size(0), buffer(NULL), timeStampMs(0) {}
3298  };
3299 
3310  virtual int getMaxMetadataSize() { return DEFAULT_METADATA_SIZE_IN_BYTE; }
3311 
3322  virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0;
3323 
3331  virtual void onMetadataReceived(const Metadata& metadata) = 0;
3332 };
3333 
3334 // The reason codes for media streaming
3335 // GENERATED_JAVA_ENUM_PACKAGE: io.agora.streaming
3336 enum DIRECT_CDN_STREAMING_REASON {
3337  // No error occurs.
3338  DIRECT_CDN_STREAMING_REASON_OK = 0,
3339  // A general error occurs (no specified reason).
3340  DIRECT_CDN_STREAMING_REASON_FAILED = 1,
3341  // Audio publication error.
3342  DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION = 2,
3343  // Video publication error.
3344  DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION = 3,
3345 
3346  DIRECT_CDN_STREAMING_REASON_NET_CONNECT = 4,
3347  // Already exist stream name.
3348  DIRECT_CDN_STREAMING_REASON_BAD_NAME = 5,
3349 };
3350 
3351 // The connection state of media streaming
3352 // GENERATED_JAVA_ENUM_PACKAGE: io.agora.streaming
3353 enum DIRECT_CDN_STREAMING_STATE {
3354 
3355  DIRECT_CDN_STREAMING_STATE_IDLE = 0,
3356 
3357  DIRECT_CDN_STREAMING_STATE_RUNNING = 1,
3358 
3359  DIRECT_CDN_STREAMING_STATE_STOPPED = 2,
3360 
3361  DIRECT_CDN_STREAMING_STATE_FAILED = 3,
3362 
3363  DIRECT_CDN_STREAMING_STATE_RECOVERING = 4,
3364 };
3365 
3369 struct DirectCdnStreamingStats {
3373  int videoWidth;
3374 
3378  int videoHeight;
3379 
3383  int fps;
3384 
3388  int videoBitrate;
3389 
3393  int audioBitrate;
3394 };
3395 
3400 class IDirectCdnStreamingEventHandler {
3401  public:
3402  virtual ~IDirectCdnStreamingEventHandler() {}
3403 
3410  virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char* message) {
3411  (void)state;
3412  (void)reason;
3413  (void)message;
3414  };
3415 
3416  virtual void onDirectCdnStreamingStats(const DirectCdnStreamingStats& stats) {
3417  (void)stats;
3418  };
3419 };
3420 
3424 struct DirectCdnStreamingMediaOptions {
3430  Optional<bool> publishCameraTrack;
3436  Optional<bool> publishMicrophoneTrack;
3442  Optional<bool> publishCustomAudioTrack;
3448  Optional<bool> publishCustomVideoTrack;
3454  Optional<bool> publishMediaPlayerAudioTrack;
3459  Optional<int> publishMediaPlayerId;
3464  Optional<video_track_id_t> customVideoTrackId;
3465 
3466  DirectCdnStreamingMediaOptions() {}
3467  ~DirectCdnStreamingMediaOptions() {}
3468 
3469  void SetAll(const DirectCdnStreamingMediaOptions& change) {
3470 #define SET_FROM(X) SetFrom(&X, change.X)
3471  SET_FROM(publishCameraTrack);
3472  SET_FROM(publishMicrophoneTrack);
3473  SET_FROM(publishCustomAudioTrack);
3474  SET_FROM(publishCustomVideoTrack);
3475  SET_FROM(publishMediaPlayerAudioTrack);
3476  SET_FROM(publishMediaPlayerId);
3477  SET_FROM(customVideoTrackId);
3478 #undef SET_FROM
3479  }
3480 
3481  bool operator==(const DirectCdnStreamingMediaOptions& o) const {
3482 #define BEGIN_COMPARE() bool b = true
3483 #define ADD_COMPARE(X) b = (b && (X == o.X))
3484 #define END_COMPARE()
3485 
3486  BEGIN_COMPARE();
3487  ADD_COMPARE(publishCameraTrack);
3488  ADD_COMPARE(publishMicrophoneTrack);
3489  ADD_COMPARE(publishCustomAudioTrack);
3490  ADD_COMPARE(publishCustomVideoTrack);
3491  ADD_COMPARE(publishMediaPlayerAudioTrack);
3492  ADD_COMPARE(customVideoTrackId);
3493  ADD_COMPARE(publishMediaPlayerId);
3494  END_COMPARE();
3495 
3496 #undef BEGIN_COMPARE
3497 #undef ADD_COMPARE
3498 #undef END_COMPARE
3499  return b;
3500  }
3501 
3502  DirectCdnStreamingMediaOptions& operator=(const DirectCdnStreamingMediaOptions& replace) {
3503  if (this != &replace) {
3504 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
3505 
3506  REPLACE_BY(publishCameraTrack);
3507  REPLACE_BY(publishMicrophoneTrack);
3508  REPLACE_BY(publishCustomAudioTrack);
3509  REPLACE_BY(publishCustomVideoTrack);
3510  REPLACE_BY(publishMediaPlayerAudioTrack);
3511  REPLACE_BY(customVideoTrackId);
3512  REPLACE_BY(publishMediaPlayerId);
3513 #undef REPLACE_BY
3514  }
3515  return *this;
3516  }
3517 };
3518 
3522 struct ExtensionInfo {
3526  agora::media::MEDIA_SOURCE_TYPE mediaSourceType;
3527 
3533  uid_t remoteUid;
3534 
3546  const char* channelId;
3547 
3551  uid_t localUid;
3552 
3553  ExtensionInfo() : mediaSourceType(agora::media::UNKNOWN_MEDIA_SOURCE), remoteUid(0), channelId(NULL), localUid(0) {}
3554 };
3555 
3556 class IMediaPlayer;
3557 class IMediaRecorder;
3558 
3565 class IRtcEngine : public agora::base::IEngineBase {
3566  public:
3589  AGORA_CPP_API static void release(bool sync = false);
3590 
3607  virtual int initialize(const RtcEngineContext& context) = 0;
3608 
3618  virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0;
3619 
3620 
3626  virtual const char* getVersion(int* build) = 0;
3627 
3633  virtual const char* getErrorDescription(int code) = 0;
3634 
3644  virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
3645 
3655  virtual int queryDeviceScore() = 0;
3656 
3694  virtual int preloadChannel(const char* token, const char* channelId, uid_t uid) = 0;
3695 
3735  virtual int preloadChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
3736 
3754  virtual int updatePreloadChannelToken(const char* token) = 0;
3755 
3815  virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) = 0;
3816 
3884  virtual int joinChannel(const char* token, const char* channelId, uid_t uid, const ChannelMediaOptions& options) = 0;
3885 
3894  virtual int updateChannelMediaOptions(const ChannelMediaOptions& options) = 0;
3895 
3913  virtual int leaveChannel() = 0;
3914 
3934  virtual int leaveChannel(const LeaveChannelOptions& options) = 0;
3935 
3952  virtual int renewToken(const char* token) = 0;
3953 
3972  virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0;
3973 
3997  virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0;
3998 
4020  virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0;
4021 
4041  virtual int startEchoTest() = 0;
4042 
4059  virtual int startEchoTest(int intervalInSeconds) = 0;
4060 
4069  virtual int startEchoTest(const EchoTestConfiguration& config) = 0;
4070 
4077  virtual int stopEchoTest() = 0;
4078 
4079 #if defined(__APPLE__) && TARGET_OS_IOS
4080 
4089  virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0;
4090 #endif
4091 
4106  virtual int enableVideo() = 0;
4107 
4117  virtual int disableVideo() = 0;
4118 
4130  virtual int startPreview() = 0;
4131 
4139  virtual int startPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
4140 
4148  virtual int stopPreview() = 0;
4149 
4157  virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
4158 
4159 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
4160  virtual bool isPipSupported() = 0;
4161  virtual int setupPip(const PipOptions& options) = 0;
4162  virtual int startPip() = 0;
4163 #if defined(__APPLE__) && TARGET_OS_IOS
4164  virtual int stopPip() = 0;
4165 #endif
4166 #endif
4167 
4201  virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;
4202 
4204  virtual int stopLastmileProbeTest() = 0;
4205 
4222  virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0;
4223 
4233  virtual int setBeautyEffectOptions(bool enabled, const BeautyOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4260  virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4287  virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4314  virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4315 
4348  virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4349 
4372  virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0;
4373 
4390  virtual int setupLocalVideo(const VideoCanvas& canvas) = 0;
4391 
4410  virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType) = 0;
4411 
4430  virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference) = 0;
4431 
4445  virtual int enableAudio() = 0;
4446 
4458  virtual int disableAudio() = 0;
4459 
4481  virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated = 0;
4482 
4498  virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile) = 0;
4507  virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
4530  virtual int enableLocalAudio(bool enabled) = 0;
4531 
4557  virtual int muteLocalAudioStream(bool mute) = 0;
4558 
4600  virtual int muteAllRemoteAudioStreams(bool mute) = 0;
4601 
4623  virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) __deprecated = 0;
4624 
4641  virtual int muteRemoteAudioStream(uid_t uid, bool mute) = 0;
4642 
4654  virtual int muteLocalVideoStream(bool mute) = 0;
4655 
4680  virtual int enableLocalVideo(bool enabled) = 0;
4681 
4721  virtual int muteAllRemoteVideoStreams(bool mute) = 0;
4722 
4744  virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) __deprecated = 0;
4745 
4755  virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType) = 0;
4756 
4773  virtual int muteRemoteVideoStream(uid_t uid, bool mute) = 0;
4774 
4792  virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType) = 0;
4793 
4804  virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options) = 0;
4805 
4820  virtual int setSubscribeAudioBlocklist(uid_t* uidList, int uidNumber) = 0;
4821 
4838  virtual int setSubscribeAudioAllowlist(uid_t* uidList, int uidNumber) = 0;
4839 
4854  virtual int setSubscribeVideoBlocklist(uid_t* uidList, int uidNumber) = 0;
4855 
4872  virtual int setSubscribeVideoAllowlist(uid_t* uidList, int uidNumber) = 0;
4873 
4900  virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad) = 0;
4901 
4922  virtual int startAudioRecording(const char* filePath,
4923  AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
4945  virtual int startAudioRecording(const char* filePath,
4946  int sampleRate,
4947  AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
4948 
4967  virtual int startAudioRecording(const AudioRecordingConfiguration& config) = 0;
4968 
4974  virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig& config, IAudioEncodedFrameObserver *observer) = 0;
4975 
4984  virtual int stopAudioRecording() = 0;
4985 
4996  virtual agora_refptr<IMediaPlayer> createMediaPlayer() = 0;
4997 
5009  virtual int destroyMediaPlayer(agora_refptr<IMediaPlayer> media_player) = 0;
5010 
5021  virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0;
5022 
5032  virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0;
5033 
5075  virtual int startAudioMixing(const char* filePath, bool loopback, int cycle) = 0;
5076 
5120  virtual int startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) = 0;
5121 
5130  virtual int stopAudioMixing() = 0;
5131 
5140  virtual int pauseAudioMixing() = 0;
5141 
5150  virtual int resumeAudioMixing() = 0;
5151 
5160  virtual int selectAudioTrack(int index) = 0;
5169  virtual int getAudioTrackCount() = 0;
5170 
5185  virtual int adjustAudioMixingVolume(int volume) = 0;
5186 
5194  virtual int adjustAudioMixingPublishVolume(int volume) = 0;
5195 
5203  virtual int getAudioMixingPublishVolume() = 0;
5204 
5212  virtual int adjustAudioMixingPlayoutVolume(int volume) = 0;
5213 
5221  virtual int getAudioMixingPlayoutVolume() = 0;
5222 
5231  virtual int getAudioMixingDuration() = 0;
5232 
5242  virtual int getAudioMixingCurrentPosition() = 0;
5243 
5253  virtual int setAudioMixingPosition(int pos /*in ms*/) = 0;
5254 
5265  virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode) = 0;
5266 
5283  virtual int setAudioMixingPitch(int pitch) = 0;
5284 
5300  virtual int setAudioMixingPlaybackSpeed(int speed) = 0;
5301 
5309  virtual int getEffectsVolume() = 0;
5319  virtual int setEffectsVolume(int volume) = 0;
5343  virtual int preloadEffect(int soundId, const char* filePath, int startPos = 0) = 0;
5385  virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false, int startPos = 0) = 0;
5416  virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish = false) = 0;
5417 
5427  virtual int getVolumeOfEffect(int soundId) = 0;
5428 
5439  virtual int setVolumeOfEffect(int soundId, int volume) = 0;
5448  virtual int pauseEffect(int soundId) = 0;
5455  virtual int pauseAllEffects() = 0;
5464  virtual int resumeEffect(int soundId) = 0;
5471  virtual int resumeAllEffects() = 0;
5480  virtual int stopEffect(int soundId) = 0;
5487  virtual int stopAllEffects() = 0;
5496  virtual int unloadEffect(int soundId) = 0;
5503  virtual int unloadAllEffects() = 0;
5522  virtual int getEffectDuration(const char* filePath) = 0;
5539  virtual int setEffectPosition(int soundId, int pos) = 0;
5554  virtual int getEffectCurrentPosition(int soundId) = 0;
5567  virtual int enableSoundPositionIndication(bool enabled) = 0;
5568 
5589  virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0;
5590 
5600  virtual int enableSpatialAudio(bool enabled) = 0;
5601 
5611  virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams& params) = 0;
5612 
5650  virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) = 0;
5651 
5689  virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) = 0;
5690 
5727  virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset) = 0;
5728 
5804  virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0;
5805 
5848  virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset,
5849  int param1, int param2) = 0;
5850 
5863  virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset,
5864  int param1, int param2) = 0;
5865 
5876  virtual int setLocalVoicePitch(double pitch) = 0;
5877 
5888  virtual int setLocalVoiceFormant(double formantRatio) = 0;
5889 
5901  virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0;
5902 
5911  virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0;
5923  virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset) = 0;
5924 
5934  virtual int setHeadphoneEQParameters(int lowGain, int highGain) = 0;
5935 
5951  virtual int setLogFile(const char* filePath) = 0;
5952 
5975  virtual int setLogFilter(unsigned int filter) = 0;
5976 
5993  virtual int setLogLevel(commons::LOG_LEVEL level) = 0;
5994 
6009  virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0;
6010 
6019  virtual int uploadLogFile(agora::util::AString& requestId) = 0;
6020 
6036  virtual int writeLog(commons::LOG_LEVEL level, const char* fmt, ...) = 0;
6037 
6056  virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6057 
6078  virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode,
6079  VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6080 
6081  // The following APIs are either deprecated and going to deleted.
6082 
6100  virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) __deprecated = 0;
6101 
6113  virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated = 0;
6114 
6129  virtual int enableDualStreamMode(bool enabled) __deprecated = 0;
6130 
6147  virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) __deprecated = 0;
6148 
6149 
6163  virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0;
6164 
6180  virtual int setSimulcastConfig(const SimulcastConfig& simulcastConfig) = 0;
6181 
6195  virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig& streamConfig) = 0;
6196 
6211  virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled) = 0;
6212 
6231  virtual int setRecordingAudioFrameParameters(int sampleRate, int channel,
6232  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6233  int samplesPerCall) = 0;
6234 
6254  virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel,
6255  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6256  int samplesPerCall) = 0;
6257 
6273  virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall) = 0;
6274 
6294  virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel,
6295  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6296  int samplesPerCall) = 0;
6297 
6313  virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0;
6314 
6325  virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
6333  virtual int disableAudioSpectrumMonitor() = 0;
6334 
6349  virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
6359  virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
6360 
6374  virtual int adjustRecordingSignalVolume(int volume) = 0;
6375 
6387  virtual int muteRecordingSignal(bool mute) = 0;
6388 
6402  virtual int adjustPlaybackSignalVolume(int volume) = 0;
6403 
6404  /*
6405  * Adjust the playback volume of the user specified by uid.
6406  *
6407  * You can call this method to adjust the playback volume of the user specified by uid
6408  * in call. If you want to adjust playback volume of the multi user, you can call this
6409  * this method multi times.
6410  *
6411  * @note
6412  * Please call this method after join channel.
6413  * This method adjust the playback volume of specified user.
6414  *
6415  * @param uid Remote user ID.
6416  * @param volume The playback volume of the specified remote user. The value ranges between 0 and 400, including the following:
6417  * 0: Mute.
6418  * 100: (Default) Original volume.
6419  * 400: Four times the original volume with signal-clipping protection.
6420  * @return
6421  * - 0: Success.
6422  * - < 0: Failure.
6423  */
6424  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
6425 
6447  virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0;
6448 
6464  virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0;
6465 
6479  virtual int setHighPriorityUserList(uid_t* uidList, int uidNum, STREAM_FALLBACK_OPTIONS option) = 0;
6480 
6501  virtual int enableExtension(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, bool enable = true) = 0;
6502 
6516  virtual int setExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, const char* value) = 0;
6517 
6532  virtual int getExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, char* value, int buf_len) = 0;
6533 
6552  virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0;
6553 
6554 
6567  virtual int adjustLoopbackSignalVolume(int volume) = 0;
6568 
6575  virtual int getLoopbackRecordingVolume() = 0;
6576 
6588  virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0;
6589 
6600  virtual int setInEarMonitoringVolume(int volume) = 0;
6601 
6602 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
6603  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
6604 #endif
6605 
6617  virtual int setExtensionProviderProperty(const char* provider, const char* key, const char* value) = 0;
6618 
6631  virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6632 
6653  virtual int enableExtension(const char* provider, const char* extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6654 
6667  virtual int setExtensionProperty(
6668  const char* provider, const char* extension,
6669  const char* key, const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6670 
6684  virtual int getExtensionProperty(
6685  const char* provider, const char* extension,
6686  const char* key, char* value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6687 
6699  virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0;
6700 
6708  virtual video_track_id_t createCustomVideoTrack() = 0;
6709 
6717  virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions& sender_option) = 0;
6718 
6727  virtual int destroyCustomVideoTrack(video_track_id_t video_track_id) = 0;
6728 
6737  virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id) = 0;
6738 
6739 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
6740 
6748  virtual int switchCamera() = 0;
6749 
6757  virtual bool isCameraZoomSupported() = 0;
6758 
6766  virtual bool isCameraFaceDetectSupported() = 0;
6767 
6775  virtual bool isCameraTorchSupported() = 0;
6776 
6784  virtual bool isCameraFocusSupported() = 0;
6785 
6793  virtual bool isCameraAutoFocusFaceModeSupported() = 0;
6794 
6804  virtual int setCameraZoomFactor(float factor) = 0;
6805 
6814  virtual int enableFaceDetection(bool enabled) = 0;
6815 
6820  virtual float getCameraMaxZoomFactor() = 0;
6821 
6831  virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
6832 
6840  virtual int setCameraTorchOn(bool isOn) = 0;
6841 
6849  virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
6850 
6862  virtual bool isCameraExposurePositionSupported() = 0;
6863 
6879  virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
6880 
6893  virtual bool isCameraExposureSupported() = 0;
6894 
6905  virtual int setCameraExposureFactor(float factor) = 0;
6906 
6907 #if defined(__APPLE__)
6908 
6915  virtual bool isCameraAutoExposureFaceModeSupported() = 0;
6916 
6917 
6925  virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
6926 
6932  virtual int setCameraStabilizationMode(CAMERA_STABILIZATION_MODE mode) = 0;
6933 #endif
6934 
6968  virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0;
6969 
6996  virtual int setEnableSpeakerphone(bool speakerOn) = 0;
6997 
7005  virtual bool isSpeakerphoneEnabled() = 0;
7006 
7013  virtual int setRouteInCommunicationMode(int route) = 0;
7014 
7015 #endif // __ANDROID__ || (__APPLE__ && TARGET_OS_IOS)
7016 
7017 #if defined(__APPLE__)
7018 
7025  virtual bool isCameraCenterStageSupported() = 0;
7026 
7035  virtual int enableCameraCenterStage(bool enabled) = 0;
7036 #endif
7037 
7038 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
7039 
7049  virtual IScreenCaptureSourceList* getScreenCaptureSources(const SIZE& thumbSize, const SIZE& iconSize, const bool includeScreen) = 0;
7050 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7051 #if (defined(__APPLE__) && TARGET_OS_IOS)
7052 
7076  virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0;
7077 #endif // __APPLE__ && TARGET_OS_IOS
7078 
7079 #if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7080 
7101  virtual int startScreenCaptureByDisplayId(uint32_t displayId, const Rectangle& regionRect,
7102  const ScreenCaptureParameters& captureParams) = 0;
7103 
7104 #endif // __APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE
7105 
7106 #if defined(_WIN32)
7107 
7130  virtual int startScreenCaptureByScreenRect(const Rectangle& screenRect,
7131  const Rectangle& regionRect,
7132  const ScreenCaptureParameters& captureParams) __deprecated = 0;
7133 #endif
7134 
7135 #if defined(__ANDROID__)
7136 
7142  virtual int getAudioDeviceInfo(DeviceInfo& deviceInfo) = 0;
7143 #endif // __ANDROID__
7144 
7145 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
7146 
7164  virtual int startScreenCaptureByWindowId(view_t windowId, const Rectangle& regionRect,
7165  const ScreenCaptureParameters& captureParams) = 0;
7166 
7182  virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint) = 0;
7183 
7200  virtual int updateScreenCaptureRegion(const Rectangle& regionRect) = 0;
7201 
7215  virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0;
7216 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7217 
7218 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
7219 
7228  virtual int startScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
7229 
7239  virtual int updateScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
7240 
7252  virtual int queryScreenCaptureCapability() = 0;
7253 
7265  virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo* focalLengthInfos, int& size) = 0;
7266 
7267 #if defined(__ANDROID__)
7268 
7283  virtual int setExternalMediaProjection(void* mediaProjection) = 0;
7284 #endif
7285 #endif
7286 
7287 #if defined(_WIN32) || defined(__APPLE__) || defined(__ANDROID__)
7288 
7304  virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
7305 
7313  virtual int stopScreenCapture() = 0;
7314 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC) || __ANDROID__
7315 
7332  virtual int getCallId(agora::util::AString& callId) = 0;
7333 
7348  virtual int rate(const char* callId, int rating, const char* description) = 0; // 0~10
7349 
7363  virtual int complain(const char* callId, const char* description) = 0;
7364 
7385  virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0;
7386 
7408  virtual int startRtmpStreamWithTranscoding(const char* url, const LiveTranscoding& transcoding) = 0;
7409 
7419  virtual int updateRtmpTranscoding(const LiveTranscoding& transcoding) = 0;
7420 
7421  virtual int startLocalVideoTranscoder(const LocalTranscoderConfiguration& config) = 0;
7422  virtual int updateLocalTranscoderConfiguration(const LocalTranscoderConfiguration& config) = 0;
7423 
7442  virtual int stopRtmpStream(const char* url) = 0;
7443 
7444  virtual int stopLocalVideoTranscoder() = 0;
7454  virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration& config) = 0;
7455 
7466  virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
7478  virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
7490  virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
7491 
7501  virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration& config) = 0;
7502 
7513  virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
7514 
7519  virtual CONNECTION_STATE_TYPE getConnectionState() = 0;
7520 
7521  // The following APIs are not implemented yet.
7522  virtual bool registerEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
7523  virtual bool unregisterEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
7524  virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0;
7525 
7537  virtual int registerPacketObserver(IPacketObserver* observer) = 0;
7538 
7561  virtual int setEncryptionMode(const char* encryptionMode) __deprecated = 0;
7562 
7579  virtual int setEncryptionSecret(const char* secret) __deprecated = 0;
7580 
7602  virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;
7603 
7635  virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
7636 
7646  virtual int createDataStream(int* streamId, const DataStreamConfig& config) = 0;
7647 
7678  virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
7679 
7701  virtual int addVideoWatermark(const RtcImage& watermark) __deprecated = 0;
7702 
7728  virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0;
7729 
7737  virtual int clearVideoWatermarks() = 0;
7738 
7739  // The following APIs are either deprecated and going to deleted.
7740 
7749  virtual int pauseAudio() __deprecated = 0;
7758  virtual int resumeAudio() __deprecated = 0;
7759 
7777  virtual int enableWebSdkInteroperability(bool enabled) __deprecated = 0;
7778 
7788  virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0;
7789 
7811  virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0;
7812 
7821  virtual int unregisterMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0;
7822 
7831  virtual int startAudioFrameDump(const char* channel_id, uid_t uid, const char* location, const char* uuid, const char* passwd, long duration_ms, bool auto_upload) = 0;
7832 
7836  virtual int stopAudioFrameDump(const char* channel_id, uid_t uid, const char* location) = 0;
7837 
7853  virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode) = 0;
7854 
7886  virtual int registerLocalUserAccount(const char* appId, const char* userAccount) = 0;
7887 
7918  virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
7919 
7951  virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount, const ChannelMediaOptions& options) = 0;
7952 
7985  virtual int joinChannelWithUserAccountEx(const char* token, const char* channelId,
7986  const char* userAccount, const ChannelMediaOptions& options,
7987  IRtcEngineEventHandler* eventHandler) = 0;
7988 
8006  virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo) = 0;
8007 
8025  virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo) = 0;
8026 
8061  virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0;
8062 
8091  virtual int stopChannelMediaRelay() = 0;
8092 
8102  virtual int pauseAllChannelMediaRelay() = 0;
8103 
8113  virtual int resumeAllChannelMediaRelay() = 0;
8114 
8127  virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile) = 0;
8128 
8143  virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration& config) = 0;
8144 
8158  virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler* eventHandler,
8159  const char* publishUrl, const DirectCdnStreamingMediaOptions& options) = 0;
8160 
8170  virtual int stopDirectCdnStreaming() = 0;
8171 
8183  virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions& options) = 0;
8184 
8195  virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
8196 
8203  virtual int stopRhythmPlayer() = 0;
8204 
8213  virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig& config) = 0;
8214 
8244  virtual int takeSnapshot(uid_t uid, const char* filePath) = 0;
8245 
8270  virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) = 0;
8271 
8281  virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0;
8282  /*
8283  * Adjust the custom audio publish volume by track id.
8284  * @param trackId custom audio track id.
8285  * @param volume The volume, range is [0,100]:
8286  * 0: mute, 100: The original volume
8287  * @return
8288  * - 0: Success.
8289  * - < 0: Failure.
8290  */
8291  virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume) = 0;
8292 
8293  /*
8294  * Adjust the custom audio playout volume by track id.
8295  * @param trackId custom audio track id.
8296  * @param volume The volume, range is [0,100]:
8297  * 0: mute, 100: The original volume
8298  * @return
8299  * - 0: Success.
8300  * - < 0: Failure.
8301  */
8302  virtual int adjustCustomAudioPlayoutVolume(track_id_t trackId, int volume) = 0;
8303 
8333  virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0;
8342  virtual int setLocalAccessPoint(const LocalAccessPointConfiguration& config) = 0;
8343 
8351  virtual int setAdvancedAudioOptions(AdvancedAudioOptions& options, int sourceType = 0) = 0;
8352 
8363  virtual int setAVSyncSource(const char* channelId, uid_t uid) = 0;
8364 
8371  virtual int enableVideoImageSource(bool enable, const ImageTrackOptions& options) = 0;
8372 
8373  /*
8374  * Get monotonic time in ms which can be used by capture time,
8375  * typical scenario is as follows:
8376  *
8377  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8378  * | // custom audio/video base capture time, e.g. the first audio/video capture time. |
8379  * | int64_t custom_capture_time_base; |
8380  * | |
8381  * | int64_t agora_monotonic_time = getCurrentMonotonicTimeInMs(); |
8382  * | |
8383  * | // offset is fixed once calculated in the begining. |
8384  * | const int64_t offset = agora_monotonic_time - custom_capture_time_base; |
8385  * | |
8386  * | // realtime_custom_audio/video_capture_time is the origin capture time that customer provided.|
8387  * | // actual_audio/video_capture_time is the actual capture time transfered to sdk. |
8388  * | int64_t actual_audio_capture_time = realtime_custom_audio_capture_time + offset; |
8389  * | int64_t actual_video_capture_time = realtime_custom_video_capture_time + offset; |
8390  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8391  *
8392  * @return
8393  * - >= 0: Success.
8394  * - < 0: Failure.
8395  */
8396  virtual int64_t getCurrentMonotonicTimeInMs() = 0;
8397 
8413  virtual int enableWirelessAccelerate(bool enabled) = 0;
8414 
8429  virtual int getNetworkType() = 0;
8430 
8439  virtual int setParameters(const char* parameters) = 0;
8440 
8455  virtual int startMediaRenderingTracing() = 0;
8456 
8470  virtual int enableInstantMediaRendering() = 0;
8471 
8475  virtual uint64_t getNtpWallTimeInMs() = 0;
8476 
8485  virtual bool isFeatureAvailableOnDevice(FeatureType type) = 0;
8486 
8497  virtual int sendAudioMetadata(const char* metadata, size_t length) = 0;
8498 };
8499 
8500 // The following types are either deprecated or not implmented yet.
8501 enum QUALITY_REPORT_FORMAT_TYPE {
8504  QUALITY_REPORT_JSON = 0,
8507  QUALITY_REPORT_HTML = 1,
8508 };
8509 
8511 enum MEDIA_DEVICE_STATE_TYPE {
8514  MEDIA_DEVICE_STATE_IDLE = 0,
8517  MEDIA_DEVICE_STATE_ACTIVE = 1,
8520  MEDIA_DEVICE_STATE_DISABLED = 2,
8523  MEDIA_DEVICE_STATE_PLUGGED_IN = 3,
8526  MEDIA_DEVICE_STATE_NOT_PRESENT = 4,
8529  MEDIA_DEVICE_STATE_UNPLUGGED = 8
8530 };
8531 
8532 enum VIDEO_PROFILE_TYPE { // res fps
8534  VIDEO_PROFILE_LANDSCAPE_120P = 0, // 160x120 15
8536  VIDEO_PROFILE_LANDSCAPE_120P_3 = 2, // 120x120 15
8538  VIDEO_PROFILE_LANDSCAPE_180P = 10, // 320x180 15
8540  VIDEO_PROFILE_LANDSCAPE_180P_3 = 12, // 180x180 15
8542  VIDEO_PROFILE_LANDSCAPE_180P_4 = 13, // 240x180 15
8544  VIDEO_PROFILE_LANDSCAPE_240P = 20, // 320x240 15
8546  VIDEO_PROFILE_LANDSCAPE_240P_3 = 22, // 240x240 15
8548  VIDEO_PROFILE_LANDSCAPE_240P_4 = 23, // 424x240 15
8550  VIDEO_PROFILE_LANDSCAPE_360P = 30, // 640x360 15
8552  VIDEO_PROFILE_LANDSCAPE_360P_3 = 32, // 360x360 15
8554  VIDEO_PROFILE_LANDSCAPE_360P_4 = 33, // 640x360 30
8556  VIDEO_PROFILE_LANDSCAPE_360P_6 = 35, // 360x360 30
8558  VIDEO_PROFILE_LANDSCAPE_360P_7 = 36, // 480x360 15
8560  VIDEO_PROFILE_LANDSCAPE_360P_8 = 37, // 480x360 30
8562  VIDEO_PROFILE_LANDSCAPE_360P_9 = 38, // 640x360 15
8564  VIDEO_PROFILE_LANDSCAPE_360P_10 = 39, // 640x360 24
8566  VIDEO_PROFILE_LANDSCAPE_360P_11 = 100, // 640x360 24
8568  VIDEO_PROFILE_LANDSCAPE_480P = 40, // 640x480 15
8570  VIDEO_PROFILE_LANDSCAPE_480P_3 = 42, // 480x480 15
8572  VIDEO_PROFILE_LANDSCAPE_480P_4 = 43, // 640x480 30
8574  VIDEO_PROFILE_LANDSCAPE_480P_6 = 45, // 480x480 30
8576  VIDEO_PROFILE_LANDSCAPE_480P_8 = 47, // 848x480 15
8578  VIDEO_PROFILE_LANDSCAPE_480P_9 = 48, // 848x480 30
8580  VIDEO_PROFILE_LANDSCAPE_480P_10 = 49, // 640x480 10
8582  VIDEO_PROFILE_LANDSCAPE_720P = 50, // 1280x720 15
8584  VIDEO_PROFILE_LANDSCAPE_720P_3 = 52, // 1280x720 30
8586  VIDEO_PROFILE_LANDSCAPE_720P_5 = 54, // 960x720 15
8588  VIDEO_PROFILE_LANDSCAPE_720P_6 = 55, // 960x720 30
8590  VIDEO_PROFILE_LANDSCAPE_1080P = 60, // 1920x1080 15
8592  VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62, // 1920x1080 30
8594  VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64, // 1920x1080 60
8596  VIDEO_PROFILE_LANDSCAPE_1440P = 66, // 2560x1440 30
8598  VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67, // 2560x1440 60
8600  VIDEO_PROFILE_LANDSCAPE_4K = 70, // 3840x2160 30
8602  VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, // 3840x2160 60
8604  VIDEO_PROFILE_PORTRAIT_120P = 1000, // 120x160 15
8606  VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, // 120x120 15
8608  VIDEO_PROFILE_PORTRAIT_180P = 1010, // 180x320 15
8610  VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, // 180x180 15
8612  VIDEO_PROFILE_PORTRAIT_180P_4 = 1013, // 180x240 15
8614  VIDEO_PROFILE_PORTRAIT_240P = 1020, // 240x320 15
8616  VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, // 240x240 15
8618  VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, // 240x424 15
8620  VIDEO_PROFILE_PORTRAIT_360P = 1030, // 360x640 15
8622  VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, // 360x360 15
8624  VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, // 360x640 30
8626  VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, // 360x360 30
8628  VIDEO_PROFILE_PORTRAIT_360P_7 = 1036, // 360x480 15
8630  VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, // 360x480 30
8632  VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, // 360x640 15
8634  VIDEO_PROFILE_PORTRAIT_360P_10 = 1039, // 360x640 24
8636  VIDEO_PROFILE_PORTRAIT_360P_11 = 1100, // 360x640 24
8638  VIDEO_PROFILE_PORTRAIT_480P = 1040, // 480x640 15
8640  VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, // 480x480 15
8642  VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, // 480x640 30
8644  VIDEO_PROFILE_PORTRAIT_480P_6 = 1045, // 480x480 30
8646  VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, // 480x848 15
8648  VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, // 480x848 30
8650  VIDEO_PROFILE_PORTRAIT_480P_10 = 1049, // 480x640 10
8652  VIDEO_PROFILE_PORTRAIT_720P = 1050, // 720x1280 15
8654  VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, // 720x1280 30
8656  VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, // 720x960 15
8658  VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, // 720x960 30
8660  VIDEO_PROFILE_PORTRAIT_1080P = 1060, // 1080x1920 15
8662  VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, // 1080x1920 30
8664  VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, // 1080x1920 60
8666  VIDEO_PROFILE_PORTRAIT_1440P = 1066, // 1440x2560 30
8668  VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067, // 1440x2560 60
8670  VIDEO_PROFILE_PORTRAIT_4K = 1070, // 2160x3840 30
8672  VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, // 2160x3840 60
8674  VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P,
8675 };
8676 
8677 class AAudioDeviceManager : public agora::util::AutoPtr<IAudioDeviceManager> {
8678  public:
8679  AAudioDeviceManager(IRtcEngine* engine) {
8680  queryInterface(engine, AGORA_IID_AUDIO_DEVICE_MANAGER);
8681  }
8682 };
8683 
8684 class AVideoDeviceManager : public agora::util::AutoPtr<IVideoDeviceManager> {
8685  public:
8686  AVideoDeviceManager(IRtcEngine* engine) {
8687  queryInterface(engine, AGORA_IID_VIDEO_DEVICE_MANAGER);
8688  }
8689 };
8690 
8691 } // namespace rtc
8692 } // namespace agora
8693 
8699 #define getAgoraRtcEngineVersion getAgoraSdkVersion
8700 
8702 
8705 
8711 AGORA_API agora::rtc::IRtcEngine* AGORA_CALL createAgoraRtcEngine();
8712 
8714 
8715 
8722 #define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
8723 #define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader
agora::rtc::IRtcEngine::setDirectCdnStreamingAudioConfiguration
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile)=0
agora::rtc::IRtcEngine::getErrorDescription
virtual const char * getErrorDescription(int code)=0
agora::rtc::IRtcEngine::enableAudioSpectrumMonitor
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
agora::rtc::IRtcEngine::setSubscribeVideoAllowlist
virtual int setSubscribeVideoAllowlist(uid_t *uidList, int uidNumber)=0
agora::rtc::ScreenCaptureConfiguration::windowId
view_t windowId
Definition: IAgoraRtcEngine.h:881
agora::rtc::IRtcEngine::adjustRecordingSignalVolume
virtual int adjustRecordingSignalVolume(int volume)=0
agora::rtc::IRtcEngine::enableWebSdkInteroperability
virtual int enableWebSdkInteroperability(bool enabled) __deprecated=0
agora::rtc::IRtcEngine::enableSpatialAudio
virtual int enableSpatialAudio(bool enabled)=0
agora::rtc::ChannelMediaOptions::publishMediaPlayerAudioTrack
Optional< bool > publishMediaPlayerAudioTrack
Definition: IAgoraRtcEngine.h:1171
agora::rtc::PublisherConfiguration::extraInfo
const char * extraInfo
Definition: IAgoraRtcEngine.h:778
agora::rtc::IRtcEngine::setAVSyncSource
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
agora::VideoLayout
Definition: AgoraBase.h:6353
agora::rtc::RtcEngineContext::appId
const char * appId
Definition: IAgoraRtcEngine.h:3162
agora::rtc::IRtcEngine::setSubscribeAudioBlocklist
virtual int setSubscribeAudioBlocklist(uid_t *uidList, int uidNumber)=0
agora::rtc::IRtcEngineEventHandler::onUserAccountUpdated
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2784
agora::rtc::IRtcEngine::enableInEarMonitoring
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters)=0
agora::rtc::IRtcEngineEventHandler::onRtmpStreamingEvent
virtual void onRtmpStreamingEvent(const char *url, RTMP_STREAMING_EVENT eventCode)
Definition: IAgoraRtcEngine.h:2518
agora::rtc::LocalVideoStats::regulatedCaptureFrameHeight
int regulatedCaptureFrameHeight
Definition: IAgoraRtcEngine.h:308
agora::rtc::IRtcEngine::setEffectPosition
virtual int setEffectPosition(int soundId, int pos)=0
agora::rtc::UserInfo
Definition: AgoraBase.h:5937
agora::rtc::RemoteVideoStats::publishDuration
int publishDuration
Definition: IAgoraRtcEngine.h:575
agora::rtc::IRtcEngine::stopDirectCdnStreaming
virtual int stopDirectCdnStreaming()=0
agora::rtc::LastmileProbeResult
Definition: AgoraBase.h:4155
agora::rtc::IRtcEngine::setEncryptionSecret
virtual int setEncryptionSecret(const char *secret) __deprecated=0
agora::rtc::AudioEncodedFrameObserverConfig
Definition: AgoraBase.h:5331
agora::rtc::ScreenCaptureParameters
Definition: AgoraBase.h:5114
agora::rtc::IRtcEngine::muteAllRemoteVideoStreams
virtual int muteAllRemoteVideoStreams(bool mute)=0
agora::rtc::IRtcEngine::setRemoteVideoSubscriptionOptions
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options)=0
agora::rtc::AudioVolumeInfo
Definition: AgoraBase.h:3298
agora::rtc::RemoteVideoStats::e2eDelay
int e2eDelay
Definition: IAgoraRtcEngine.h:520
agora::rtc::InjectStreamConfig::audioChannels
int audioChannels
Definition: IAgoraRtcEngine.h:700
agora::rtc::LocalVideoStats::regulatedCaptureFrameWidth
int regulatedCaptureFrameWidth
Definition: IAgoraRtcEngine.h:304
agora::rtc::IRtcEngine::pauseEffect
virtual int pauseEffect(int soundId)=0
agora::rtc::BeautyOptions
Definition: AgoraBase.h:4532
agora::rtc::ChannelMediaOptions::publishSecondaryCameraTrack
Optional< bool > publishSecondaryCameraTrack
Definition: IAgoraRtcEngine.h:1084
agora::rtc::SenderOptions
Definition: AgoraBase.h:1228
agora::rtc::IRtcEngine::muteLocalVideoStream
virtual int muteLocalVideoStream(bool mute)=0
agora::rtc::RtcEngineContext::eventHandler
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:3155
agora::rtc::IRtcEngine::stopPreview
virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType)=0
agora::rtc::IRtcEngine::startScreenCapture
virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration &config)=0
agora::rtc::IRtcEngineEventHandler::onIntraRequestReceived
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1758
agora::rtc::VideoCompositingLayout
Definition: IAgoraRtcEngine.h:590
agora::rtc::VideoCompositingLayout::canvasHeight
int canvasHeight
Definition: IAgoraRtcEngine.h:639
agora::rtc::IRtcEngine::setVoiceConversionPreset
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
agora::rtc::DirectCdnStreamingStats::videoHeight
int videoHeight
Definition: IAgoraRtcEngine.h:3378
agora::rtc::LastmileProbeConfig
Definition: AgoraBase.h:4087
agora::rtc::IRtcEngine::enableLocalVideo
virtual int enableLocalVideo(bool enabled)=0
agora::rtc::IRtcEngineEventHandler::onLeaveChannel
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1648
agora::rtc::IRtcEngine::joinChannel
virtual int joinChannel(const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
agora::rtc::IRtcEngineEventHandler::onRhythmPlayerStateChanged
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
Definition: IAgoraRtcEngine.h:2213
agora::rtc::IDirectCdnStreamingEventHandler::onDirectCdnStreamingStateChanged
virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char *message)
Definition: IAgoraRtcEngine.h:3410
agora::rtc::IRtcEngine::getAudioTrackCount
virtual int getAudioTrackCount()=0
agora::rtc::IRtcEngineEventHandler::onStreamMessage
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:2257
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:1847
agora::rtc::LocalVideoStats::uid
uid_t uid
Definition: IAgoraRtcEngine.h:279
agora::rtc::IRtcEngine::stopChannelMediaRelay
virtual int stopChannelMediaRelay()=0
agora::rtc::IRtcEngineEventHandler::onAudioEffectFinished
virtual void onAudioEffectFinished(int soundId)
Definition: IAgoraRtcEngine.h:1701
agora::rtc::RtcEngineContext::threadPriority
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraRtcEngine.h:3217
agora::rtc::IRtcEngine::registerAudioEncodedFrameObserver
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
agora::rtc::RemoteAudioStats::frozenTimeByCustom
uint32_t frozenTimeByCustom
Definition: IAgoraRtcEngine.h:449
agora::rtc::ChannelMediaOptions::enableBuiltInMediaEncryption
Optional< bool > enableBuiltInMediaEncryption
Definition: IAgoraRtcEngine.h:1263
agora::rtc::IRtcEngine::resumeAllEffects
virtual int resumeAllEffects()=0
agora::rtc::IRtcEngine::joinChannelWithUserAccountEx
virtual int joinChannelWithUserAccountEx(const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
agora::rtc::InjectStreamConfig::width
int width
Definition: IAgoraRtcEngine.h:673
agora::rtc::IRtcEngine::pauseAudioMixing
virtual int pauseAudioMixing()=0
agora::rtc::IRtcEngine::setPlaybackAudioFrameBeforeMixingParameters
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel)=0
agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2639
agora::rtc::RemoteAudioStats::totalActiveTime
int totalActiveTime
Definition: IAgoraRtcEngine.h:455
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2362
agora::rtc::PipOptions
Definition: AgoraBase.h:4519
agora::rtc::IVideoDeviceCollection::release
virtual void release()=0
agora::rtc::IVideoDeviceManager::enumerateVideoDevices
virtual IVideoDeviceCollection * enumerateVideoDevices()=0
agora::rtc::LeaveChannelOptions::stopAudioMixing
bool stopAudioMixing
Definition: IAgoraRtcEngine.h:1487
agora::rtc::IRtcEngine::getVersion
virtual const char * getVersion(int *build)=0
agora::rtc::RemoteVideoStats::totalActiveTime
int totalActiveTime
Definition: IAgoraRtcEngine.h:571
agora::rtc::IRtcEngine::setAudioMixingPitch
virtual int setAudioMixingPitch(int pitch)=0
agora::rtc::ChannelMediaOptions::publishRhythmPlayerTrack
Optional< bool > publishRhythmPlayerTrack
Definition: IAgoraRtcEngine.h:1269
agora::rtc::ChannelMediaOptions::publishCustomVideoTrack
Optional< bool > publishCustomVideoTrack
Definition: IAgoraRtcEngine.h:1159
agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:1895
agora::media::IAudioSpectrumObserver
Definition: AgoraMediaBase.h:1285
agora::rtc::DirectCdnStreamingStats::videoWidth
int videoWidth
Definition: IAgoraRtcEngine.h:3373
agora::rtc::IMetadataObserver::Metadata::buffer
unsigned char * buffer
Definition: IAgoraRtcEngine.h:3291
agora::rtc::PublisherConfiguration::publishUrl
const char * publishUrl
Definition: IAgoraRtcEngine.h:771
agora::rtc::ExtensionInfo
Definition: IAgoraRtcEngine.h:3522
agora::rtc::IRtcEngineEventHandler::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2796
agora::rtc::ExtensionInfo::remoteUid
uid_t remoteUid
Definition: IAgoraRtcEngine.h:3533
agora::rtc::PublisherConfiguration::lifecycle
int lifecycle
Definition: IAgoraRtcEngine.h:753
agora::rtc::IRtcEngine::startPreview
virtual int startPreview()=0
agora::rtc::IMetadataObserver::Metadata::timeStampMs
long long timeStampMs
Definition: IAgoraRtcEngine.h:3295
agora::rtc::IRtcEngineEventHandler::onLocalAudioStats
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:2072
agora::rtc::IRtcEngine::setAINSMode
virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode)=0
agora::rtc::ChannelMediaOptions::autoSubscribeAudio
Optional< bool > autoSubscribeAudio
Definition: IAgoraRtcEngine.h:1201
agora::rtc::IRtcEngineEventHandler::onCameraExposureAreaChanged
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2137
agora::rtc::LocalAccessPointConfiguration
Definition: AgoraBase.h:6230
agora::rtc::IRtcEngineEventHandler::onClientRoleChangeFailed
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2477
agora::rtc::IVideoDeviceCollection::getDevice
virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
agora::rtc::DirectCdnStreamingStats::videoBitrate
int videoBitrate
Definition: IAgoraRtcEngine.h:3388
agora::rtc::IRtcEngineEventHandler::onLastmileQuality
virtual void onLastmileQuality(int quality)
Definition: IAgoraRtcEngine.h:1797
agora::rtc::IRtcEngine::enableInstantMediaRendering
virtual int enableInstantMediaRendering()=0
Enable instant media rendering.
agora::rtc::IRtcEngine::setRemoteRenderMode
virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
agora::rtc::ChannelMediaOptions::isAudioFilterable
Optional< bool > isAudioFilterable
Definition: IAgoraRtcEngine.h:1288
agora::rtc::LiveTranscoding
Definition: AgoraBase.h:3830
agora::rtc::ChannelMediaOptions::audienceLatencyLevel
Optional< AUDIENCE_LATENCY_LEVEL_TYPE > audienceLatencyLevel
Definition: IAgoraRtcEngine.h:1226
agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2663
agora::rtc::LocalVideoStats::sentFrameRate
int sentFrameRate
Definition: IAgoraRtcEngine.h:287
agora::rtc::Rectangle
Definition: AgoraBase.h:2145
agora::rtc::IRtcEngine::setDirectCdnStreamingVideoConfiguration
virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration &config)=0
agora::rtc::IRtcEngine::createDataStream
virtual int createDataStream(int *streamId, bool reliable, bool ordered)=0
agora::rtc::IVideoDeviceManager::release
virtual void release()=0
agora::rtc::IRtcEngine::setVolumeOfEffect
virtual int setVolumeOfEffect(int soundId, int volume)=0
agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Definition: IAgoraRtcEngine.h:2773
agora::rtc::IRtcEngineEventHandler::onNetworkTypeChanged
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2715
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2350
agora::rtc::InjectStreamConfig::videoFramerate
int videoFramerate
Definition: IAgoraRtcEngine.h:685
agora::rtc::IRtcEngine::setDualStreamMode
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
agora::rtc::IRtcEngine::stopAudioFrameDump
virtual int stopAudioFrameDump(const char *channel_id, uid_t uid, const char *location)=0
agora::rtc::IRtcEngine::enableAudioVolumeIndication
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad)=0
agora::rtc::ChannelMediaOptions::mediaPlayerAudioDelayMs
Optional< int > mediaPlayerAudioDelayMs
Definition: IAgoraRtcEngine.h:1246
agora::rtc::IMetadataObserver::onReadyToSendMetadata
virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type)=0
agora::rtc::IRtcEngine::registerPacketObserver
virtual int registerPacketObserver(IPacketObserver *observer)=0
agora::rtc::RemoteAudioStats::networkTransportDelay
int networkTransportDelay
Definition: IAgoraRtcEngine.h:378
agora::rtc::IRtcEngine::unregisterMediaMetadataObserver
virtual int unregisterMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
agora::rtc::IRtcEngineEventHandler::onLocalVideoTranscoderError
virtual void onLocalVideoTranscoderError(const TranscodingVideoStream &stream, VIDEO_TRANSCODER_ERROR error)
Definition: IAgoraRtcEngine.h:2808
agora::rtc::IRtcEngine::getUserInfoByUid
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
agora::rtc::IRtcEngine::pauseAllEffects
virtual int pauseAllEffects()=0
agora::rtc::IRtcEngine::disableAudioSpectrumMonitor
virtual int disableAudioSpectrumMonitor()=0
agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2330
agora::util::AutoPtr
Definition: AgoraBase.h:94
agora::rtc::LocalVideoStats::sentBitrate
int sentBitrate
Definition: IAgoraRtcEngine.h:283
agora::rtc::IRtcEngineEventHandler::onExtensionStopped
virtual void onExtensionStopped(const char *provider, const char *extension)
Definition: IAgoraRtcEngine.h:2960
agora::rtc::IRtcEngine::getAudioMixingPublishVolume
virtual int getAudioMixingPublishVolume()=0
agora::rtc::IRtcEngine::addVideoWatermark
virtual int addVideoWatermark(const char *watermarkUrl, const WatermarkOptions &options)=0
agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1545
agora::rtc::RemoteVideoStats::totalFrozenTime
int totalFrozenTime
Definition: IAgoraRtcEngine.h:557
agora::rtc::IMetadataObserver::METADATA_TYPE
METADATA_TYPE
Definition: IAgoraRtcEngine.h:3259
agora::rtc::IRtcEngine::setCloudProxy
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0
agora::rtc::RemoteAudioStats::receivedBitrate
int receivedBitrate
Definition: IAgoraRtcEngine.h:401
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1849
agora::rtc::IRtcEngineEventHandler
Definition: IAgoraRtcEngine.h:1514
agora::rtc::VideoCompositingLayout::Region::height
double height
Definition: IAgoraRtcEngine.h:606
agora::rtc::IRtcEngine::leaveChannel
virtual int leaveChannel(const LeaveChannelOptions &options)=0
agora::rtc::IVideoDeviceManager::getDevice
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
agora::rtc::IRtcEngine::startAudioMixing
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle, int startPos)=0
agora::rtc::IRtcEngineEventHandler::onUserMuteAudio
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1988
agora::rtc::ChannelMediaOptions::publishCustomAudioTrackId
Optional< int > publishCustomAudioTrackId
Definition: IAgoraRtcEngine.h:1153
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1580
agora::rtc::IRtcEngine::registerLocalUserAccount
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
agora::rtc::IRtcEngineEventHandler::onUplinkNetworkInfoUpdated
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1770
agora::rtc::DirectCdnStreamingMediaOptions::publishMicrophoneTrack
Optional< bool > publishMicrophoneTrack
Definition: IAgoraRtcEngine.h:3436
agora::rtc::EchoTestConfiguration
Definition: AgoraBase.h:5919
agora::rtc::RtcImage
Definition: AgoraBase.h:3651
agora::rtc::VideoCompositingLayout::backgroundColor
const char * backgroundColor
Definition: IAgoraRtcEngine.h:642
agora::rtc::IRtcEngine::getAudioMixingCurrentPosition
virtual int getAudioMixingCurrentPosition()=0
agora::rtc::IRtcEngine::startDirectCdnStreaming
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
agora::rtc::IRtcEngine::registerAudioSpectrumObserver
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
agora::rtc::LocalVideoStats::encodedBitrate
int encodedBitrate
Definition: IAgoraRtcEngine.h:334
agora::rtc::IRtcEngine::startEchoTest
virtual int startEchoTest(int intervalInSeconds)=0
agora::rtc::LocalVideoStats::qualityAdaptIndication
QUALITY_ADAPT_INDICATION qualityAdaptIndication
Definition: IAgoraRtcEngine.h:330
agora::rtc::IRtcEngine::enableDualStreamMode
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig &streamConfig) __deprecated=0
agora::rtc::ChannelMediaOptions::customVideoTrackId
Optional< video_track_id_t > customVideoTrackId
Definition: IAgoraRtcEngine.h:1282
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2059
agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted
virtual void onConnectionInterrupted() __deprecated
Definition: IAgoraRtcEngine.h:2239
agora::rtc::IRtcEngine::setMixedAudioFrameParameters
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall)=0
agora::rtc::IRtcEngine::getVolumeOfEffect
virtual int getVolumeOfEffect(int soundId)=0
agora::rtc::IMetadataObserver::getMaxMetadataSize
virtual int getMaxMetadataSize()
Definition: IAgoraRtcEngine.h:3310
agora::rtc::IRtcEngine::setSubscribeAudioAllowlist
virtual int setSubscribeAudioAllowlist(uid_t *uidList, int uidNumber)=0
agora::rtc::IRtcEngine::getConnectionState
virtual CONNECTION_STATE_TYPE getConnectionState()=0
agora::rtc::ExtensionInfo::channelId
const char * channelId
Definition: IAgoraRtcEngine.h:3546
agora::rtc::IRtcEngine::isFeatureAvailableOnDevice
virtual bool isFeatureAvailableOnDevice(FeatureType type)=0
Whether the target feature is available for the device.
agora::rtc::IRtcEngine::setExtensionProperty
virtual int setExtensionProperty(const char *provider, const char *extension, const char *key, const char *value, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
agora::rtc::IRtcEngine::enableEncryption
virtual int enableEncryption(bool enabled, const EncryptionConfig &config)=0
agora::rtc::IRtcEngine::enableContentInspect
virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config)=0
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2402
agora::rtc::IRtcEngine::startRhythmPlayer
virtual int startRhythmPlayer(const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
agora::rtc::IRtcEngine::configRhythmPlayer
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig &config)=0
agora::rtc::IRtcEngine::adjustAudioMixingPublishVolume
virtual int adjustAudioMixingPublishVolume(int volume)=0
agora::rtc::DirectCdnStreamingMediaOptions::publishCameraTrack
Optional< bool > publishCameraTrack
Definition: IAgoraRtcEngine.h:3430
agora::rtc::IVideoDeviceCollection::getCount
virtual int getCount()=0
agora::rtc::IRtcEngine::getAudioMixingDuration
virtual int getAudioMixingDuration()=0
agora::rtc::IRtcEngine::destroyMediaRecorder
virtual int destroyMediaRecorder(agora_refptr< IMediaRecorder > mediaRecorder)=0
agora::rtc::RemoteAudioStats::frozenRateByCustomPlcCount
uint32_t frozenRateByCustomPlcCount
Definition: IAgoraRtcEngine.h:435
agora::rtc::ScreenCaptureConfiguration::params
ScreenCaptureParameters params
Definition: IAgoraRtcEngine.h:885
agora::rtc::IRtcEngineEventHandler::onVideoDeviceStateChanged
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1712
agora::rtc::IMetadataObserver
Definition: IAgoraRtcEngine.h:3250
agora::rtc::VideoCompositingLayout::appData
const char * appData
Definition: IAgoraRtcEngine.h:652
agora::rtc::RemoteAudioStats::totalFrozenTime
int totalFrozenTime
Definition: IAgoraRtcEngine.h:408
agora::rtc::IRtcEngineEventHandler::onAudioMixingPositionChanged
virtual void onAudioMixingPositionChanged(int64_t position)
Reports current AudioMixing progress.
Definition: IAgoraRtcEngine.h:1684
agora::rtc::IRtcEngine::setRemoteVoicePosition
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain)=0
agora::rtc::IRtcEngine::registerMediaMetadataObserver
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
agora::rtc::ColorEnhanceOptions
Definition: AgoraBase.h:4656
agora::rtc::PublisherConfiguration::defaultLayout
int defaultLayout
Definition: IAgoraRtcEngine.h:750
agora::rtc::IRtcEngineEventHandler::onTranscodingUpdated
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:2533
agora::rtc::IRtcEngine::updateRtmpTranscoding
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
agora::rtc::RemoteAudioStats::publishDuration
int publishDuration
Definition: IAgoraRtcEngine.h:459
agora::rtc::IRtcEngineEventHandler::onWlAccMessage
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngine.h:2690
agora::rtc::IRtcEngineEventHandler::onRequestToken
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:2294
agora::rtc::IRtcEngineEventHandler::onError
virtual void onError(int err, const char *msg)
Definition: IAgoraRtcEngine.h:1571
agora::rtc::IRtcEngine::getNtpWallTimeInMs
virtual uint64_t getNtpWallTimeInMs()=0
agora::rtc::IRtcEngine::startRtmpStreamWithoutTranscoding
virtual int startRtmpStreamWithoutTranscoding(const char *url)=0
agora::rtc::VideoCompositingLayout::regionCount
int regionCount
Definition: IAgoraRtcEngine.h:649
agora::rtc::ExtensionInfo::mediaSourceType
agora::media::MEDIA_SOURCE_TYPE mediaSourceType
Definition: IAgoraRtcEngine.h:3526
agora::rtc::IRtcEngineEventHandler::onProxyConnected
virtual void onProxyConnected(const char *channel, uid_t uid, PROXY_TYPE proxyType, const char *localProxyIp, int elapsed)
Definition: IAgoraRtcEngine.h:1558
agora::rtc::IRtcEngineEventHandler::onLocalPublishFallbackToAudioOnly
virtual void onLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover)
Definition: IAgoraRtcEngine.h:2599
agora::rtc::IRtcEngine::enableExtension
virtual int enableExtension(const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
agora::rtc::IRtcEngineEventHandler::onUserStateChanged
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2034
agora::rtc::PublisherConfiguration::height
int height
Definition: IAgoraRtcEngine.h:736
agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished
virtual void onAudioMixingFinished() __deprecated
Definition: IAgoraRtcEngine.h:1692
agora::rtc::AVideoDeviceManager
Definition: IAgoraRtcEngine.h:8684
agora::rtc::LocalVideoStats::codecType
VIDEO_CODEC_TYPE codecType
Definition: IAgoraRtcEngine.h:340
agora::rtc::ExtensionInfo::localUid
uid_t localUid
Definition: IAgoraRtcEngine.h:3551
agora::rtc::IRtcEngine::setSubscribeVideoBlocklist
virtual int setSubscribeVideoBlocklist(uid_t *uidList, int uidNumber)=0
agora::rtc::LocalTranscoderConfiguration
Definition: AgoraBase.h:4034
agora::rtc::IRtcEngine::adjustAudioMixingPlayoutVolume
virtual int adjustAudioMixingPlayoutVolume(int volume)=0
agora::rtc::InjectStreamConfig::audioBitrate
int audioBitrate
Definition: IAgoraRtcEngine.h:697
agora::rtc::IRtcEngine::setCameraDeviceOrientation
virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1633
agora::rtc::IRtcEngineEventHandler::onStreamMessageError
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:2277
agora::rtc::IPacketObserver
Definition: AgoraBase.h:3349
agora::rtc::IRtcEngine::setLocalPublishFallbackOption
virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
agora::rtc::LocalVideoStats::dualStreamEnabled
bool dualStreamEnabled
Definition: IAgoraRtcEngine.h:351
agora::rtc::IRtcEngine::writeLog
virtual int writeLog(commons::LOG_LEVEL level, const char *fmt,...)=0
agora::rtc::RemoteAudioStats::rxAudioBytes
unsigned int rxAudioBytes
Definition: IAgoraRtcEngine.h:471
agora::rtc::ChannelMediaOptions::publishEncodedVideoTrack
Optional< bool > publishEncodedVideoTrack
Definition: IAgoraRtcEngine.h:1165
agora::rtc::IRtcEngine::setDualStreamMode
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode)=0
agora::rtc::DirectCdnStreamingStats
Definition: IAgoraRtcEngine.h:3369
agora::rtc::VideoFormat
Definition: AgoraBase.h:2633
agora::rtc::RemoteVideoStats::uid
uid_t uid
Definition: IAgoraRtcEngine.h:508
agora::rtc::IRtcEngineEventHandler::onUserOffline
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1971
agora::rtc::IRtcEngine::registerExtension
virtual int registerExtension(const char *provider, const char *extension, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
agora::rtc::IRtcEngine::stopRtmpStream
virtual int stopRtmpStream(const char *url)=0
agora::rtc::DataStreamConfig
Definition: AgoraBase.h:2015
agora::rtc::IRtcEngineEventHandler::onCameraFocusAreaChanged
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height)
Definition: IAgoraRtcEngine.h:2123
agora::rtc::VideoCompositingLayout::Region::y
double y
Definition: IAgoraRtcEngine.h:600
agora::rtc::IRtcEngine::stopAudioMixing
virtual int stopAudioMixing()=0
agora::rtc::PublisherConfiguration
Definition: IAgoraRtcEngine.h:728
agora::rtc::IRtcEngine::setLogLevel
virtual int setLogLevel(commons::LOG_LEVEL level)=0
agora::rtc::RtcEngineContext::logConfig
commons::LogConfig logConfig
Definition: IAgoraRtcEngine.h:3212
agora::rtc::IRtcEngine::setRemoteDefaultVideoStreamType
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
agora::rtc::IRtcEngine::setRemoteVideoStreamType
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType)=0
agora::rtc::IRtcEngineEventHandler::onUserEnableVideo
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:2024
agora::rtc::IRtcEngineEventHandler::onRtmpStreamingStateChanged
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_REASON reason)
Definition: IAgoraRtcEngine.h:2506
agora::rtc::InjectStreamConfig::height
int height
Definition: IAgoraRtcEngine.h:677
agora::rtc::ChannelMediaOptions::publishFourthCameraTrack
Optional< bool > publishFourthCameraTrack
Definition: IAgoraRtcEngine.h:1096
agora::rtc::IRtcEngine::startRtmpStreamWithTranscoding
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
agora::rtc::DirectCdnStreamingMediaOptions
Definition: IAgoraRtcEngine.h:3424
agora::rtc::IRtcEngine::setVideoEncoderConfiguration
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
agora::rtc::AdvancedAudioOptions
Definition: IAgoraRtcEngine.h:1047
agora::rtc::IRtcEngine::queryCodecCapability
virtual int queryCodecCapability(CodecCapInfo *codecInfo, int &size)=0
agora::rtc::IRtcEngine::stopAllEffects
virtual int stopAllEffects()=0
agora::rtc::IRtcEngine::setLocalRenderMode
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) __deprecated=0
agora::rtc::IRtcEngine::pauseAllChannelMediaRelay
virtual int pauseAllChannelMediaRelay()=0
agora::rtc::LocalVideoStats::captureFrameHeight
int captureFrameHeight
Definition: IAgoraRtcEngine.h:296
agora::rtc::IRtcEngineEventHandler::onAudioQuality
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
Definition: IAgoraRtcEngine.h:1591
agora::rtc::IRtcEngine::startAudioMixing
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle)=0
agora::rtc::IRtcEngine::adjustLoopbackSignalVolume
virtual int adjustLoopbackSignalVolume(int volume)=0
agora::rtc::IRtcEngine::takeSnapshot
virtual int takeSnapshot(uid_t uid, const char *filePath)=0
agora::rtc::RtcEngineContext::license
const char * license
Definition: IAgoraRtcEngine.h:3177
agora::rtc::ScreenCaptureConfiguration::regionRect
Rectangle regionRect
Definition: IAgoraRtcEngine.h:893
agora::rtc::VideoCompositingLayout::canvasWidth
int canvasWidth
Definition: IAgoraRtcEngine.h:634
agora::rtc::LeaveChannelOptions::stopMicrophoneRecording
bool stopMicrophoneRecording
Definition: IAgoraRtcEngine.h:1499
agora::rtc::PublisherConfiguration::rawStreamUrl
const char * rawStreamUrl
Definition: IAgoraRtcEngine.h:775
agora::rtc::RemoteAudioStats::mosValue
int mosValue
Definition: IAgoraRtcEngine.h:430
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStats
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:2102
agora::rtc::IRtcEngine::setAudioEffectParameters
virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2)=0
agora::rtc::IRtcEngine::setColorEnhanceOptions
virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IRtcEngineEventHandler::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:2307
agora::rtc::LocalVideoStats::targetFrameRate
int targetFrameRate
Definition: IAgoraRtcEngine.h:326
agora::rtc::DirectCdnStreamingStats::audioBitrate
int audioBitrate
Definition: IAgoraRtcEngine.h:3393
agora::rtc::IRtcEngine::setRemoteSubscribeFallbackOption
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
agora::rtc::IRtcEngine::getExtensionProperty
virtual int getExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, char *value, int buf_len)=0
agora::rtc::RtcEngineContext::channelProfile
CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraRtcEngine.h:3172
agora::rtc::IRtcEngineEventHandler::onRemoteSubscribeFallbackToAudioOnly
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover)
Definition: IAgoraRtcEngine.h:2620
agora::rtc::IRtcEngine::setEarMonitoringAudioFrameParameters
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
agora::rtc::IRtcEngineEventHandler::onContentInspectResult
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition: IAgoraRtcEngine.h:2430
agora::rtc::IRtcEngine::release
static AGORA_CPP_API void release(bool sync=false)
agora::rtc::IRtcEngineEventHandler::onAudioDeviceStateChanged
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1672
agora::rtc::IAudioEncodedFrameObserver
Definition: AgoraBase.h:5349
agora::rtc::ChannelMediaOptions::token
Optional< const char * > token
Definition: IAgoraRtcEngine.h:1255
agora::rtc::ChannelMediaOptions::parameters
Optional< const char * > parameters
Definition: IAgoraRtcEngine.h:1294
agora::rtc::LeaveChannelOptions
Definition: IAgoraRtcEngine.h:1481
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:2061
agora::rtc::IRtcEngine::setEffectsVolume
virtual int setEffectsVolume(int volume)=0
agora::rtc::IRtcEngine::playAllEffects
virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish=false)=0
agora::rtc::DirectCdnStreamingStats::fps
int fps
Definition: IAgoraRtcEngine.h:3383
agora::rtc::IRtcEngine::stopLastmileProbeTest
virtual int stopLastmileProbeTest()=0
agora::rtc::ChannelMediaRelayConfiguration
Definition: AgoraBase.h:5548
agora::rtc::IRtcEngine::setAdvancedAudioOptions
virtual int setAdvancedAudioOptions(AdvancedAudioOptions &options, int sourceType=0)=0
agora::rtc::IRtcEngine::createMediaPlayer
virtual agora_refptr< IMediaPlayer > createMediaPlayer()=0
agora::rtc::IRtcEngine::queryInterface
virtual int queryInterface(INTERFACE_ID_TYPE iid, void **inter)=0
agora::rtc::IVideoDeviceCollection
Definition: IAgoraRtcEngine.h:2997
agora::rtc::IRtcEngine::renewToken
virtual int renewToken(const char *token)=0
agora::rtc::IRtcEngine::pauseAudio
virtual int pauseAudio() __deprecated=0
agora::rtc::IRtcEngine::setAudioProfile
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile)=0
agora::rtc::IRtcEngine::sendStreamMessage
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
agora::rtc::LocalVideoStats::txPacketLossRate
unsigned short txPacketLossRate
Definition: IAgoraRtcEngine.h:344
agora::rtc::IRtcEngineEventHandler::onLocalVideoStats
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:2089
agora::rtc::ChannelMediaOptions::publishCustomAudioTrack
Optional< bool > publishCustomAudioTrack
Definition: IAgoraRtcEngine.h:1149
agora::rtc::RemoteVideoStats::avSyncTimeMs
int avSyncTimeMs
Definition: IAgoraRtcEngine.h:566
agora::rtc::RtcEngineContext::domainLimit
bool domainLimit
Definition: IAgoraRtcEngine.h:3233
agora::rtc::VideoDenoiserOptions
Definition: AgoraBase.h:4609
agora::rtc::IRtcEngine::setLocalVideoMirrorMode
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0
agora::rtc::RemoteVideoStats::decoderOutputFrameRate
int decoderOutputFrameRate
Definition: IAgoraRtcEngine.h:538
agora::rtc::RtcEngineContext::context
void * context
Definition: IAgoraRtcEngine.h:3168
agora::rtc::IRtcEngineEventHandler::onActiveSpeaker
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2422
agora::rtc::RemoteAudioStats::frozenCntByCustom
uint32_t frozenCntByCustom
Definition: IAgoraRtcEngine.h:444
agora::rtc::ChannelMediaOptions::publishCameraTrack
Optional< bool > publishCameraTrack
Definition: IAgoraRtcEngine.h:1078
agora::rtc::RemoteAudioStats::e2eDelay
int e2eDelay
Definition: IAgoraRtcEngine.h:475
agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFrame
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1809
agora::rtc::ChannelMediaOptions::clientRoleType
Optional< CLIENT_ROLE_TYPE > clientRoleType
Definition: IAgoraRtcEngine.h:1222
agora::rtc::ChannelMediaOptions::publishThirdCameraTrack
Optional< bool > publishThirdCameraTrack
Definition: IAgoraRtcEngine.h:1090
agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1529
agora::rtc::DirectCdnStreamingMediaOptions::publishMediaPlayerId
Optional< int > publishMediaPlayerId
Definition: IAgoraRtcEngine.h:3459
agora::rtc::ChannelMediaOptions::channelProfile
Optional< CHANNEL_PROFILE_TYPE > channelProfile
Definition: IAgoraRtcEngine.h:1236
agora::rtc::RemoteAudioStats::audioLossRate
int audioLossRate
Definition: IAgoraRtcEngine.h:388
agora::rtc::IRtcEngine::setEncryptionMode
virtual int setEncryptionMode(const char *encryptionMode) __deprecated=0
agora::rtc::VideoCompositingLayout::Region::zOrder
int zOrder
Definition: IAgoraRtcEngine.h:610
agora::rtc::IRtcEngine::queryDeviceScore
virtual int queryDeviceScore()=0
agora::rtc::LocalVideoStats::captureFrameRate
int captureFrameRate
Definition: IAgoraRtcEngine.h:290
agora::rtc::VirtualBackgroundSource
Definition: AgoraBase.h:4675
agora::rtc::IRtcEngine::setParameters
virtual int setParameters(const char *parameters)=0
agora::rtc::IRtcEngine::muteRemoteVideoStream
virtual int muteRemoteVideoStream(uid_t uid, bool mute)=0
agora::rtc::IRtcEngine::setLowlightEnhanceOptions
virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IVideoDeviceManager
Definition: IAgoraRtcEngine.h:3041
agora::rtc::RemoteVideoStats::frozenRate
int frozenRate
Definition: IAgoraRtcEngine.h:561
agora::rtc::IRtcEngine::enableLocalAudio
virtual int enableLocalAudio(bool enabled)=0
agora::rtc::IRtcEngine::setupLocalVideo
virtual int setupLocalVideo(const VideoCanvas &canvas)=0
agora::rtc::VideoCompositingLayout::appDataLength
int appDataLength
Definition: IAgoraRtcEngine.h:655
agora::rtc::IRtcEngine::setLocalVoiceReverb
virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value)=0
agora::rtc::IRtcEngine::stopEffect
virtual int stopEffect(int soundId)=0
agora::rtc::VideoCompositingLayout::Region::alpha
double alpha
Definition: IAgoraRtcEngine.h:615
agora::rtc::IRtcEngine::enableCustomAudioLocalPlayback
virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled)=0
agora::rtc::DirectCdnStreamingMediaOptions::publishCustomVideoTrack
Optional< bool > publishCustomVideoTrack
Definition: IAgoraRtcEngine.h:3448
agora::rtc::ScreenCaptureConfiguration::isCaptureWindow
bool isCaptureWindow
Definition: IAgoraRtcEngine.h:867
agora::rtc::LocalVideoStats::encodedFrameHeight
int encodedFrameHeight
Definition: IAgoraRtcEngine.h:317
agora::rtc::IRtcEngineEventHandler::onAudioMetadataReceived
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:2916
agora::rtc::IRtcEngine::setLocalVoiceFormant
virtual int setLocalVoiceFormant(double formantRatio)=0
agora::rtc::AdvancedAudioOptions::audioProcessingChannels
Optional< int > audioProcessingChannels
Definition: IAgoraRtcEngine.h:1051
agora::rtc::IRtcEngine::getUserInfoByUserAccount
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
agora::rtc::WlAccStats
Definition: AgoraBase.h:4351
agora::rtc::IRtcEngine::setDefaultMuteAllRemoteAudioStreams
virtual int setDefaultMuteAllRemoteAudioStreams(bool mute) __deprecated=0
agora::rtc::IRtcEngine::setLogFile
virtual int setLogFile(const char *filePath)=0
agora::rtc::IRtcEngine::enableVirtualBackground
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IVideoDeviceCollection::setDevice
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
agora::rtc::IRtcEngine::setCameraCapturerConfiguration
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration &config)=0
agora::rtc::RemoteVideoStats::__deprecated
int delay __deprecated
Definition: IAgoraRtcEngine.h:516
agora::rtc::CameraCapturerConfiguration::deviceId
Optional< const char * > deviceId
Definition: IAgoraRtcEngine.h:844
agora::rtc::RemoteAudioStats::quality
int quality
Definition: IAgoraRtcEngine.h:374
agora::rtc::PublisherConfiguration::width
int width
Definition: IAgoraRtcEngine.h:732
agora::rtc::VideoCompositingLayout::Region::width
double width
Definition: IAgoraRtcEngine.h:604
agora::rtc::IRtcEngine::startEchoTest
virtual int startEchoTest(const EchoTestConfiguration &config)=0
agora::rtc::IRtcEngine::startOrUpdateChannelMediaRelay
virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
agora::rtc::IRtcEngineEventHandler::onConnectionBanned
virtual void onConnectionBanned() __deprecated
Definition: IAgoraRtcEngine.h:2244
agora::rtc::IRtcEngine::getEffectsVolume
virtual int getEffectsVolume()=0
agora::rtc::IRtcEngineEventHandler::onEncryptionError
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2726
agora::rtc::IRtcEngineEventHandler::onCameraReady
virtual void onCameraReady() __deprecated
Definition: IAgoraRtcEngine.h:2111
agora::rtc::IRtcEngine::getEffectDuration
virtual int getEffectDuration(const char *filePath)=0
agora::rtc::IRtcEngineEventHandler::onWlAccStats
virtual void onWlAccStats(const WlAccStats &currentStats, const WlAccStats &averageStats)
Definition: IAgoraRtcEngine.h:2701
agora::rtc::CodecCapInfo
Definition: AgoraBase.h:1827
agora::commons::LogConfig
Definition: IAgoraLog.h:83
agora::rtc::IRtcEngine::setPlaybackAudioFrameParameters
virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
agora::rtc::IRtcEngine::setLogFileSize
virtual int setLogFileSize(unsigned int fileSizeInKBytes)=0
agora::rtc::LeaveChannelOptions::stopAllEffect
bool stopAllEffect
Definition: IAgoraRtcEngine.h:1493
agora::rtc::ChannelMediaOptions::defaultVideoStreamType
Optional< VIDEO_STREAM_TYPE > defaultVideoStreamType
Definition: IAgoraRtcEngine.h:1231
agora::rtc::IRtcEngine::preloadChannelWithUserAccount
virtual int preloadChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
agora::rtc::RemoteVideoStats::rxVideoBytes
unsigned int rxVideoBytes
Definition: IAgoraRtcEngine.h:587
createAgoraRtcEngine
AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine()
agora::rtc::IRtcEngine::setBeautyEffectOptions
virtual int setBeautyEffectOptions(bool enabled, const BeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IRtcEngine::startAudioRecording
virtual int startAudioRecording(const AudioRecordingConfiguration &config)=0
agora::rtc::RtcEngineContext::autoRegisterAgoraExtensions
bool autoRegisterAgoraExtensions
Definition: IAgoraRtcEngine.h:3240
agora::rtc::LocalVideoStats
Definition: IAgoraRtcEngine.h:275
agora::rtc::IMetadataObserver::onMetadataReceived
virtual void onMetadataReceived(const Metadata &metadata)=0
agora::rtc::IRtcEngine::setAudioMixingPlaybackSpeed
virtual int setAudioMixingPlaybackSpeed(int speed)=0
agora::rtc::IRtcEngine::resumeAllChannelMediaRelay
virtual int resumeAllChannelMediaRelay()=0
agora::rtc::IRtcEngine::setExtensionProperty
virtual int setExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, const char *value)=0
agora::rtc::ChannelMediaOptions::publishMediaPlayerId
Optional< int > publishMediaPlayerId
Definition: IAgoraRtcEngine.h:1217
agora::rtc::IDirectCdnStreamingEventHandler
Definition: IAgoraRtcEngine.h:3400
agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2381
agora::rtc::IRtcEngineEventHandler::onAudioSubscribeStateChanged
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2834
agora::rtc::IRtcEngineEventHandler::onVideoStopped
virtual void onVideoStopped() __deprecated
Definition: IAgoraRtcEngine.h:2191
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:5755
agora::rtc::IRtcEngine::destroyMediaPlayer
virtual int destroyMediaPlayer(agora_refptr< IMediaPlayer > media_player)=0
agora::rtc::LocalVideoStats::simulcastDimensions
VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX]
Definition: IAgoraRtcEngine.h:359
agora::rtc::IRtcEngine::setAudioMixingPosition
virtual int setAudioMixingPosition(int pos)=0
agora::rtc::ChannelMediaOptions::publishTranscodedVideoTrack
Optional< bool > publishTranscodedVideoTrack
Definition: IAgoraRtcEngine.h:1183
agora::rtc::ScreenCaptureConfiguration::displayId
uint32_t displayId
Definition: IAgoraRtcEngine.h:871
agora::rtc::ChannelMediaOptions::enableAudioRecordingOrPlayout
Optional< bool > enableAudioRecordingOrPlayout
Definition: IAgoraRtcEngine.h:1213
agora::rtc::IRtcEngineEventHandler::onVideoPublishStateChanged
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2883
agora::rtc::RemoteVideoStats::receivedBitrate
int receivedBitrate
Definition: IAgoraRtcEngine.h:532
agora::rtc::RemoteAudioStats
Definition: IAgoraRtcEngine.h:366
agora::rtc::TranscodingVideoStream
Definition: AgoraBase.h:3965
agora::rtc::IMetadataObserver::MAX_METADATA_SIZE_TYPE
MAX_METADATA_SIZE_TYPE
Definition: IAgoraRtcEngine.h:3271
agora::rtc::IRtcEngine::enableVideoImageSource
virtual int enableVideoImageSource(bool enable, const ImageTrackOptions &options)=0
enable or disable video image source to replace the current video source published or resume it
agora::rtc::LocalVideoStats::encoderOutputFrameRate
int encoderOutputFrameRate
Definition: IAgoraRtcEngine.h:311
agora::rtc::IRtcEngine::unregisterAudioSpectrumObserver
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
agora::rtc::IRtcEngine::setupRemoteVideo
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
agora::rtc::IRtcEngineEventHandler::onLastmileProbeResult
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:1603
agora::rtc::IVideoDeviceManager::startDeviceTest
virtual int startDeviceTest(view_t hwnd)=0
agora::rtc::IRtcEngine::addVideoWatermark
virtual int addVideoWatermark(const RtcImage &watermark) __deprecated=0
agora::rtc::IRtcEngineEventHandler::onConnectionLost
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:2226
agora::rtc::IRtcEngineEventHandler::onUserMuteVideo
virtual void onUserMuteVideo(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2007
agora::rtc::PublisherConfiguration::owner
bool owner
Definition: IAgoraRtcEngine.h:758
agora::rtc::IRtcEngine::setInEarMonitoringVolume
virtual int setInEarMonitoringVolume(int volume)=0
agora::rtc::IRtcEngine::setDefaultMuteAllRemoteVideoStreams
virtual int setDefaultMuteAllRemoteVideoStreams(bool mute) __deprecated=0
agora::rtc::IRtcEngine::enableSoundPositionIndication
virtual int enableSoundPositionIndication(bool enabled)=0
agora::rtc::VideoCompositingLayout::regions
const Region * regions
Definition: IAgoraRtcEngine.h:646
agora::rtc::IRtcEngine::stopCameraCapture
virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType)=0
agora::rtc::ChannelMediaOptions::publishMediaPlayerVideoTrack
Optional< bool > publishMediaPlayerVideoTrack
Definition: IAgoraRtcEngine.h:1177
agora::rtc::IRtcEngine::stopPreview
virtual int stopPreview()=0
agora::rtc::RemoteVideoStats::mosValue
int mosValue
Definition: IAgoraRtcEngine.h:583
agora::rtc::IRtcEngine::destroyCustomEncodedVideoTrack
virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id)=0
agora::rtc::DirectCdnStreamingMediaOptions::customVideoTrackId
Optional< video_track_id_t > customVideoTrackId
Definition: IAgoraRtcEngine.h:3464
agora::rtc::IRtcEngineEventHandler::onVideoSizeChanged
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1862
agora::rtc::IRtcEngine::muteRecordingSignal
virtual int muteRecordingSignal(bool mute)=0
agora::rtc::IRtcEngineEventHandler::onLocalUserRegistered
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2760
agora::rtc::LocalVideoStats::encodedFrameWidth
int encodedFrameWidth
Definition: IAgoraRtcEngine.h:314
agora::rtc::RtcStats
Definition: AgoraBase.h:2239
agora::rtc::LowlightEnhanceOptions
Definition: AgoraBase.h:4568
agora::rtc::IRtcEngine::setVoiceBeautifierParameters
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
agora::rtc::IRtcEngine::muteRemoteAudioStream
virtual int muteRemoteAudioStream(uid_t uid, bool mute)=0
agora::rtc::IRtcEngine::setVideoDenoiserOptions
virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IRtcEngineEventHandler::onSnapshotTaken
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngine.h:2449
agora::rtc::IRtcEngine::destroyCustomVideoTrack
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id)=0
agora::rtc::IRtcEngine::setVoiceConversionParameters
virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
agora::rtc::SimulcastConfig::STREAM_LAYER_COUNT_MAX
@ STREAM_LAYER_COUNT_MAX
Definition: AgoraBase.h:2118
agora::rtc::ChannelMediaOptions::publishLipSyncTrack
Optional< bool > publishLipSyncTrack
Definition: IAgoraRtcEngine.h:1195
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1926
agora::rtc::IRtcEngine::adjustAudioMixingVolume
virtual int adjustAudioMixingVolume(int volume)=0
agora::rtc::WatermarkOptions
Definition: AgoraBase.h:2202
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3475
agora::rtc::RecorderStreamInfo
Definition: AgoraBase.h:6265
agora::rtc::ChannelMediaOptions::publishThirdScreenTrack
Optional< bool > publishThirdScreenTrack
Definition: IAgoraRtcEngine.h:1135
agora::rtc::IRtcEngineEventHandler::onAudioDeviceVolumeChanged
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngine.h:2489
agora::rtc::SimulcastConfig
Definition: AgoraBase.h:2082
agora::rtc::IRtcEngine::leaveChannel
virtual int leaveChannel()=0
agora::rtc::IRtcEngine::setAudioScenario
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
agora::rtc::IRtcEngine::setClientRole
virtual int setClientRole(CLIENT_ROLE_TYPE role)=0
agora::rtc::IRtcEngine::preloadChannel
virtual int preloadChannel(const char *token, const char *channelId, uid_t uid)=0
agora::rtc::IRtcEngineEventHandler::onClientRoleChanged
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngine.h:2464
agora::rtc::IRtcEngineEventHandler::onExtensionError
virtual void onExtensionError(const char *provider, const char *extension, int error, const char *message)
Definition: IAgoraRtcEngine.h:2976
agora::rtc::RemoteVideoStats::width
int width
Definition: IAgoraRtcEngine.h:524
agora::rtc::RtcEngineContext::audioScenario
AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraRtcEngine.h:3186
agora::rtc::RemoteVideoStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:541
agora::rtc::IRtcEngine::setVoiceBeautifierPreset
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
agora::rtc::RemoteVideoStats::decoderInputFrameRate
int decoderInputFrameRate
Definition: IAgoraRtcEngine.h:535
agora::rtc::IRtcEngine::rate
virtual int rate(const char *callId, int rating, const char *description)=0
agora::rtc::LocalVideoStats::targetBitrate
int targetBitrate
Definition: IAgoraRtcEngine.h:323
agora::rtc::ChannelMediaOptions::publishSecondaryScreenTrack
Optional< bool > publishSecondaryScreenTrack
Definition: IAgoraRtcEngine.h:1129
agora::rtc::RemoteAudioStats::qualityChangedReason
int qualityChangedReason
Definition: IAgoraRtcEngine.h:467
agora::rtc::IRtcEngine::getCallId
virtual int getCallId(agora::util::AString &callId)=0
agora::rtc::InjectStreamConfig
Definition: IAgoraRtcEngine.h:669
agora::rtc::IRtcEngine::uploadLogFile
virtual int uploadLogFile(agora::util::AString &requestId)=0
agora::rtc::IRtcEngine::startMediaRenderingTracing
virtual int startMediaRenderingTracing()=0
Start tracing media rendering events.
agora::rtc::CameraCapturerConfiguration::format
VideoFormat format
Definition: IAgoraRtcEngine.h:855
agora::rtc::LocalVideoStats::encodedFrameCount
int encodedFrameCount
Definition: IAgoraRtcEngine.h:337
agora::rtc::PublisherConfiguration::bitrate
int bitrate
Definition: IAgoraRtcEngine.h:744
agora::rtc::LocalVideoStats::regulatedCaptureFrameRate
int regulatedCaptureFrameRate
Definition: IAgoraRtcEngine.h:300
agora::rtc::IRtcEngine::enableWirelessAccelerate
virtual int enableWirelessAccelerate(bool enabled)=0
agora::rtc::IRtcEngine::createCustomEncodedVideoTrack
virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions &sender_option)=0
agora::rtc::RtcEngineContext
Definition: IAgoraRtcEngine.h:3151
agora::rtc::IRtcEngine::unloadAllEffects
virtual int unloadAllEffects()=0
agora::rtc::ChannelMediaOptions
Definition: IAgoraRtcEngine.h:1072
agora::rtc::IRtcEngine
Definition: IAgoraRtcEngine.h:3565
agora::rtc::IRtcEngine::setClientRole
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
agora::rtc::IRtcEngine::enableLoopbackRecording
virtual int enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0
agora::rtc::IRtcEngine::sendAudioMetadata
virtual int sendAudioMetadata(const char *metadata, size_t length)=0
send audio metadata
agora::rtc::IRtcEngine::createMediaRecorder
virtual agora_refptr< IMediaRecorder > createMediaRecorder(const RecorderStreamInfo &info)=0
agora::rtc::ScreenCaptureConfiguration
Definition: IAgoraRtcEngine.h:861
agora::rtc::IRtcEngine::setAudioMixingDualMonoMode
virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode)=0
agora::rtc::ChannelMediaOptions::autoSubscribeVideo
Optional< bool > autoSubscribeVideo
Definition: IAgoraRtcEngine.h:1207
agora::rtc::AudioRecordingConfiguration
Definition: AgoraBase.h:5256
agora::rtc::IRtcEngine::getEffectCurrentPosition
virtual int getEffectCurrentPosition(int soundId)=0
agora::rtc::ChannelMediaOptions::publishMicrophoneTrack
Optional< bool > publishMicrophoneTrack
Definition: IAgoraRtcEngine.h:1102
agora::rtc::IRtcEngine::updatePreloadChannelToken
virtual int updatePreloadChannelToken(const char *token)=0
agora::rtc::IRtcEngine::resumeAudio
virtual int resumeAudio() __deprecated=0
agora::rtc::IRtcEngine::muteLocalAudioStream
virtual int muteLocalAudioStream(bool mute)=0
agora::rtc::IRtcEngine::joinChannelWithUserAccount
virtual int joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
agora::rtc::IRtcEngine::setChannelProfile
virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile)=0
agora::rtc::RemoteVideoStats::frameLossRate
int frameLossRate
Definition: IAgoraRtcEngine.h:544
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1081
agora::rtc::IRtcEngine::updateDirectCdnStreamingMediaOptions
virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions &options)=0
agora::rtc::IRtcEngine::setLocalVoicePitch
virtual int setLocalVoicePitch(double pitch)=0
agora::rtc::IRtcEngineEventHandler::onTranscodedStreamLayoutInfo
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngine.h:2900
agora::rtc::RemoteVideoStats::height
int height
Definition: IAgoraRtcEngine.h:528
agora::rtc::LocalVideoStats::captureFrameWidth
int captureFrameWidth
Definition: IAgoraRtcEngine.h:293
agora::rtc::IRtcEngine::setAudioEffectPreset
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0
agora::rtc::IRtcEngineEventHandler::onExtensionEvent
virtual void onExtensionEvent(const char *provider, const char *extension, const char *key, const char *value)
Definition: IAgoraRtcEngine.h:2932
agora::rtc::RtcEngineContext::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraRtcEngine.h:3226
agora::rtc::IRtcEngine::preloadEffect
virtual int preloadEffect(int soundId, const char *filePath, int startPos=0)=0
agora::rtc::RemoteAudioStats::frozenRate
int frozenRate
Definition: IAgoraRtcEngine.h:413
agora::rtc::IRtcEngine::setVideoScenario
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
agora::rtc::RemoteAudioStats::plcCount
uint32_t plcCount
Definition: IAgoraRtcEngine.h:439
agora::rtc::IRtcEngine::stopEchoTest
virtual int stopEchoTest()=0
agora::rtc::IRtcEngine::startAudioRecording
virtual int startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
agora::rtc::IRtcEngine::setLocalVoiceEqualization
virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
agora::rtc::DirectCdnStreamingMediaOptions::publishMediaPlayerAudioTrack
Optional< bool > publishMediaPlayerAudioTrack
Definition: IAgoraRtcEngine.h:3454
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:150
agora::rtc::IRtcEngine::getNetworkType
virtual int getNetworkType()=0
agora::rtc::InjectStreamConfig::audioSampleRate
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: IAgoraRtcEngine.h:693
agora::rtc::IRtcEngine::enableExtension
virtual int enableExtension(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, bool enable=true)=0
agora::rtc::PublisherConfiguration::framerate
int framerate
Definition: IAgoraRtcEngine.h:740
agora::rtc::IRtcEngine::resumeEffect
virtual int resumeEffect(int soundId)=0
agora::rtc::PublisherConfiguration::injectStreamUrl
const char * injectStreamUrl
Definition: IAgoraRtcEngine.h:767
agora::rtc::ChannelMediaOptions::publishScreenTrack
Optional< bool > publishScreenTrack
Definition: IAgoraRtcEngine.h:1123
agora::rtc::IRtcEngineEventHandler::onAudioRoutingChanged
virtual void onAudioRoutingChanged(int routing)
Definition: IAgoraRtcEngine.h:2548
agora::rtc::IRtcEngine::playEffect
virtual int playEffect(int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false, int startPos=0)=0
agora::rtc::InjectStreamConfig::videoBitrate
int videoBitrate
Definition: IAgoraRtcEngine.h:689
agora::rtc::LocalVideoStats::captureBrightnessLevel
CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel
Definition: IAgoraRtcEngine.h:347
agora::rtc::IRtcEngine::enableVideo
virtual int enableVideo()=0
agora::rtc::IRtcEngine::setRemoteUserSpatialAudioParams
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams &params)=0
agora::rtc::IRtcEngine::setHeadphoneEQParameters
virtual int setHeadphoneEQParameters(int lowGain, int highGain)=0
agora::rtc::IMetadataObserver::UNKNOWN_METADATA
@ UNKNOWN_METADATA
Definition: IAgoraRtcEngine.h:3262
agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1826
agora::rtc::IRtcEngine::startEchoTest
virtual int startEchoTest()=0
agora::rtc::IRtcEngine::stopScreenCapture
virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType)=0
agora::rtc::IRtcEngine::updateChannelMediaOptions
virtual int updateChannelMediaOptions(const ChannelMediaOptions &options)=0
agora::rtc::RemoteAudioStats::numChannels
int numChannels
Definition: IAgoraRtcEngine.h:392
agora::rtc::IRtcEngineEventHandler::onSetRtmFlagResult
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:2989
agora::rtc::ChannelMediaOptions::audioDelayMs
Optional< int > audioDelayMs
Definition: IAgoraRtcEngine.h:1241
agora::rtc::IRtcEngine::createDataStream
virtual int createDataStream(int *streamId, const DataStreamConfig &config)=0
agora::rtc::IRtcEngine::initialize
virtual int initialize(const RtcEngineContext &context)=0
agora::rtc::IRtcEngineEventHandler::onNetworkQuality
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1746
agora::rtc::IRtcEngine::resumeAudioMixing
virtual int resumeAudioMixing()=0
agora::rtc::ImageTrackOptions
Definition: IAgoraRtcEngine.h:1057
agora::rtc::IRtcEngine::unloadEffect
virtual int unloadEffect(int soundId)=0
agora::rtc::VideoCompositingLayout::Region
Definition: IAgoraRtcEngine.h:591
agora::rtc::IRtcEngine::stopRhythmPlayer
virtual int stopRhythmPlayer()=0
agora::rtc::IRtcEngine::getAudioMixingPlayoutVolume
virtual int getAudioMixingPlayoutVolume()=0
agora::rtc::IRtcEngine::startLastmileProbeTest
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
agora::rtc::IRtcEngineEventHandler::onVideoSubscribeStateChanged
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2851
agora::rtc::IRtcEngine::getExtensionProperty
virtual int getExtensionProperty(const char *provider, const char *extension, const char *key, char *value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
agora::rtc::ChannelMediaOptions::publishFourthScreenTrack
Optional< bool > publishFourthScreenTrack
Definition: IAgoraRtcEngine.h:1141
agora::rtc::RemoteAudioStats::jitterBufferDelay
int jitterBufferDelay
Definition: IAgoraRtcEngine.h:384
agora::rtc::IRtcEngine::adjustPlaybackSignalVolume
virtual int adjustPlaybackSignalVolume(int volume)=0
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStateChanged
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1912
agora::rtc::IRtcEngine::setExtensionProviderProperty
virtual int setExtensionProviderProperty(const char *provider, const char *key, const char *value)=0
agora::rtc::PublisherConfiguration::injectStreamWidth
int injectStreamWidth
Definition: IAgoraRtcEngine.h:761
agora::rtc::ChannelMediaOptions::publishMixedAudioTrack
Optional< bool > publishMixedAudioTrack
Definition: IAgoraRtcEngine.h:1189
agora::rtc::RemoteVideoStats::rxStreamType
VIDEO_STREAM_TYPE rxStreamType
Definition: IAgoraRtcEngine.h:551
agora::rtc::IRtcEngine::enableAudio
virtual int enableAudio()=0
agora::rtc::IVideoDeviceManager::stopDeviceTest
virtual int stopDeviceTest()=0
agora::rtc::IMetadataObserver::Metadata::uid
unsigned int uid
Definition: IAgoraRtcEngine.h:3285
agora::rtc::RemoteAudioStats::uid
uid_t uid
Definition: IAgoraRtcEngine.h:370
agora::rtc::IRtcEngine::disableVideo
virtual int disableVideo()=0
agora::rtc::IRtcEngine::enableDualStreamMode
virtual int enableDualStreamMode(bool enabled) __deprecated=0
agora::rtc::InjectStreamConfig::videoGop
int videoGop
Definition: IAgoraRtcEngine.h:681
agora::rtc::IRtcEngine::setVideoQoEPreference
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
agora::rtc::ChannelMediaOptions::isInteractiveAudience
Optional< bool > isInteractiveAudience
Definition: IAgoraRtcEngine.h:1277
agora::SpatialAudioParams
Definition: AgoraBase.h:6315
agora::rtc::IRtcEngine::setLogFilter
virtual int setLogFilter(unsigned int filter)=0
agora::rtc::IRtcEngine::getLoopbackRecordingVolume
virtual int getLoopbackRecordingVolume()=0
agora::rtc::IRtcEngineEventHandler::onPermissionError
virtual void onPermissionError(PERMISSION_TYPE permissionType)
Definition: IAgoraRtcEngine.h:2739
agora::rtc::IRtcEngineEventHandler::onUploadLogResult
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2819
agora::rtc::RemoteAudioStats::qoeQuality
int qoeQuality
Definition: IAgoraRtcEngine.h:463
agora::rtc::IRtcEngine::setHeadphoneEQPreset
virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset)=0
agora::rtc::IRtcEngine::startCameraCapture
virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration &config)=0
agora::rtc::IRtcEngine::setLocalAccessPoint
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration &config)=0
agora::rtc::IRtcEngine::createCustomVideoTrack
virtual video_track_id_t createCustomVideoTrack()=0
agora::rtc::IRtcEngine::disableAudio
virtual int disableAudio()=0
agora::rtc::IRtcEngine::muteAllRemoteAudioStreams
virtual int muteAllRemoteAudioStreams(bool mute)=0
agora::rtc::IRtcEngineEventHandler::onRtcStats
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1657
agora::rtc::IRtcEngineEventHandler::onUserJoined
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1952
agora::rtc::AAudioDeviceManager
Definition: IAgoraRtcEngine.h:8677
agora::rtc::IMetadataObserver::Metadata
Definition: IAgoraRtcEngine.h:3280
agora::rtc::IRtcEngine::sendCustomReportMessage
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
agora::rtc::FocalLengthInfo
Definition: AgoraBase.h:1839
agora::rtc::RemoteVideoStats::packetLossRate
int packetLossRate
Definition: IAgoraRtcEngine.h:547
agora::rtc::LocalVideoStats::hwEncoderAccelerating
int hwEncoderAccelerating
Definition: IAgoraRtcEngine.h:356
agora::rtc::DeviceInfo
Definition: AgoraBase.h:3335
agora::base::IEngineBase
Definition: AgoraBase.h:6281
agora::rtc::LocalVideoStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:320
agora::rtc::IRtcEngineEventHandler::onDownlinkNetworkInfoUpdated
virtual void onDownlinkNetworkInfoUpdated(const DownlinkNetworkInfo &info)
Definition: IAgoraRtcEngine.h:1781
agora::rtc::DirectCdnStreamingMediaOptions::publishCustomAudioTrack
Optional< bool > publishCustomAudioTrack
Definition: IAgoraRtcEngine.h:3442
agora::rtc::VideoRenderingTracingInfo
Definition: AgoraBase.h:6129
agora::rtc::IRtcEngineEventHandler::onAudioMixingStateChanged
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2200
agora::rtc::IRtcEngine::setLocalRenderMode
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
agora::rtc::IRtcEngine::startAudioFrameDump
virtual int startAudioFrameDump(const char *channel_id, uid_t uid, const char *location, const char *uuid, const char *passwd, long duration_ms, bool auto_upload)=0
agora::rtc::IRtcEngine::setAudioProfile
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
agora::rtc::RtcEngineContext::areaCode
unsigned int areaCode
Definition: IAgoraRtcEngine.h:3195
agora::rtc::IRtcEngine::setSimulcastConfig
virtual int setSimulcastConfig(const SimulcastConfig &simulcastConfig)=0
agora::rtc::IRtcEngineEventHandler::onLicenseValidationFailure
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2316
agora::rtc::CameraCapturerConfiguration
Definition: IAgoraRtcEngine.h:825
agora::rtc::IMetadataObserver::VIDEO_METADATA
@ VIDEO_METADATA
Definition: IAgoraRtcEngine.h:3265
agora::rtc::IRtcEngine::selectAudioTrack
virtual int selectAudioTrack(int index)=0
agora::rtc::RemoteVideoStats
Definition: IAgoraRtcEngine.h:504
agora::rtc::IRtcEngine::startAudioRecording
virtual int startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
agora::rtc::PublisherConfiguration::injectStreamHeight
int injectStreamHeight
Definition: IAgoraRtcEngine.h:764
agora::Optional
Definition: AgoraOptional.h:52
agora::rtc::IRtcEngine::joinChannel
virtual int joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0
agora::rtc::IMetadataObserver::Metadata::size
unsigned int size
Definition: IAgoraRtcEngine.h:3288
agora::rtc::ClientRoleOptions
Definition: AgoraBase.h:2484
agora::rtc::IRtcEngine::setRecordingAudioFrameParameters
virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
agora::rtc::ScreenCaptureConfiguration::screenRect
Rectangle screenRect
Definition: IAgoraRtcEngine.h:876
agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:2049
agora::rtc::IVideoDeviceManager::setDevice
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
agora::rtc::IRtcEngineEventHandler::onChannelMediaRelayStateChanged
virtual void onChannelMediaRelayStateChanged(int state, int code)
Definition: IAgoraRtcEngine.h:2581
agora::rtc::IRtcEngine::complain
virtual int complain(const char *callId, const char *description)=0
agora::rtc::IRtcEngine::clearVideoWatermarks
virtual int clearVideoWatermarks()=0
agora::rtc::IRtcEngine::stopAudioRecording
virtual int stopAudioRecording()=0
agora::rtc::IRtcEngineEventHandler::onAudioPublishStateChanged
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2867
agora::rtc::IRtcEngine::setHighPriorityUserList
virtual int setHighPriorityUserList(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option)=0
agora::rtc::IRtcEngine::setScreenCaptureOrientation
virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
agora::rtc::RemoteAudioStats::receivedSampleRate
int receivedSampleRate
Definition: IAgoraRtcEngine.h:396
agora::rtc::IRtcEngine::startPreview
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType)=0
agora::rtc::VideoCanvas
Definition: AgoraBase.h:4425
agora::rtc::VideoCompositingLayout::Region::uid
uid_t uid
Definition: IAgoraRtcEngine.h:594
agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2678
agora::rtc::SegmentationProperty
Definition: AgoraBase.h:4742
agora::rtc::VideoCompositingLayout::Region::x
double x
Definition: IAgoraRtcEngine.h:597
agora::rtc::IRtcEngineEventHandler::onExtensionStarted
virtual void onExtensionStarted(const char *provider, const char *extension)
Definition: IAgoraRtcEngine.h:2947
Generated by   doxygen 1.8.18