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 
445  int totalActiveTime;
449  int publishDuration;
453  int qoeQuality;
457  int qualityChangedReason;
461  unsigned int rxAudioBytes;
465  int e2eDelay;
466 
467  RemoteAudioStats()
468  : uid(0),
469  quality(0),
470  networkTransportDelay(0),
471  jitterBufferDelay(0),
472  audioLossRate(0),
473  numChannels(0),
474  receivedSampleRate(0),
475  receivedBitrate(0),
476  totalFrozenTime(0),
477  frozenRate(0),
478  mosValue(0),
479  frozenRateByCustomPlcCount(0),
480  plcCount(0),
481  totalActiveTime(0),
482  publishDuration(0),
483  qoeQuality(0),
484  qualityChangedReason(0),
485  rxAudioBytes(0),
486  e2eDelay(0) {}
487 };
488 
492 struct RemoteVideoStats {
496  uid_t uid;
504  int delay __deprecated;
508  int e2eDelay;
512  int width;
516  int height;
520  int receivedBitrate;
523  int decoderInputFrameRate;
526  int decoderOutputFrameRate;
529  int rendererOutputFrameRate;
532  int frameLossRate;
535  int packetLossRate;
539  VIDEO_STREAM_TYPE rxStreamType;
545  int totalFrozenTime;
549  int frozenRate;
554  int avSyncTimeMs;
559  int totalActiveTime;
563  int publishDuration;
571  int mosValue;
575  unsigned int rxVideoBytes;
576 };
577 
578 struct VideoCompositingLayout {
579  struct Region {
582  uid_t uid;
585  double x; // [0,1]
588  double y; // [0,1]
592  double width; // [0,1]
594  double height; // [0,1]
598  int zOrder; // optional, [0, 100] //0 (default): bottom most, 100: top most
599 
603  double alpha;
604 
605  media::base::RENDER_MODE_TYPE renderMode; // RENDER_MODE_HIDDEN: Crop, RENDER_MODE_FIT: Zoom to fit
606 
607  Region()
608  : uid(0),
609  x(0),
610  y(0),
611  width(0),
612  height(0),
613  zOrder(0),
614  alpha(1.0),
615  renderMode(media::base::RENDER_MODE_HIDDEN) {}
616  };
617 
622  int canvasWidth;
627  int canvasHeight;
630  const char* backgroundColor; // e.g. "#C0C0C0" in RGB
634  const Region* regions;
637  int regionCount;
640  const char* appData;
643  int appDataLength;
644 
645  VideoCompositingLayout()
646  : canvasWidth(0),
647  canvasHeight(0),
648  backgroundColor(OPTIONAL_NULLPTR),
649  regions(NULL),
650  regionCount(0),
651  appData(OPTIONAL_NULLPTR),
652  appDataLength(0) {}
653 };
654 
657 struct InjectStreamConfig {
661  int width;
665  int height;
669  int videoGop;
673  int videoFramerate;
677  int videoBitrate;
681  AUDIO_SAMPLE_RATE_TYPE audioSampleRate;
685  int audioBitrate;
688  int audioChannels;
689 
690  // width / height default set to 0 means pull the stream with its original
691  // resolution
692  InjectStreamConfig()
693  : width(0),
694  height(0),
695  videoGop(30),
696  videoFramerate(15),
697  videoBitrate(400),
698  audioSampleRate(AUDIO_SAMPLE_RATE_48000),
699  audioBitrate(48),
700  audioChannels(1) {}
701 };
702 
705 enum RTMP_STREAM_LIFE_CYCLE_TYPE {
708  RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL = 1,
711  RTMP_STREAM_LIFE_CYCLE_BIND2OWNER = 2,
712 };
713 
716 struct PublisherConfiguration {
720  int width;
724  int height;
728  int framerate;
732  int bitrate;
738  int defaultLayout;
741  int lifecycle;
746  bool owner;
749  int injectStreamWidth;
752  int injectStreamHeight;
755  const char* injectStreamUrl;
759  const char* publishUrl;
763  const char* rawStreamUrl;
766  const char* extraInfo;
767 
768  PublisherConfiguration()
769  : width(640),
770  height(360),
771  framerate(15),
772  bitrate(500),
773  defaultLayout(1),
774  lifecycle(RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL),
775  owner(true),
776  injectStreamWidth(0),
777  injectStreamHeight(0),
778  injectStreamUrl(NULL),
779  publishUrl(NULL),
780  rawStreamUrl(NULL),
781  extraInfo(NULL) {}
782 };
783 
787 enum CAMERA_DIRECTION {
789  CAMERA_REAR = 0,
791  CAMERA_FRONT = 1,
792 };
793 
798 enum CLOUD_PROXY_TYPE {
801  NONE_PROXY = 0,
804  UDP_PROXY = 1,
806 
808  TCP_PROXY = 2,
810 };
811 
813 struct CameraCapturerConfiguration {
815 #if defined(__ANDROID__) || (defined(__APPLE__) && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
816 
819  Optional<CAMERA_DIRECTION> cameraDirection;
820 
821  /*- CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_DEFAULT:
822  For iOS, if iPhone/iPad has 3 or 2 back camera, it means combination of triple (wide + ultra wide + telephoto) camera
823  or dual wide(wide + ultra wide) camera.In this situation, you can apply for ultra wide len by set smaller zoom fator
824  and bigger zoom fator for telephoto len.Otherwise, it always means wide back/front camera.
825 
826  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_WIDE_ANGLE:wide camera
827  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_ULTRA_WIDE:ultra wide camera
828  - CAMERA_FOCAL_LENGTH_TYPE.CAMERA_FOCAL_LENGTH_TELEPHOTO:telephoto camera*/
829  Optional<CAMERA_FOCAL_LENGTH_TYPE> cameraFocalLengthType;
830 #else
831 
832  Optional<const char *> deviceId;
833 #endif
834 
835 #if defined(__ANDROID__)
836 
839  Optional<const char *> cameraId;
840 #endif
841  Optional<bool> followEncodeDimensionRatio;
843  VideoFormat format;
844  CameraCapturerConfiguration() : format(VideoFormat(0, 0, 0)) {}
845 };
849 struct ScreenCaptureConfiguration {
855  bool isCaptureWindow; // true - capture window, false - capture display
859  int64_t displayId;
864  Rectangle screenRect; //Windows only
869  int64_t windowId;
873  ScreenCaptureParameters params;
881  Rectangle regionRect;
882 
883  ScreenCaptureConfiguration() : isCaptureWindow(false), displayId(0), windowId(0) {}
884 };
885 
886 #if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
887 
889 struct SIZE {
892  int width;
895  int height;
896 
897  SIZE() : width(0), height(0) {}
898  SIZE(int ww, int hh) : width(ww), height(hh) {}
899 };
900 #endif
901 
902 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
903 
908 struct ThumbImageBuffer {
912  const char* buffer;
916  unsigned int length;
920  unsigned int width;
924  unsigned int height;
925  ThumbImageBuffer() : buffer(nullptr), length(0), width(0), height(0) {}
926 };
930 enum ScreenCaptureSourceType {
932  ScreenCaptureSourceType_Unknown = -1,
934  ScreenCaptureSourceType_Window = 0,
936  ScreenCaptureSourceType_Screen = 1,
938  ScreenCaptureSourceType_Custom = 2,
939 };
941 struct ScreenCaptureSourceInfo {
945  ScreenCaptureSourceType type;
949  int64_t sourceId;
953  const char* sourceName;
957  ThumbImageBuffer thumbImage;
961  ThumbImageBuffer iconImage;
965  const char* processPath;
969  const char* sourceTitle;
975  bool primaryMonitor;
976  bool isOccluded;
980  Rectangle position;
981 #if defined(_WIN32)
982 
985  bool minimizeWindow;
992  int64_t sourceDisplayId;
993  ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(0), sourceName(nullptr),
994  processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false), minimizeWindow(false), sourceDisplayId(-2) {}
995 #else
996  ScreenCaptureSourceInfo() : type(ScreenCaptureSourceType_Unknown), sourceId(0), sourceName(nullptr), processPath(nullptr), sourceTitle(nullptr), primaryMonitor(false), isOccluded(false) {}
997 #endif
998 };
1002 class IScreenCaptureSourceList {
1003  protected:
1004  virtual ~IScreenCaptureSourceList(){};
1005 
1006  public:
1012  virtual unsigned int getCount() = 0;
1022  virtual ScreenCaptureSourceInfo getSourceInfo(unsigned int index) = 0;
1029  virtual void release() = 0;
1030 };
1031 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
1032 
1035 struct AdvancedAudioOptions {
1039  Optional<int> audioProcessingChannels;
1040 
1041  AdvancedAudioOptions() {}
1042  ~AdvancedAudioOptions() {}
1043 };
1044 
1045 struct ImageTrackOptions {
1046  const char* imageUrl;
1047  int fps;
1048  VIDEO_MIRROR_MODE_TYPE mirrorMode;
1049  ImageTrackOptions() : imageUrl(NULL), fps(1), mirrorMode(VIDEO_MIRROR_MODE_DISABLED) {}
1050 };
1051 
1060 struct ChannelMediaOptions {
1066  Optional<bool> publishCameraTrack;
1072  Optional<bool> publishSecondaryCameraTrack;
1078  Optional<bool> publishThirdCameraTrack;
1084  Optional<bool> publishFourthCameraTrack;
1090  Optional<bool> publishMicrophoneTrack;
1091 
1097  Optional<bool> publishScreenCaptureAudio;
1098 
1099  #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1100 
1105  Optional<bool> publishScreenCaptureVideo;
1106  #else
1107 
1112  Optional<bool> publishScreenTrack;
1118  Optional<bool> publishSecondaryScreenTrack;
1124  Optional<bool> publishThirdScreenTrack;
1130  Optional<bool> publishFourthScreenTrack;
1131  #endif
1132 
1138  Optional<bool> publishCustomAudioTrack;
1142  Optional<int> publishCustomAudioTrackId;
1148  Optional<bool> publishCustomVideoTrack;
1154  Optional<bool> publishEncodedVideoTrack;
1160  Optional<bool> publishMediaPlayerAudioTrack;
1166  Optional<bool> publishMediaPlayerVideoTrack;
1172  Optional<bool> publishTranscodedVideoTrack;
1178  Optional<bool> publishMixedAudioTrack;
1184  Optional<bool> publishLipSyncTrack;
1192  Optional<bool> publishCameraRelayTrack;
1198  Optional<bool> autoSubscribeAudio;
1204  Optional<bool> autoSubscribeVideo;
1210  Optional<bool> enableAudioRecordingOrPlayout;
1214  Optional<int> publishMediaPlayerId;
1219  Optional<CLIENT_ROLE_TYPE> clientRoleType;
1223  Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel;
1228  Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType;
1233  Optional<CHANNEL_PROFILE_TYPE> channelProfile;
1238  Optional<int> audioDelayMs;
1243  Optional<int> mediaPlayerAudioDelayMs;
1252  Optional<const char*> token;
1260  Optional<bool> enableBuiltInMediaEncryption;
1266  Optional<bool> publishRhythmPlayerTrack;
1274  Optional<bool> isInteractiveAudience;
1279  Optional<video_track_id_t> customVideoTrackId;
1285  Optional<bool> isAudioFilterable;
1286 
1291  Optional<const char*> parameters;
1292 
1293  ChannelMediaOptions() {}
1294  ~ChannelMediaOptions() {}
1295 
1296  void SetAll(const ChannelMediaOptions& change) {
1297 #define SET_FROM(X) SetFrom(&X, change.X)
1298 
1299  SET_FROM(publishCameraTrack);
1300  SET_FROM(publishSecondaryCameraTrack);
1301  SET_FROM(publishThirdCameraTrack);
1302  SET_FROM(publishFourthCameraTrack);
1303  SET_FROM(publishMicrophoneTrack);
1304  SET_FROM(publishScreenCaptureAudio);
1305 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1306  SET_FROM(publishScreenCaptureVideo);
1307 #else
1308  SET_FROM(publishScreenTrack);
1309  SET_FROM(publishSecondaryScreenTrack);
1310  SET_FROM(publishThirdScreenTrack);
1311  SET_FROM(publishFourthScreenTrack);
1312 #endif
1313  SET_FROM(publishTranscodedVideoTrack);
1314  SET_FROM(publishMixedAudioTrack);
1315  SET_FROM(publishLipSyncTrack);
1316  SET_FROM(publishCameraRelayTrack);
1317  SET_FROM(publishCustomAudioTrack);
1318  SET_FROM(publishCustomAudioTrackId);
1319  SET_FROM(publishCustomVideoTrack);
1320  SET_FROM(publishEncodedVideoTrack);
1321  SET_FROM(publishMediaPlayerAudioTrack);
1322  SET_FROM(publishMediaPlayerVideoTrack);
1323  SET_FROM(autoSubscribeAudio);
1324  SET_FROM(autoSubscribeVideo);
1325  SET_FROM(publishMediaPlayerId);
1326  SET_FROM(enableAudioRecordingOrPlayout);
1327  SET_FROM(clientRoleType);
1328  SET_FROM(audienceLatencyLevel);
1329  SET_FROM(defaultVideoStreamType);
1330  SET_FROM(channelProfile);
1331  SET_FROM(audioDelayMs);
1332  SET_FROM(mediaPlayerAudioDelayMs);
1333  SET_FROM(token);
1334  SET_FROM(enableBuiltInMediaEncryption);
1335  SET_FROM(publishRhythmPlayerTrack);
1336  SET_FROM(customVideoTrackId);
1337  SET_FROM(isAudioFilterable);
1338  SET_FROM(isInteractiveAudience);
1339  SET_FROM(parameters);
1340 #undef SET_FROM
1341  }
1342 
1343  bool operator==(const ChannelMediaOptions& o) const {
1344 #define BEGIN_COMPARE() bool b = true
1345 #define ADD_COMPARE(X) b = (b && (X == o.X))
1346 #define END_COMPARE()
1347 
1348  BEGIN_COMPARE();
1349  ADD_COMPARE(publishCameraTrack);
1350  ADD_COMPARE(publishSecondaryCameraTrack);
1351  ADD_COMPARE(publishThirdCameraTrack);
1352  ADD_COMPARE(publishFourthCameraTrack);
1353  ADD_COMPARE(publishMicrophoneTrack);
1354  ADD_COMPARE(publishScreenCaptureAudio);
1355 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1356  ADD_COMPARE(publishScreenCaptureVideo);
1357 #else
1358  ADD_COMPARE(publishScreenTrack);
1359  ADD_COMPARE(publishSecondaryScreenTrack);
1360  ADD_COMPARE(publishThirdScreenTrack);
1361  ADD_COMPARE(publishFourthScreenTrack);
1362 #endif
1363  ADD_COMPARE(publishTranscodedVideoTrack);
1364  ADD_COMPARE(publishMixedAudioTrack);
1365  ADD_COMPARE(publishLipSyncTrack);
1366  ADD_COMPARE(publishCameraRelayTrack);
1367  ADD_COMPARE(publishCustomAudioTrack);
1368  ADD_COMPARE(publishCustomAudioTrackId);
1369  ADD_COMPARE(publishCustomVideoTrack);
1370  ADD_COMPARE(publishEncodedVideoTrack);
1371  ADD_COMPARE(publishMediaPlayerAudioTrack);
1372  ADD_COMPARE(publishMediaPlayerVideoTrack);
1373  ADD_COMPARE(autoSubscribeAudio);
1374  ADD_COMPARE(autoSubscribeVideo);
1375  ADD_COMPARE(publishMediaPlayerId);
1376  ADD_COMPARE(enableAudioRecordingOrPlayout);
1377  ADD_COMPARE(clientRoleType);
1378  ADD_COMPARE(audienceLatencyLevel);
1379  ADD_COMPARE(defaultVideoStreamType);
1380  ADD_COMPARE(channelProfile);
1381  ADD_COMPARE(audioDelayMs);
1382  ADD_COMPARE(mediaPlayerAudioDelayMs);
1383  ADD_COMPARE(token);
1384  ADD_COMPARE(enableBuiltInMediaEncryption);
1385  ADD_COMPARE(publishRhythmPlayerTrack);
1386  ADD_COMPARE(customVideoTrackId);
1387  ADD_COMPARE(isAudioFilterable);
1388  ADD_COMPARE(isInteractiveAudience);
1389  ADD_COMPARE(parameters);
1390  END_COMPARE();
1391 
1392 #undef BEGIN_COMPARE
1393 #undef ADD_COMPARE
1394 #undef END_COMPARE
1395  return b;
1396  }
1397 
1398  ChannelMediaOptions& operator=(const ChannelMediaOptions& replace) {
1399  if (this != &replace) {
1400 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
1401 
1402  REPLACE_BY(publishCameraTrack);
1403  REPLACE_BY(publishSecondaryCameraTrack);
1404  REPLACE_BY(publishThirdCameraTrack);
1405  REPLACE_BY(publishFourthCameraTrack);
1406  REPLACE_BY(publishMicrophoneTrack);
1407  REPLACE_BY(publishScreenCaptureAudio);
1408 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
1409  REPLACE_BY(publishScreenCaptureVideo);
1410 #else
1411  REPLACE_BY(publishScreenTrack);
1412  REPLACE_BY(publishSecondaryScreenTrack);
1413  REPLACE_BY(publishThirdScreenTrack);
1414  REPLACE_BY(publishFourthScreenTrack);
1415 #endif
1416  REPLACE_BY(publishTranscodedVideoTrack);
1417  REPLACE_BY(publishMixedAudioTrack);
1418  REPLACE_BY(publishLipSyncTrack);
1419  REPLACE_BY(publishCameraRelayTrack);
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 unloadAllEffect;
1505  bool stopMicrophoneRecording;
1506 
1507  LeaveChannelOptions() : stopAudioMixing(true), stopAllEffect(true), unloadAllEffect(false), stopMicrophoneRecording(true) {}
1508 };
1509 
1520 class IRtcEngineEventHandler {
1521  public:
1522  virtual ~IRtcEngineEventHandler() {}
1523 
1524  virtual const char* eventHandlerType() const { return "event_handler"; }
1525 
1535  virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1536  (void)channel;
1537  (void)uid;
1538  (void)elapsed;
1539  }
1540 
1551  virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1552  (void)channel;
1553  (void)uid;
1554  (void)elapsed;
1555  }
1556 
1564  virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) {
1565  (void)channel;
1566  (void)uid;
1567  (void)proxyType;
1568  (void)localProxyIp;
1569  (void)elapsed;
1570  }
1571 
1577  virtual void onError(int err, const char* msg) {
1578  (void)err;
1579  (void)msg;
1580  }
1581 
1597  virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated {
1598  (void)uid;
1599  (void)quality;
1600  (void)delay;
1601  (void)lost;
1602  }
1603 
1609  virtual void onLastmileProbeResult(const LastmileProbeResult& result) {
1610  (void)result;
1611  }
1612 
1639  virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber,
1640  int totalVolume) {
1641  (void)speakers;
1642  (void)speakerNumber;
1643  (void)totalVolume;
1644  }
1645 
1654  virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; }
1655 
1663  virtual void onRtcStats(const RtcStats& stats) { (void)stats; }
1664 
1678  virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
1679  (void)deviceId;
1680  (void)deviceType;
1681  (void)deviceState;
1682  }
1683 
1690  virtual void onAudioMixingPositionChanged(int64_t position) {}
1691 
1698  virtual void onAudioMixingFinished() __deprecated {}
1699 
1707  virtual void onAudioEffectFinished(int soundId) {}
1708 
1718  virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
1719  (void)deviceId;
1720  (void)deviceType;
1721  (void)deviceState;
1722  }
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 || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
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 
2752  virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
2753  (void)uid;
2754  (void)userAccount;
2755  }
2756 
2765  virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) {
2766  (void)uid;
2767  (void)info;
2768  }
2769 
2776  virtual void onUserAccountUpdated(uid_t uid, const char* userAccount){
2777  (void)uid;
2778  (void)userAccount;
2779  }
2780 
2788  virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {
2789  (void)uid;
2790  (void)currentEvent;
2791  (void)tracingInfo;
2792  }
2793 
2800  virtual void onLocalVideoTranscoderError(const TranscodingVideoStream& stream, VIDEO_TRANSCODER_ERROR error){
2801  (void)stream;
2802  (void)error;
2803  }
2804 
2811  virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
2812  (void)requestId;
2813  (void)success;
2814  (void)reason;
2815  }
2816 
2826  virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
2827  (void)channel;
2828  (void)uid;
2829  (void)oldState;
2830  (void)newState;
2831  (void)elapseSinceLastState;
2832  }
2833 
2843  virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
2844  (void)channel;
2845  (void)uid;
2846  (void)oldState;
2847  (void)newState;
2848  (void)elapseSinceLastState;
2849  }
2850 
2859  virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
2860  (void)channel;
2861  (void)oldState;
2862  (void)newState;
2863  (void)elapseSinceLastState;
2864  }
2865 
2875  virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
2876  (void)source;
2877  (void)channel;
2878  (void)oldState;
2879  (void)newState;
2880  (void)elapseSinceLastState;
2881  }
2882 
2892  virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
2893  (void)uid;
2894  (void)width;
2895  (void)height;
2896  (void)layoutCount;
2897  (void)layoutlist;
2898  }
2899 
2908  virtual void onAudioMetadataReceived(uid_t uid, const char* metadata, size_t length) {
2909  (void)uid;
2910  (void)metadata;
2911  (void)length;
2912  }
2913 
2923  virtual void onExtensionEventWithContext(const ExtensionContext &context, const char* key, const char* value) {
2924  (void)context;
2925  (void)key;
2926  (void)value;
2927  }
2928 
2936  virtual void onExtensionStartedWithContext(const ExtensionContext &context) {
2937  (void)context;
2938  }
2939 
2947  virtual void onExtensionStoppedWithContext(const ExtensionContext &context) {
2948  (void)context;
2949  }
2950 
2961  virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char* message) {
2962  (void)context;
2963  (void)error;
2964  (void)message;
2965  }
2966 
2973  virtual void onSetRtmFlagResult(int code) {
2974  (void)code;
2975  }
2976 };
2977 
2981 class IVideoDeviceCollection {
2982  public:
2983  virtual ~IVideoDeviceCollection() {}
2984 
2990  virtual int getCount() = 0;
2991 
3001  virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3002 
3013  virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
3014  char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3015 
3019  virtual void release() = 0;
3020 };
3021 
3025 class IVideoDeviceManager {
3026  public:
3027  virtual ~IVideoDeviceManager() {}
3039  virtual IVideoDeviceCollection* enumerateVideoDevices() = 0;
3040 
3051  virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3052 
3061  virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3062 
3063 #if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__)) || \
3064  (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
3065 
3082  virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;
3083 
3101  virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;
3102 #endif
3103 
3116  virtual int startDeviceTest(view_t hwnd) = 0;
3117 
3124  virtual int stopDeviceTest() = 0;
3125 
3129  virtual void release() = 0;
3130 };
3131 
3137 class IVideoEffectObject : public RefCountInterface {
3138  public:
3139  virtual ~IVideoEffectObject() {}
3140 
3146  enum class VIDEO_EFFECT_NODE_ID : uint32_t {
3148  BEAUTY = 1U << 0,
3150  STYLE_MAKEUP = 1U << 1,
3152  FILTER = 1U << 2,
3154  STICKER = 1U << 3,
3155  };
3156 
3162  enum VIDEO_EFFECT_ACTION {
3164  SAVE = 1,
3166  RESET = 2,
3167  };
3168 
3193  virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char* templateName) = 0;
3194 
3206  virtual int removeVideoEffect(uint32_t nodeId) = 0;
3207 
3220  virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId) = 0;
3221 
3235  virtual int setVideoEffectFloatParam(const char* option, const char* key, float param) = 0;
3236 
3250  virtual int setVideoEffectIntParam(const char* option, const char* key, int param) = 0;
3251 
3267  virtual int setVideoEffectBoolParam(const char* option, const char* key, bool param) = 0;
3268 
3281  virtual float getVideoEffectFloatParam(const char* option, const char* key) = 0;
3282 
3295  virtual int getVideoEffectIntParam(const char* option, const char* key) = 0;
3296 
3309  virtual bool getVideoEffectBoolParam(const char* option, const char* key) = 0;
3310 
3311 };
3312 
3316 struct RtcEngineContext {
3320  IRtcEngineEventHandler* eventHandler;
3327  const char* appId;
3333  void* context;
3337  CHANNEL_PROFILE_TYPE channelProfile;
3338 
3342  const char* license;
3343 
3351  AUDIO_SCENARIO_TYPE audioScenario;
3360  unsigned int areaCode;
3361 
3377  commons::LogConfig logConfig;
3378 
3382  Optional<THREAD_PRIORITY_TYPE> threadPriority;
3383 
3391  bool useExternalEglContext;
3392 
3398  bool domainLimit;
3399 
3405  bool autoRegisterAgoraExtensions;
3406 
3407  RtcEngineContext()
3408  : eventHandler(NULL), appId(NULL), context(NULL), channelProfile(CHANNEL_PROFILE_LIVE_BROADCASTING),
3409  license(NULL), audioScenario(AUDIO_SCENARIO_DEFAULT), areaCode(AREA_CODE_GLOB),
3410  logConfig(), useExternalEglContext(false), domainLimit(false), autoRegisterAgoraExtensions(true) {}
3411 };
3412 
3415 class IMetadataObserver {
3416 public:
3417  virtual ~IMetadataObserver() {}
3418 
3423  enum METADATA_TYPE
3424  {
3427  UNKNOWN_METADATA = -1,
3430  VIDEO_METADATA = 0,
3431  };
3435  enum MAX_METADATA_SIZE_TYPE
3436  {
3437  INVALID_METADATA_SIZE_IN_BYTE = -1,
3438  DEFAULT_METADATA_SIZE_IN_BYTE = 512,
3439  MAX_METADATA_SIZE_IN_BYTE = 1024
3440  };
3441 
3444  struct Metadata
3445  {
3448  const char* channelId;
3453  unsigned int uid;
3456  unsigned int size;
3459  unsigned char *buffer;
3463  long long timeStampMs;
3464 
3465  Metadata() : channelId(NULL), uid(0), size(0), buffer(NULL), timeStampMs(0) {}
3466  };
3467 
3478  virtual int getMaxMetadataSize() { return DEFAULT_METADATA_SIZE_IN_BYTE; }
3479 
3490  virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0;
3491 
3499  virtual void onMetadataReceived(const Metadata& metadata) = 0;
3500 };
3501 
3502 // The reason codes for media streaming
3503 // GENERATED_JAVA_ENUM_PACKAGE: io.agora.streaming
3504 enum DIRECT_CDN_STREAMING_REASON {
3505  // No error occurs.
3506  DIRECT_CDN_STREAMING_REASON_OK = 0,
3507  // A general error occurs (no specified reason).
3508  DIRECT_CDN_STREAMING_REASON_FAILED = 1,
3509  // Audio publication error.
3510  DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION = 2,
3511  // Video publication error.
3512  DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION = 3,
3513 
3514  DIRECT_CDN_STREAMING_REASON_NET_CONNECT = 4,
3515  // Already exist stream name.
3516  DIRECT_CDN_STREAMING_REASON_BAD_NAME = 5,
3517 };
3518 
3519 // The connection state of media streaming
3520 // GENERATED_JAVA_ENUM_PACKAGE: io.agora.streaming
3521 enum DIRECT_CDN_STREAMING_STATE {
3522 
3523  DIRECT_CDN_STREAMING_STATE_IDLE = 0,
3524 
3525  DIRECT_CDN_STREAMING_STATE_RUNNING = 1,
3526 
3527  DIRECT_CDN_STREAMING_STATE_STOPPED = 2,
3528 
3529  DIRECT_CDN_STREAMING_STATE_FAILED = 3,
3530 
3531  DIRECT_CDN_STREAMING_STATE_RECOVERING = 4,
3532 };
3533 
3537 struct DirectCdnStreamingStats {
3541  int videoWidth;
3542 
3546  int videoHeight;
3547 
3551  int fps;
3552 
3556  int videoBitrate;
3557 
3561  int audioBitrate;
3562 };
3563 
3568 class IDirectCdnStreamingEventHandler {
3569  public:
3570  virtual ~IDirectCdnStreamingEventHandler() {}
3571 
3578  virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char* message) {
3579  (void)state;
3580  (void)reason;
3581  (void)message;
3582  };
3583 
3584  virtual void onDirectCdnStreamingStats(const DirectCdnStreamingStats& stats) {
3585  (void)stats;
3586  };
3587 };
3588 
3592 struct DirectCdnStreamingMediaOptions {
3598  Optional<bool> publishCameraTrack;
3604  Optional<bool> publishMicrophoneTrack;
3610  Optional<bool> publishCustomAudioTrack;
3616  Optional<bool> publishCustomVideoTrack;
3622  Optional<bool> publishMediaPlayerAudioTrack;
3627  Optional<int> publishMediaPlayerId;
3632  Optional<video_track_id_t> customVideoTrackId;
3633 
3634  DirectCdnStreamingMediaOptions() {}
3635  ~DirectCdnStreamingMediaOptions() {}
3636 
3637  void SetAll(const DirectCdnStreamingMediaOptions& change) {
3638 #define SET_FROM(X) SetFrom(&X, change.X)
3639  SET_FROM(publishCameraTrack);
3640  SET_FROM(publishMicrophoneTrack);
3641  SET_FROM(publishCustomAudioTrack);
3642  SET_FROM(publishCustomVideoTrack);
3643  SET_FROM(publishMediaPlayerAudioTrack);
3644  SET_FROM(publishMediaPlayerId);
3645  SET_FROM(customVideoTrackId);
3646 #undef SET_FROM
3647  }
3648 
3649  bool operator==(const DirectCdnStreamingMediaOptions& o) const {
3650 #define BEGIN_COMPARE() bool b = true
3651 #define ADD_COMPARE(X) b = (b && (X == o.X))
3652 #define END_COMPARE()
3653 
3654  BEGIN_COMPARE();
3655  ADD_COMPARE(publishCameraTrack);
3656  ADD_COMPARE(publishMicrophoneTrack);
3657  ADD_COMPARE(publishCustomAudioTrack);
3658  ADD_COMPARE(publishCustomVideoTrack);
3659  ADD_COMPARE(publishMediaPlayerAudioTrack);
3660  ADD_COMPARE(customVideoTrackId);
3661  ADD_COMPARE(publishMediaPlayerId);
3662  END_COMPARE();
3663 
3664 #undef BEGIN_COMPARE
3665 #undef ADD_COMPARE
3666 #undef END_COMPARE
3667  return b;
3668  }
3669 
3670  DirectCdnStreamingMediaOptions& operator=(const DirectCdnStreamingMediaOptions& replace) {
3671  if (this != &replace) {
3672 #define REPLACE_BY(X) ReplaceBy(&X, replace.X)
3673 
3674  REPLACE_BY(publishCameraTrack);
3675  REPLACE_BY(publishMicrophoneTrack);
3676  REPLACE_BY(publishCustomAudioTrack);
3677  REPLACE_BY(publishCustomVideoTrack);
3678  REPLACE_BY(publishMediaPlayerAudioTrack);
3679  REPLACE_BY(customVideoTrackId);
3680  REPLACE_BY(publishMediaPlayerId);
3681 #undef REPLACE_BY
3682  }
3683  return *this;
3684  }
3685 };
3686 
3690 struct ExtensionInfo {
3694  agora::media::MEDIA_SOURCE_TYPE mediaSourceType;
3695 
3701  uid_t remoteUid;
3702 
3714  const char* channelId;
3715 
3719  uid_t localUid;
3720 
3721  ExtensionInfo() : mediaSourceType(agora::media::UNKNOWN_MEDIA_SOURCE), remoteUid(0), channelId(NULL), localUid(0) {}
3722 };
3723 
3724 class IMediaPlayer;
3725 class IMediaRecorder;
3726 
3732 using RtcEngineReleaseCallback = void(*)();
3733 
3740 class IRtcEngine : public agora::base::IEngineBase {
3741  public:
3766  AGORA_CPP_API static void release(RtcEngineReleaseCallback callback = nullptr);
3767 
3784  virtual int initialize(const RtcEngineContext& context) = 0;
3785 
3795  virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0;
3796 
3797 
3803  virtual const char* getVersion(int* build) = 0;
3804 
3810  virtual const char* getErrorDescription(int code) = 0;
3811 
3821  virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
3822 
3832  virtual int queryDeviceScore() = 0;
3833 
3871  virtual int preloadChannel(const char* token, const char* channelId, uid_t uid) = 0;
3872 
3912  virtual int preloadChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
3913 
3931  virtual int updatePreloadChannelToken(const char* token) = 0;
3932 
3992  virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) = 0;
3993 
4061  virtual int joinChannel(const char* token, const char* channelId, uid_t uid, const ChannelMediaOptions& options) = 0;
4062 
4071  virtual int updateChannelMediaOptions(const ChannelMediaOptions& options) = 0;
4072 
4090  virtual int leaveChannel() = 0;
4091 
4111  virtual int leaveChannel(const LeaveChannelOptions& options) = 0;
4112 
4129  virtual int renewToken(const char* token) = 0;
4130 
4150  virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0;
4151 
4175  virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0;
4176 
4199  virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0;
4200 
4209  virtual int startEchoTest(const EchoTestConfiguration& config) = 0;
4210 
4217  virtual int stopEchoTest() = 0;
4218 
4219 #if defined(__APPLE__) && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION))
4220 
4229  virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0;
4230 #endif
4231 
4246  virtual int enableVideo() = 0;
4247 
4257  virtual int disableVideo() = 0;
4258 
4270  virtual int startPreview() = 0;
4271 
4279  virtual int startPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
4280 
4288  virtual int stopPreview() = 0;
4289 
4297  virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
4298 
4332  virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;
4333 
4335  virtual int stopLastmileProbeTest() = 0;
4336 
4353  virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration& config) = 0;
4354 
4364  virtual int setBeautyEffectOptions(bool enabled, const BeautyOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4374  virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4381  virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4382 
4389  virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4390 
4398  virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4399 
4424  virtual int setFilterEffectOptions(bool enabled, const FilterEffectOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4425 
4426 
4439  virtual agora_refptr<IVideoEffectObject> createVideoEffectObject(const char* bundlePath, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4440 
4441 
4453  virtual int destroyVideoEffectObject(agora_refptr<IVideoEffectObject> videoEffectObject) = 0;
4454 
4481  virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4508  virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4535  virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions& options, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4536 
4569  virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type = agora::media::PRIMARY_CAMERA_SOURCE) = 0;
4570 
4593  virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0;
4594 
4611  virtual int setupLocalVideo(const VideoCanvas& canvas) = 0;
4612 
4631  virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType) = 0;
4632 
4651  virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference) = 0;
4652 
4666  virtual int enableAudio() = 0;
4667 
4679  virtual int disableAudio() = 0;
4680 
4702  virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated = 0;
4703 
4719  virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile) = 0;
4728  virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
4751  virtual int enableLocalAudio(bool enabled) = 0;
4752 
4778  virtual int muteLocalAudioStream(bool mute) = 0;
4779 
4821  virtual int muteAllRemoteAudioStreams(bool mute) = 0;
4822 
4839  virtual int muteRemoteAudioStream(uid_t uid, bool mute) = 0;
4840 
4852  virtual int muteLocalVideoStream(bool mute) = 0;
4853 
4878  virtual int enableLocalVideo(bool enabled) = 0;
4879 
4919  virtual int muteAllRemoteVideoStreams(bool mute) = 0;
4920 
4930  virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType) = 0;
4931 
4948  virtual int muteRemoteVideoStream(uid_t uid, bool mute) = 0;
4949 
4967  virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType) = 0;
4968 
4979  virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options) = 0;
4980 
4995  virtual int setSubscribeAudioBlocklist(uid_t* uidList, int uidNumber) = 0;
4996 
5013  virtual int setSubscribeAudioAllowlist(uid_t* uidList, int uidNumber) = 0;
5014 
5029  virtual int setSubscribeVideoBlocklist(uid_t* uidList, int uidNumber) = 0;
5030 
5047  virtual int setSubscribeVideoAllowlist(uid_t* uidList, int uidNumber) = 0;
5048 
5075  virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad) = 0;
5076 
5097  virtual int startAudioRecording(const char* filePath,
5098  AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
5120  virtual int startAudioRecording(const char* filePath,
5121  int sampleRate,
5122  AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
5123 
5142  virtual int startAudioRecording(const AudioRecordingConfiguration& config) = 0;
5143 
5149  virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig& config, IAudioEncodedFrameObserver *observer) = 0;
5150 
5159  virtual int stopAudioRecording() = 0;
5160 
5171  virtual agora_refptr<IMediaPlayer> createMediaPlayer() = 0;
5172 
5184  virtual int destroyMediaPlayer(agora_refptr<IMediaPlayer> media_player) = 0;
5185 
5196  virtual agora_refptr<IMediaRecorder> createMediaRecorder(const RecorderStreamInfo& info) = 0;
5197 
5207  virtual int destroyMediaRecorder(agora_refptr<IMediaRecorder> mediaRecorder) = 0;
5208 
5250  virtual int startAudioMixing(const char* filePath, bool loopback, int cycle) = 0;
5251 
5295  virtual int startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) = 0;
5296 
5305  virtual int stopAudioMixing() = 0;
5306 
5315  virtual int pauseAudioMixing() = 0;
5316 
5325  virtual int resumeAudioMixing() = 0;
5326 
5335  virtual int selectAudioTrack(int index) = 0;
5344  virtual int getAudioTrackCount() = 0;
5345 
5360  virtual int adjustAudioMixingVolume(int volume) = 0;
5361 
5369  virtual int adjustAudioMixingPublishVolume(int volume) = 0;
5370 
5378  virtual int getAudioMixingPublishVolume() = 0;
5379 
5387  virtual int adjustAudioMixingPlayoutVolume(int volume) = 0;
5388 
5396  virtual int getAudioMixingPlayoutVolume() = 0;
5397 
5406  virtual int getAudioMixingDuration() = 0;
5407 
5417  virtual int getAudioMixingCurrentPosition() = 0;
5418 
5428  virtual int setAudioMixingPosition(int pos /*in ms*/) = 0;
5429 
5440  virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode) = 0;
5441 
5458  virtual int setAudioMixingPitch(int pitch) = 0;
5459 
5475  virtual int setAudioMixingPlaybackSpeed(int speed) = 0;
5476 
5484  virtual int getEffectsVolume() = 0;
5494  virtual int setEffectsVolume(int volume) = 0;
5522  virtual int preloadEffect(int soundId, const char* filePath, int startPos = 0) = 0;
5568  virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false, int startPos = 0) = 0;
5599  virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish = false) = 0;
5600 
5610  virtual int getVolumeOfEffect(int soundId) = 0;
5611 
5622  virtual int setVolumeOfEffect(int soundId, int volume) = 0;
5631  virtual int pauseEffect(int soundId) = 0;
5638  virtual int pauseAllEffects() = 0;
5647  virtual int resumeEffect(int soundId) = 0;
5654  virtual int resumeAllEffects() = 0;
5663  virtual int stopEffect(int soundId) = 0;
5670  virtual int stopAllEffects() = 0;
5679  virtual int unloadEffect(int soundId) = 0;
5686  virtual int unloadAllEffects() = 0;
5705  virtual int getEffectDuration(const char* filePath) = 0;
5722  virtual int setEffectPosition(int soundId, int pos) = 0;
5737  virtual int getEffectCurrentPosition(int soundId) = 0;
5750  virtual int enableSoundPositionIndication(bool enabled) = 0;
5751 
5772  virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0;
5773 
5783  virtual int enableSpatialAudio(bool enabled) = 0;
5784 
5794  virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams& params) = 0;
5795 
5833  virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset) = 0;
5834 
5872  virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset) = 0;
5873 
5910  virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset) = 0;
5911 
5987  virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0;
5988 
6031  virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset,
6032  int param1, int param2) = 0;
6033 
6046  virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset,
6047  int param1, int param2) = 0;
6048 
6059  virtual int setLocalVoicePitch(double pitch) = 0;
6060 
6071  virtual int setLocalVoiceFormant(double formantRatio) = 0;
6072 
6084  virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0;
6085 
6094  virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0;
6106  virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset) = 0;
6107 
6117  virtual int setHeadphoneEQParameters(int lowGain, int highGain) = 0;
6118 
6130  virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type) = 0;
6131 
6147  virtual int setLogFile(const char* filePath) = 0;
6148 
6171  virtual int setLogFilter(unsigned int filter) = 0;
6172 
6189  virtual int setLogLevel(commons::LOG_LEVEL level) = 0;
6190 
6205  virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0;
6206 
6215  virtual int uploadLogFile(agora::util::AString& requestId) = 0;
6216 
6232  virtual int writeLog(commons::LOG_LEVEL level, const char* fmt, ...) = 0;
6233 
6252  virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6253 
6274  virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode,
6275  VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
6286  virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps) = 0;
6295  virtual int setRemoteRenderTargetFps(int targetFps) = 0;
6296  // The following APIs are either deprecated and going to deleted.
6297 
6315  virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) __deprecated = 0;
6316 
6328  virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated = 0;
6329 
6344  virtual int enableDualStreamMode(bool enabled) __deprecated = 0;
6345 
6362  virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) __deprecated = 0;
6363 
6364 
6378  virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0;
6379 
6395  virtual int setSimulcastConfig(const SimulcastConfig& simulcastConfig) = 0;
6396 
6410  virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig& streamConfig) = 0;
6411 
6426  virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled) = 0;
6427 
6446  virtual int setRecordingAudioFrameParameters(int sampleRate, int channel,
6447  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6448  int samplesPerCall) = 0;
6449 
6469  virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel,
6470  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6471  int samplesPerCall) = 0;
6472 
6488  virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall) = 0;
6489 
6509  virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel,
6510  RAW_AUDIO_FRAME_OP_MODE_TYPE mode,
6511  int samplesPerCall) = 0;
6512 
6528  virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0;
6529 
6540  virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
6548  virtual int disableAudioSpectrumMonitor() = 0;
6549 
6564  virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
6574  virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer) = 0;
6575 
6589  virtual int adjustRecordingSignalVolume(int volume) = 0;
6590 
6602  virtual int muteRecordingSignal(bool mute) = 0;
6603 
6617  virtual int adjustPlaybackSignalVolume(int volume) = 0;
6618 
6619  /*
6620  * Adjust the playback volume of the user specified by uid.
6621  *
6622  * You can call this method to adjust the playback volume of the user specified by uid
6623  * in call. If you want to adjust playback volume of the multi user, you can call this
6624  * this method multi times.
6625  *
6626  * @note
6627  * Please call this method after join channel.
6628  * This method adjust the playback volume of specified user.
6629  *
6630  * @param uid Remote user ID.
6631  * @param volume The playback volume of the specified remote user. The value ranges between 0 and 400, including the following:
6632  * 0: Mute.
6633  * 100: (Default) Original volume.
6634  * 400: Four times the original volume with signal-clipping protection.
6635  * @return
6636  * - 0: Success.
6637  * - < 0: Failure.
6638  */
6639  virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
6640 
6662  virtual int setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0;
6663 
6679  virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option) = 0;
6680 
6694  virtual int setHighPriorityUserList(uid_t* uidList, int uidNum, STREAM_FALLBACK_OPTIONS option) = 0;
6695 
6716  virtual int enableExtension(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, bool enable = true) = 0;
6717 
6731  virtual int setExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, const char* value) = 0;
6732 
6747  virtual int getExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, char* value, int buf_len) = 0;
6748 
6767  virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0;
6768 
6769 
6782  virtual int adjustLoopbackSignalVolume(int volume) = 0;
6783 
6790  virtual int getLoopbackRecordingVolume() = 0;
6791 
6803  virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0;
6804 
6815  virtual int setInEarMonitoringVolume(int volume) = 0;
6816 
6817 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
6818  virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
6819 #endif
6820 
6832  virtual int setExtensionProviderProperty(const char* provider, const char* key, const char* value) = 0;
6833 
6846  virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6847 
6868  virtual int enableExtension(const char* provider, const char* extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6869 
6882  virtual int setExtensionProperty(
6883  const char* provider, const char* extension,
6884  const char* key, const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6885 
6899  virtual int getExtensionProperty(
6900  const char* provider, const char* extension,
6901  const char* key, char* value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
6902 
6914  virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration& config) = 0;
6915 
6923  virtual video_track_id_t createCustomVideoTrack() = 0;
6924 
6932  virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions& sender_option) = 0;
6933 
6942  virtual int destroyCustomVideoTrack(video_track_id_t video_track_id) = 0;
6943 
6952  virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id) = 0;
6953 
6954 
6955 #if defined(__ANDROID__) || (defined(__APPLE__) && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
6956 
6965  virtual int switchCamera() = 0;
6966 
6974  virtual bool isCameraZoomSupported() = 0;
6975 
6983  virtual bool isCameraFaceDetectSupported() = 0;
6984 
6992  virtual bool isCameraTorchSupported() = 0;
6993 
7001  virtual bool isCameraFocusSupported() = 0;
7002 
7010  virtual bool isCameraAutoFocusFaceModeSupported() = 0;
7011 
7021  virtual int setCameraZoomFactor(float factor) = 0;
7022 
7031  virtual int enableFaceDetection(bool enabled) = 0;
7032 
7037  virtual float getCameraMaxZoomFactor() = 0;
7038 
7048  virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
7049 
7057  virtual int setCameraTorchOn(bool isOn) = 0;
7058 
7066  virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
7067 
7079  virtual bool isCameraExposurePositionSupported() = 0;
7080 
7096  virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
7097 
7110  virtual bool isCameraExposureSupported() = 0;
7111 
7122  virtual int setCameraExposureFactor(float factor) = 0;
7123 
7124 #if defined(__APPLE__)
7125 
7132  virtual bool isCameraAutoExposureFaceModeSupported() = 0;
7133 
7134 
7142  virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
7143 
7149  virtual int setCameraStabilizationMode(CAMERA_STABILIZATION_MODE mode) = 0;
7150 #endif
7151 
7185  virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0;
7186 
7213  virtual int setEnableSpeakerphone(bool speakerOn) = 0;
7214 
7222  virtual bool isSpeakerphoneEnabled() = 0;
7223 
7230  virtual int setRouteInCommunicationMode(int route) = 0;
7231 
7232 #endif // __ANDROID__ || (__APPLE__ && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
7233 
7234 #if defined(__APPLE__)
7235 
7242  virtual bool isCameraCenterStageSupported() = 0;
7243 
7252  virtual int enableCameraCenterStage(bool enabled) = 0;
7253 #endif
7254 
7255 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
7256 
7266  virtual IScreenCaptureSourceList* getScreenCaptureSources(const SIZE& thumbSize, const SIZE& iconSize, const bool includeScreen) = 0;
7267 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7268 #if (defined(__APPLE__) && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
7269 
7293  virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction) = 0;
7294 #endif // __APPLE__ && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION))
7295 
7296 #if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7297 
7318  virtual int startScreenCaptureByDisplayId(int64_t displayId, const Rectangle& regionRect,
7319  const ScreenCaptureParameters& captureParams) = 0;
7320 
7321 #endif // __APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE
7322 
7323 #if defined(_WIN32)
7324 
7347  virtual int startScreenCaptureByScreenRect(const Rectangle& screenRect,
7348  const Rectangle& regionRect,
7349  const ScreenCaptureParameters& captureParams) __deprecated = 0;
7350 #endif
7351 
7352 #if defined(__ANDROID__)
7353 
7359  virtual int getAudioDeviceInfo(DeviceInfo& deviceInfo) = 0;
7360 #endif // __ANDROID__
7361 
7362 #if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
7363 
7381  virtual int startScreenCaptureByWindowId(int64_t windowId, const Rectangle& regionRect,
7382  const ScreenCaptureParameters& captureParams) = 0;
7383 
7399  virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint) = 0;
7400 
7417  virtual int updateScreenCaptureRegion(const Rectangle& regionRect) = 0;
7418 
7432  virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0;
7433 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
7434 
7435 #if defined(__ANDROID__) || (defined(__APPLE__) && (TARGET_OS_IOS || (defined(TARGET_OS_VISION) && TARGET_OS_VISION)))
7436 
7445  virtual int startScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
7446 
7456  virtual int updateScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
7457 
7469  virtual int queryScreenCaptureCapability() = 0;
7470 
7482  virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo* focalLengthInfos, int& size) = 0;
7483 
7484 #if defined(__ANDROID__)
7485 
7501  virtual int setExternalMediaProjection(void* mediaProjection) = 0;
7502 #endif
7503 #endif
7504 
7505 #if defined(_WIN32) || defined(__APPLE__) || defined(__ANDROID__)
7506 
7522  virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
7523 
7531  virtual int stopScreenCapture() = 0;
7532 #endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC) || __ANDROID__
7533 
7550  virtual int getCallId(agora::util::AString& callId) = 0;
7551 
7566  virtual int rate(const char* callId, int rating, const char* description) = 0; // 0~10
7567 
7581  virtual int complain(const char* callId, const char* description) = 0;
7582 
7603  virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0;
7604 
7626  virtual int startRtmpStreamWithTranscoding(const char* url, const LiveTranscoding& transcoding) = 0;
7627 
7637  virtual int updateRtmpTranscoding(const LiveTranscoding& transcoding) = 0;
7638 
7639  virtual int startLocalVideoTranscoder(const LocalTranscoderConfiguration& config) = 0;
7640  virtual int updateLocalTranscoderConfiguration(const LocalTranscoderConfiguration& config) = 0;
7641 
7660  virtual int stopRtmpStream(const char* url) = 0;
7661 
7662  virtual int stopLocalVideoTranscoder() = 0;
7663 
7673  virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration& config) = 0;
7674 
7684  virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration& config) = 0;
7685 
7695  virtual int stopLocalAudioMixer() = 0;
7696 
7706  virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration& config) = 0;
7707 
7718  virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
7730  virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
7742  virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation) = 0;
7743 
7753  virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration& config) = 0;
7754 
7765  virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
7766 
7771  virtual CONNECTION_STATE_TYPE getConnectionState() = 0;
7772 
7773  // The following APIs are not implemented yet.
7774  virtual bool registerEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
7775  virtual bool unregisterEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
7776  virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0;
7777 
7789  virtual int registerPacketObserver(IPacketObserver* observer) = 0;
7790 
7791 
7813  virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;
7814 
7846  virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
7847 
7857  virtual int createDataStream(int* streamId, const DataStreamConfig& config) = 0;
7858 
7889  virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
7890 
7912  virtual int addVideoWatermark(const RtcImage& watermark) __deprecated = 0;
7913 
7939  virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0;
7940 
7948  virtual int clearVideoWatermarks() = 0;
7949 
7950  // The following APIs are either deprecated and going to deleted.
7951 
7960  virtual int pauseAudio() __deprecated = 0;
7969  virtual int resumeAudio() __deprecated = 0;
7970 
7988  virtual int enableWebSdkInteroperability(bool enabled) __deprecated = 0;
7989 
7999  virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0;
8000 
8022  virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0;
8023 
8032  virtual int unregisterMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0;
8033 
8042  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;
8043 
8047  virtual int stopAudioFrameDump(const char* channel_id, uid_t uid, const char* location) = 0;
8048 
8064  virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode) = 0;
8065 
8097  virtual int registerLocalUserAccount(const char* appId, const char* userAccount) = 0;
8098 
8129  virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
8130 
8162  virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount, const ChannelMediaOptions& options) = 0;
8163 
8196  virtual int joinChannelWithUserAccountEx(const char* token, const char* channelId,
8197  const char* userAccount, const ChannelMediaOptions& options,
8198  IRtcEngineEventHandler* eventHandler) = 0;
8199 
8217  virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo) = 0;
8218 
8236  virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo) = 0;
8237 
8272  virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration) = 0;
8273 
8302  virtual int stopChannelMediaRelay() = 0;
8303 
8313  virtual int pauseAllChannelMediaRelay() = 0;
8314 
8324  virtual int resumeAllChannelMediaRelay() = 0;
8325 
8338  virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile) = 0;
8339 
8354  virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration& config) = 0;
8355 
8369  virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler* eventHandler,
8370  const char* publishUrl, const DirectCdnStreamingMediaOptions& options) = 0;
8371 
8381  virtual int stopDirectCdnStreaming() = 0;
8382 
8394  virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions& options) = 0;
8395 
8406  virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
8407 
8414  virtual int stopRhythmPlayer() = 0;
8415 
8424  virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig& config) = 0;
8425 
8455  virtual int takeSnapshot(uid_t uid, const char* filePath) = 0;
8456 
8481  virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) = 0;
8482 
8492  virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0;
8493  /*
8494  * Adjust the custom audio publish volume by track id.
8495  * @param trackId custom audio track id.
8496  * @param volume The volume, range is [0,100]:
8497  * 0: mute, 100: The original volume
8498  * @return
8499  * - 0: Success.
8500  * - < 0: Failure.
8501  */
8502  virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume) = 0;
8503 
8504  /*
8505  * Adjust the custom audio playout volume by track id.
8506  * @param trackId custom audio track id.
8507  * @param volume The volume, range is [0,100]:
8508  * 0: mute, 100: The original volume
8509  * @return
8510  * - 0: Success.
8511  * - < 0: Failure.
8512  */
8513  virtual int adjustCustomAudioPlayoutVolume(track_id_t trackId, int volume) = 0;
8514 
8544  virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0;
8553  virtual int setLocalAccessPoint(const LocalAccessPointConfiguration& config) = 0;
8554 
8562  virtual int setAdvancedAudioOptions(AdvancedAudioOptions& options, int sourceType = 0) = 0;
8563 
8574  virtual int setAVSyncSource(const char* channelId, uid_t uid) = 0;
8575 
8582  virtual int enableVideoImageSource(bool enable, const ImageTrackOptions& options) = 0;
8583 
8584  /*
8585  * Get monotonic time in ms which can be used by capture time,
8586  * typical scenario is as follows:
8587  *
8588  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8589  * | // custom audio/video base capture time, e.g. the first audio/video capture time. |
8590  * | int64_t custom_capture_time_base; |
8591  * | |
8592  * | int64_t agora_monotonic_time = getCurrentMonotonicTimeInMs(); |
8593  * | |
8594  * | // offset is fixed once calculated in the begining. |
8595  * | const int64_t offset = agora_monotonic_time - custom_capture_time_base; |
8596  * | |
8597  * | // realtime_custom_audio/video_capture_time is the origin capture time that customer provided.|
8598  * | // actual_audio/video_capture_time is the actual capture time transfered to sdk. |
8599  * | int64_t actual_audio_capture_time = realtime_custom_audio_capture_time + offset; |
8600  * | int64_t actual_video_capture_time = realtime_custom_video_capture_time + offset; |
8601  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8602  *
8603  * @return
8604  * - >= 0: Success.
8605  * - < 0: Failure.
8606  */
8607  virtual int64_t getCurrentMonotonicTimeInMs() = 0;
8608 
8624  virtual int enableWirelessAccelerate(bool enabled) = 0;
8625 
8640  virtual int getNetworkType() = 0;
8641 
8650  virtual int setParameters(const char* parameters) = 0;
8651 
8666  virtual int startMediaRenderingTracing() = 0;
8667 
8681  virtual int enableInstantMediaRendering() = 0;
8682 
8686  virtual uint64_t getNtpWallTimeInMs() = 0;
8687 
8696  virtual bool isFeatureAvailableOnDevice(FeatureType type) = 0;
8697 
8708  virtual int sendAudioMetadata(const char* metadata, size_t length) = 0;
8709 
8719  virtual int queryHDRCapability(VIDEO_MODULE_TYPE videoModule, HDR_CAPABILITY& capability) = 0;
8720 };
8721 
8722 // The following types are either deprecated or not implmented yet.
8723 enum QUALITY_REPORT_FORMAT_TYPE {
8726  QUALITY_REPORT_JSON = 0,
8729  QUALITY_REPORT_HTML = 1,
8730 };
8731 
8733 enum MEDIA_DEVICE_STATE_TYPE {
8736  MEDIA_DEVICE_STATE_IDLE = 0,
8739  MEDIA_DEVICE_STATE_ACTIVE = 1,
8742  MEDIA_DEVICE_STATE_DISABLED = 2,
8743 
8746  MEDIA_DEVICE_STATE_PLUGGED_IN = 3,
8747 
8750  MEDIA_DEVICE_STATE_NOT_PRESENT = 4,
8753  MEDIA_DEVICE_STATE_UNPLUGGED = 8
8754 };
8755 
8756 enum VIDEO_PROFILE_TYPE { // res fps
8758  VIDEO_PROFILE_LANDSCAPE_120P = 0, // 160x120 15
8760  VIDEO_PROFILE_LANDSCAPE_120P_3 = 2, // 120x120 15
8762  VIDEO_PROFILE_LANDSCAPE_180P = 10, // 320x180 15
8764  VIDEO_PROFILE_LANDSCAPE_180P_3 = 12, // 180x180 15
8766  VIDEO_PROFILE_LANDSCAPE_180P_4 = 13, // 240x180 15
8768  VIDEO_PROFILE_LANDSCAPE_240P = 20, // 320x240 15
8770  VIDEO_PROFILE_LANDSCAPE_240P_3 = 22, // 240x240 15
8772  VIDEO_PROFILE_LANDSCAPE_240P_4 = 23, // 424x240 15
8774  VIDEO_PROFILE_LANDSCAPE_360P = 30, // 640x360 15
8776  VIDEO_PROFILE_LANDSCAPE_360P_3 = 32, // 360x360 15
8778  VIDEO_PROFILE_LANDSCAPE_360P_4 = 33, // 640x360 30
8780  VIDEO_PROFILE_LANDSCAPE_360P_6 = 35, // 360x360 30
8782  VIDEO_PROFILE_LANDSCAPE_360P_7 = 36, // 480x360 15
8784  VIDEO_PROFILE_LANDSCAPE_360P_8 = 37, // 480x360 30
8786  VIDEO_PROFILE_LANDSCAPE_360P_9 = 38, // 640x360 15
8788  VIDEO_PROFILE_LANDSCAPE_360P_10 = 39, // 640x360 24
8790  VIDEO_PROFILE_LANDSCAPE_360P_11 = 100, // 640x360 24
8792  VIDEO_PROFILE_LANDSCAPE_480P = 40, // 640x480 15
8794  VIDEO_PROFILE_LANDSCAPE_480P_3 = 42, // 480x480 15
8796  VIDEO_PROFILE_LANDSCAPE_480P_4 = 43, // 640x480 30
8798  VIDEO_PROFILE_LANDSCAPE_480P_6 = 45, // 480x480 30
8800  VIDEO_PROFILE_LANDSCAPE_480P_8 = 47, // 848x480 15
8802  VIDEO_PROFILE_LANDSCAPE_480P_9 = 48, // 848x480 30
8804  VIDEO_PROFILE_LANDSCAPE_480P_10 = 49, // 640x480 10
8806  VIDEO_PROFILE_LANDSCAPE_720P = 50, // 1280x720 15
8808  VIDEO_PROFILE_LANDSCAPE_720P_3 = 52, // 1280x720 30
8810  VIDEO_PROFILE_LANDSCAPE_720P_5 = 54, // 960x720 15
8812  VIDEO_PROFILE_LANDSCAPE_720P_6 = 55, // 960x720 30
8814  VIDEO_PROFILE_LANDSCAPE_1080P = 60, // 1920x1080 15
8816  VIDEO_PROFILE_LANDSCAPE_1080P_3 = 62, // 1920x1080 30
8818  VIDEO_PROFILE_LANDSCAPE_1080P_5 = 64, // 1920x1080 60
8820  VIDEO_PROFILE_LANDSCAPE_1440P = 66, // 2560x1440 30
8822  VIDEO_PROFILE_LANDSCAPE_1440P_2 = 67, // 2560x1440 60
8824  VIDEO_PROFILE_LANDSCAPE_4K = 70, // 3840x2160 30
8826  VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, // 3840x2160 60
8828  VIDEO_PROFILE_PORTRAIT_120P = 1000, // 120x160 15
8830  VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, // 120x120 15
8832  VIDEO_PROFILE_PORTRAIT_180P = 1010, // 180x320 15
8834  VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, // 180x180 15
8836  VIDEO_PROFILE_PORTRAIT_180P_4 = 1013, // 180x240 15
8838  VIDEO_PROFILE_PORTRAIT_240P = 1020, // 240x320 15
8840  VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, // 240x240 15
8842  VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, // 240x424 15
8844  VIDEO_PROFILE_PORTRAIT_360P = 1030, // 360x640 15
8846  VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, // 360x360 15
8848  VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, // 360x640 30
8850  VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, // 360x360 30
8852  VIDEO_PROFILE_PORTRAIT_360P_7 = 1036, // 360x480 15
8854  VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, // 360x480 30
8856  VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, // 360x640 15
8858  VIDEO_PROFILE_PORTRAIT_360P_10 = 1039, // 360x640 24
8860  VIDEO_PROFILE_PORTRAIT_360P_11 = 1100, // 360x640 24
8862  VIDEO_PROFILE_PORTRAIT_480P = 1040, // 480x640 15
8864  VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, // 480x480 15
8866  VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, // 480x640 30
8868  VIDEO_PROFILE_PORTRAIT_480P_6 = 1045, // 480x480 30
8870  VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, // 480x848 15
8872  VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, // 480x848 30
8874  VIDEO_PROFILE_PORTRAIT_480P_10 = 1049, // 480x640 10
8876  VIDEO_PROFILE_PORTRAIT_720P = 1050, // 720x1280 15
8878  VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, // 720x1280 30
8880  VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, // 720x960 15
8882  VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, // 720x960 30
8884  VIDEO_PROFILE_PORTRAIT_1080P = 1060, // 1080x1920 15
8886  VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, // 1080x1920 30
8888  VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, // 1080x1920 60
8890  VIDEO_PROFILE_PORTRAIT_1440P = 1066, // 1440x2560 30
8892  VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067, // 1440x2560 60
8894  VIDEO_PROFILE_PORTRAIT_4K = 1070, // 2160x3840 30
8896  VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, // 2160x3840 60
8898  VIDEO_PROFILE_DEFAULT = VIDEO_PROFILE_LANDSCAPE_360P,
8899 };
8900 
8901 class AAudioDeviceManager : public agora::util::AutoPtr<IAudioDeviceManager> {
8902  public:
8903  AAudioDeviceManager(IRtcEngine* engine) {
8904  queryInterface(engine, AGORA_IID_AUDIO_DEVICE_MANAGER);
8905  }
8906 };
8907 
8908 class AVideoDeviceManager : public agora::util::AutoPtr<IVideoDeviceManager> {
8909  public:
8910  AVideoDeviceManager(IRtcEngine* engine) {
8911  queryInterface(engine, AGORA_IID_VIDEO_DEVICE_MANAGER);
8912  }
8913 };
8914 
8915 } // namespace rtc
8916 } // namespace agora
8917 
8923 #define getAgoraRtcEngineVersion getAgoraSdkVersion
8924 
8926 
8929 
8935 AGORA_API agora::rtc::IRtcEngine* AGORA_CALL createAgoraRtcEngine();
8936 
8938 
8939 
8946 #define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
8947 #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::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:1160
agora::rtc::PublisherConfiguration::extraInfo
const char * extraInfo
Definition: IAgoraRtcEngine.h:766
agora::rtc::IRtcEngine::setAVSyncSource
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
agora::VideoLayout
Definition: AgoraBase.h:7117
agora::rtc::RtcEngineContext::appId
const char * appId
Definition: IAgoraRtcEngine.h:3327
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:2776
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::IRtcEngineEventHandler::onExtensionErrorWithContext
virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char *message)
Definition: IAgoraRtcEngine.h:2961
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:6702
agora::rtc::RemoteVideoStats::publishDuration
int publishDuration
Definition: IAgoraRtcEngine.h:563
agora::rtc::FilterEffectOptions
Definition: AgoraBase.h:5117
agora::rtc::IRtcEngine::stopDirectCdnStreaming
virtual int stopDirectCdnStreaming()=0
agora::rtc::LastmileProbeResult
Definition: AgoraBase.h:4391
agora::rtc::AudioEncodedFrameObserverConfig
Definition: AgoraBase.h:6073
agora::rtc::ScreenCaptureParameters
Definition: AgoraBase.h:5770
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:3405
agora::rtc::RemoteVideoStats::e2eDelay
int e2eDelay
Definition: IAgoraRtcEngine.h:508
agora::rtc::InjectStreamConfig::audioChannels
int audioChannels
Definition: IAgoraRtcEngine.h:688
agora::rtc::IVideoEffectObject::SAVE
@ SAVE
Definition: IAgoraRtcEngine.h:3164
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:4800
agora::rtc::ChannelMediaOptions::publishSecondaryCameraTrack
Optional< bool > publishSecondaryCameraTrack
Definition: IAgoraRtcEngine.h:1072
agora::rtc::SenderOptions
Definition: AgoraBase.h:1254
agora::rtc::IRtcEngine::muteLocalVideoStream
virtual int muteLocalVideoStream(bool mute)=0
agora::rtc::RtcEngineContext::eventHandler
IRtcEngineEventHandler * eventHandler
Definition: IAgoraRtcEngine.h:3320
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:578
agora::rtc::VideoCompositingLayout::canvasHeight
int canvasHeight
Definition: IAgoraRtcEngine.h:627
agora::rtc::IRtcEngine::setVoiceConversionPreset
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
agora::rtc::DirectCdnStreamingStats::videoHeight
int videoHeight
Definition: IAgoraRtcEngine.h:3546
agora::rtc::LastmileProbeConfig
Definition: AgoraBase.h:4321
agora::rtc::IRtcEngine::enableLocalVideo
virtual int enableLocalVideo(bool enabled)=0
agora::rtc::IRtcEngineEventHandler::onLeaveChannel
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1654
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:3578
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:1707
agora::rtc::IVideoEffectObject::getVideoEffectFloatParam
virtual float getVideoEffectFloatParam(const char *option, const char *key)=0
Gets a float parameter from the video effect.
agora::rtc::RtcEngineContext::threadPriority
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraRtcEngine.h:3382
agora::rtc::IRtcEngine::registerAudioEncodedFrameObserver
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
agora::rtc::IRtcEngine::queryHDRCapability
virtual int queryHDRCapability(VIDEO_MODULE_TYPE videoModule, HDR_CAPABILITY &capability)=0
Queries the HDR capability of the video module.
agora::rtc::IRtcEngine::setFaceShapeBeautyOptions
virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::ChannelMediaOptions::enableBuiltInMediaEncryption
Optional< bool > enableBuiltInMediaEncryption
Definition: IAgoraRtcEngine.h:1260
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:661
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:445
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::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:559
agora::rtc::IRtcEngine::setAudioMixingPitch
virtual int setAudioMixingPitch(int pitch)=0
agora::rtc::ChannelMediaOptions::publishRhythmPlayerTrack
Optional< bool > publishRhythmPlayerTrack
Definition: IAgoraRtcEngine.h:1266
agora::rtc::ChannelMediaOptions::publishCustomVideoTrack
Optional< bool > publishCustomVideoTrack
Definition: IAgoraRtcEngine.h:1148
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:1598
agora::rtc::DirectCdnStreamingStats::videoWidth
int videoWidth
Definition: IAgoraRtcEngine.h:3541
agora::rtc::IMetadataObserver::Metadata::buffer
unsigned char * buffer
Definition: IAgoraRtcEngine.h:3459
agora::rtc::PublisherConfiguration::publishUrl
const char * publishUrl
Definition: IAgoraRtcEngine.h:759
agora::rtc::IRtcEngine::enableVoiceAITuner
virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type)=0
agora::rtc::ExtensionInfo
Definition: IAgoraRtcEngine.h:3690
agora::rtc::IRtcEngineEventHandler::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2788
agora::rtc::ExtensionInfo::remoteUid
uid_t remoteUid
Definition: IAgoraRtcEngine.h:3701
agora::rtc::PublisherConfiguration::lifecycle
int lifecycle
Definition: IAgoraRtcEngine.h:741
agora::rtc::IRtcEngine::startPreview
virtual int startPreview()=0
agora::rtc::IMetadataObserver::Metadata::timeStampMs
long long timeStampMs
Definition: IAgoraRtcEngine.h:3463
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::IRtcEngine::updateLocalAudioMixerConfiguration
virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration &config)=0
agora::rtc::ChannelMediaOptions::autoSubscribeAudio
Optional< bool > autoSubscribeAudio
Definition: IAgoraRtcEngine.h:1198
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:6975
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:3556
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:1285
agora::rtc::LiveTranscoding
Definition: AgoraBase.h:3965
agora::rtc::ChannelMediaOptions::audienceLatencyLevel
Optional< AUDIENCE_LATENCY_LEVEL_TYPE > audienceLatencyLevel
Definition: IAgoraRtcEngine.h:1223
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::IVideoEffectObject::VIDEO_EFFECT_ACTION
VIDEO_EFFECT_ACTION
Actions that can be performed on video effect nodes.
Definition: IAgoraRtcEngine.h:3162
agora::rtc::LocalVideoStats::sentFrameRate
int sentFrameRate
Definition: IAgoraRtcEngine.h:287
agora::rtc::Rectangle
Definition: AgoraBase.h:2221
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:2765
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:673
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:1243
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:2800
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::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::STYLE_MAKEUP
@ STYLE_MAKEUP
agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2330
agora::util::AutoPtr
Definition: AgoraBase.h:100
agora::rtc::LocalVideoStats::sentBitrate
int sentBitrate
Definition: IAgoraRtcEngine.h:283
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:1551
agora::rtc::RemoteVideoStats::totalFrozenTime
int totalFrozenTime
Definition: IAgoraRtcEngine.h:545
agora::rtc::IMetadataObserver::METADATA_TYPE
METADATA_TYPE
Definition: IAgoraRtcEngine.h:3424
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:1921
agora::rtc::IMetadataObserver::Metadata::channelId
const char * channelId
Definition: IAgoraRtcEngine.h:3448
agora::rtc::IRtcEngineEventHandler
Definition: IAgoraRtcEngine.h:1520
agora::rtc::VideoCompositingLayout::Region::height
double height
Definition: IAgoraRtcEngine.h:594
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:1142
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1610
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:3604
agora::rtc::EchoTestConfiguration
Definition: AgoraBase.h:6679
agora::rtc::RtcImage
Definition: AgoraBase.h:3775
agora::rtc::VideoCompositingLayout::backgroundColor
const char * backgroundColor
Definition: IAgoraRtcEngine.h:630
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::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:1279
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2134
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:3478
agora::rtc::LeaveChannelOptions::unloadAllEffect
bool unloadAllEffect
Definition: IAgoraRtcEngine.h:1499
agora::rtc::FaceShapeBeautyOptions
Face shape beauty options. This structure defines options for facial adjustments of different facial ...
Definition: AgoraBase.h:5078
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:3714
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::getFaceShapeBeautyOptions
virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=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::ExtensionContext
Definition: AgoraMediaBase.h:41
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID
VIDEO_EFFECT_NODE_ID
Types of video effect nodes that can be applied.
Definition: IAgoraRtcEngine.h:3146
agora::rtc::IRtcEngine::adjustAudioMixingPublishVolume
virtual int adjustAudioMixingPublishVolume(int volume)=0
agora::rtc::DirectCdnStreamingMediaOptions::publishCameraTrack
Optional< bool > publishCameraTrack
Definition: IAgoraRtcEngine.h:3598
agora::rtc::IVideoDeviceCollection::getCount
virtual int getCount()=0
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::FILTER
@ FILTER
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:873
agora::rtc::IRtcEngineEventHandler::onVideoDeviceStateChanged
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1718
agora::rtc::IMetadataObserver
Definition: IAgoraRtcEngine.h:3415
agora::rtc::VideoCompositingLayout::appData
const char * appData
Definition: IAgoraRtcEngine.h:640
agora::rtc::IVideoEffectObject::setVideoEffectBoolParam
virtual int setVideoEffectBoolParam(const char *option, const char *key, bool param)=0
Sets a boolean parameter for the video effect.
agora::rtc::RemoteAudioStats::totalFrozenTime
int totalFrozenTime
Definition: IAgoraRtcEngine.h:408
agora::rtc::IVideoEffectObject::setVideoEffectFloatParam
virtual int setVideoEffectFloatParam(const char *option, const char *key, float param)=0
Sets a float parameter for the video effect.
agora::rtc::IRtcEngineEventHandler::onAudioMixingPositionChanged
virtual void onAudioMixingPositionChanged(int64_t position)
Reports current AudioMixing progress.
Definition: IAgoraRtcEngine.h:1690
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:5240
agora::rtc::PublisherConfiguration::defaultLayout
int defaultLayout
Definition: IAgoraRtcEngine.h:738
agora::rtc::IRtcEngineEventHandler::onTranscodingUpdated
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:2533
agora::rtc::IRtcEngine::updateRtmpTranscoding
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
agora::rtc::ScreenCaptureConfiguration::displayId
int64_t displayId
Definition: IAgoraRtcEngine.h:859
agora::rtc::RemoteAudioStats::publishDuration
int publishDuration
Definition: IAgoraRtcEngine.h:449
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:1577
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:637
agora::rtc::ExtensionInfo::mediaSourceType
agora::media::MEDIA_SOURCE_TYPE mediaSourceType
Definition: IAgoraRtcEngine.h:3694
agora::rtc::IRtcEngineEventHandler::onProxyConnected
virtual void onProxyConnected(const char *channel, uid_t uid, PROXY_TYPE proxyType, const char *localProxyIp, int elapsed)
Definition: IAgoraRtcEngine.h:1564
agora::rtc::IRtcEngineEventHandler::onExtensionEventWithContext
virtual void onExtensionEventWithContext(const ExtensionContext &context, const char *key, const char *value)
Definition: IAgoraRtcEngine.h:2923
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:724
agora::rtc::IRtcEngineEventHandler::onAudioMixingFinished
virtual void onAudioMixingFinished() __deprecated
Definition: IAgoraRtcEngine.h:1698
agora::rtc::AVideoDeviceManager
Definition: IAgoraRtcEngine.h:8908
agora::rtc::LocalVideoStats::codecType
VIDEO_CODEC_TYPE codecType
Definition: IAgoraRtcEngine.h:340
agora::rtc::ExtensionInfo::localUid
uid_t localUid
Definition: IAgoraRtcEngine.h:3719
agora::rtc::IRtcEngine::setSubscribeVideoBlocklist
virtual int setSubscribeVideoBlocklist(uid_t *uidList, int uidNumber)=0
agora::rtc::LocalTranscoderConfiguration
Definition: AgoraBase.h:4189
agora::rtc::IRtcEngine::adjustAudioMixingPlayoutVolume
virtual int adjustAudioMixingPlayoutVolume(int volume)=0
agora::rtc::InjectStreamConfig::audioBitrate
int audioBitrate
Definition: IAgoraRtcEngine.h:685
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:1639
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:3457
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:461
agora::rtc::ChannelMediaOptions::publishEncodedVideoTrack
Optional< bool > publishEncodedVideoTrack
Definition: IAgoraRtcEngine.h:1154
agora::rtc::IRtcEngine::setDualStreamMode
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode)=0
agora::rtc::DirectCdnStreamingStats
Definition: IAgoraRtcEngine.h:3537
agora::rtc::VideoFormat
Definition: AgoraBase.h:2725
agora::rtc::RemoteVideoStats::uid
uid_t uid
Definition: IAgoraRtcEngine.h:496
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:2089
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:588
agora::rtc::IRtcEngine::stopAudioMixing
virtual int stopAudioMixing()=0
agora::rtc::IVideoEffectObject::RESET
@ RESET
Definition: IAgoraRtcEngine.h:3166
agora::rtc::PublisherConfiguration
Definition: IAgoraRtcEngine.h:716
agora::rtc::IRtcEngineEventHandler::onExtensionStartedWithContext
virtual void onExtensionStartedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:2936
agora::rtc::IRtcEngine::setLogLevel
virtual int setLogLevel(commons::LOG_LEVEL level)=0
agora::rtc::RtcEngineContext::logConfig
commons::LogConfig logConfig
Definition: IAgoraRtcEngine.h:3377
agora::rtc::IRtcEngine::setRemoteDefaultVideoStreamType
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
agora::rtc::LocalAudioMixerConfiguration
Definition: AgoraBase.h:4298
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:665
agora::rtc::IRtcEngine::destroyVideoEffectObject
virtual int destroyVideoEffectObject(agora_refptr< IVideoEffectObject > videoEffectObject)=0
Destroys a video effect object.
agora::rtc::ChannelMediaOptions::publishFourthCameraTrack
Optional< bool > publishFourthCameraTrack
Definition: IAgoraRtcEngine.h:1084
agora::rtc::IRtcEngine::startRtmpStreamWithTranscoding
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
agora::rtc::DirectCdnStreamingMediaOptions
Definition: IAgoraRtcEngine.h:3592
agora::rtc::IRtcEngine::setVideoEncoderConfiguration
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
agora::rtc::AdvancedAudioOptions
Definition: IAgoraRtcEngine.h:1035
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:1597
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:3342
agora::rtc::ScreenCaptureConfiguration::regionRect
Rectangle regionRect
Definition: IAgoraRtcEngine.h:881
agora::rtc::VideoCompositingLayout::canvasWidth
int canvasWidth
Definition: IAgoraRtcEngine.h:622
agora::rtc::LeaveChannelOptions::stopMicrophoneRecording
bool stopMicrophoneRecording
Definition: IAgoraRtcEngine.h:1505
agora::rtc::PublisherConfiguration::rawStreamUrl
const char * rawStreamUrl
Definition: IAgoraRtcEngine.h:763
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:3561
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:3337
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::IRtcEngineEventHandler::onAudioDeviceStateChanged
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1678
agora::rtc::IAudioEncodedFrameObserver
Definition: AgoraBase.h:6090
agora::rtc::ChannelMediaOptions::token
Optional< const char * > token
Definition: IAgoraRtcEngine.h:1252
agora::rtc::ChannelMediaOptions::parameters
Optional< const char * > parameters
Definition: IAgoraRtcEngine.h:1291
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:3551
agora::rtc::IRtcEngine::stopLastmileProbeTest
virtual int stopLastmileProbeTest()=0
agora::rtc::ChannelMediaRelayConfiguration
Definition: AgoraBase.h:6299
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:2981
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:1138
agora::rtc::RemoteVideoStats::avSyncTimeMs
int avSyncTimeMs
Definition: IAgoraRtcEngine.h:554
agora::rtc::IRtcEngine::setFilterEffectOptions
virtual int setFilterEffectOptions(bool enabled, const FilterEffectOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::RtcEngineContext::domainLimit
bool domainLimit
Definition: IAgoraRtcEngine.h:3398
agora::rtc::VideoDenoiserOptions
Definition: AgoraBase.h:5192
agora::rtc::IRtcEngine::setLocalVideoMirrorMode
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0
agora::rtc::RemoteVideoStats::decoderOutputFrameRate
int decoderOutputFrameRate
Definition: IAgoraRtcEngine.h:526
agora::rtc::RtcEngineContext::context
void * context
Definition: IAgoraRtcEngine.h:3333
agora::rtc::IRtcEngine::stopLocalAudioMixer
virtual int stopLocalAudioMixer()=0
agora::rtc::IRtcEngineEventHandler::onActiveSpeaker
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2422
agora::rtc::ChannelMediaOptions::publishCameraTrack
Optional< bool > publishCameraTrack
Definition: IAgoraRtcEngine.h:1066
agora::rtc::RemoteAudioStats::e2eDelay
int e2eDelay
Definition: IAgoraRtcEngine.h:465
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:1219
agora::rtc::ChannelMediaOptions::publishCameraRelayTrack
Optional< bool > publishCameraRelayTrack
Definition: IAgoraRtcEngine.h:1192
agora::rtc::ChannelMediaOptions::publishThirdCameraTrack
Optional< bool > publishThirdCameraTrack
Definition: IAgoraRtcEngine.h:1078
agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1535
agora::rtc::DirectCdnStreamingMediaOptions::publishMediaPlayerId
Optional< int > publishMediaPlayerId
Definition: IAgoraRtcEngine.h:3627
agora::rtc::ChannelMediaOptions::channelProfile
Optional< CHANNEL_PROFILE_TYPE > channelProfile
Definition: IAgoraRtcEngine.h:1233
agora::rtc::RemoteAudioStats::audioLossRate
int audioLossRate
Definition: IAgoraRtcEngine.h:388
agora::rtc::VideoCompositingLayout::Region::zOrder
int zOrder
Definition: IAgoraRtcEngine.h:598
agora::rtc::IRtcEngine::queryDeviceScore
virtual int queryDeviceScore()=0
agora::rtc::LocalVideoStats::captureFrameRate
int captureFrameRate
Definition: IAgoraRtcEngine.h:290
agora::rtc::VirtualBackgroundSource
Definition: AgoraBase.h:5266
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::ChannelMediaOptions::publishScreenCaptureAudio
Optional< bool > publishScreenCaptureAudio
Definition: IAgoraRtcEngine.h:1097
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:3025
agora::rtc::RemoteVideoStats::frozenRate
int frozenRate
Definition: IAgoraRtcEngine.h:549
agora::rtc::ScreenCaptureConfiguration::windowId
int64_t windowId
Definition: IAgoraRtcEngine.h:869
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:643
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:603
agora::rtc::IRtcEngine::enableCustomAudioLocalPlayback
virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled)=0
agora::rtc::IVideoEffectObject::addOrUpdateVideoEffect
virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char *templateName)=0
Adds or updates video effects with specified node ID and template.
agora::rtc::DirectCdnStreamingMediaOptions::publishCustomVideoTrack
Optional< bool > publishCustomVideoTrack
Definition: IAgoraRtcEngine.h:3616
agora::rtc::ScreenCaptureConfiguration::isCaptureWindow
bool isCaptureWindow
Definition: IAgoraRtcEngine.h:855
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:2908
agora::rtc::IRtcEngine::setLocalVoiceFormant
virtual int setLocalVoiceFormant(double formantRatio)=0
agora::rtc::AdvancedAudioOptions::audioProcessingChannels
Optional< int > audioProcessingChannels
Definition: IAgoraRtcEngine.h:1039
agora::rtc::IRtcEngine::getUserInfoByUserAccount
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
agora::rtc::WlAccStats
Definition: AgoraBase.h:4598
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::FaceShapeAreaOptions::FACE_SHAPE_AREA
FACE_SHAPE_AREA
The specific facial area to be adjusted.
Definition: AgoraBase.h:4863
agora::rtc::RemoteVideoStats::__deprecated
int delay __deprecated
Definition: IAgoraRtcEngine.h:504
agora::rtc::CameraCapturerConfiguration::deviceId
Optional< const char * > deviceId
Definition: IAgoraRtcEngine.h:832
agora::rtc::RemoteAudioStats::quality
int quality
Definition: IAgoraRtcEngine.h:374
agora::rtc::PublisherConfiguration::width
int width
Definition: IAgoraRtcEngine.h:720
agora::rtc::VideoCompositingLayout::Region::width
double width
Definition: IAgoraRtcEngine.h:592
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:1898
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:1228
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:575
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:3405
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::createVideoEffectObject
virtual agora_refptr< IVideoEffectObject > createVideoEffectObject(const char *bundlePath, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Creates a video effect object and returns its pointer.
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:1214
agora::rtc::IDirectCdnStreamingEventHandler
Definition: IAgoraRtcEngine.h:3568
agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2381
agora::rtc::IRtcEngine::setRemoteRenderTargetFps
virtual int setRemoteRenderTargetFps(int targetFps)=0
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:2826
agora::rtc::IRtcEngineEventHandler::onVideoStopped
virtual void onVideoStopped() __deprecated
Definition: IAgoraRtcEngine.h:2191
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:6509
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:1172
agora::rtc::ChannelMediaOptions::enableAudioRecordingOrPlayout
Optional< bool > enableAudioRecordingOrPlayout
Definition: IAgoraRtcEngine.h:1210
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:2875
agora::rtc::RemoteVideoStats::receivedBitrate
int receivedBitrate
Definition: IAgoraRtcEngine.h:520
agora::rtc::RemoteAudioStats
Definition: IAgoraRtcEngine.h:366
agora::rtc::TranscodingVideoStream
Definition: AgoraBase.h:4113
agora::rtc::IMetadataObserver::MAX_METADATA_SIZE_TYPE
MAX_METADATA_SIZE_TYPE
Definition: IAgoraRtcEngine.h:3436
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::IVideoEffectObject::performVideoEffectAction
virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId)=0
Performs an action on a specified video effect node.
agora::rtc::IRtcEngine::setupRemoteVideo
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
agora::rtc::IRtcEngineEventHandler::onLastmileProbeResult
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:1609
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::IVideoEffectObject::getVideoEffectBoolParam
virtual bool getVideoEffectBoolParam(const char *option, const char *key)=0
Gets a boolean parameter from the video effect.
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:746
agora::rtc::IRtcEngine::setInEarMonitoringVolume
virtual int setInEarMonitoringVolume(int volume)=0
agora::rtc::IRtcEngine::enableSoundPositionIndication
virtual int enableSoundPositionIndication(bool enabled)=0
agora::rtc::VideoCompositingLayout::regions
const Region * regions
Definition: IAgoraRtcEngine.h:634
agora::rtc::IRtcEngine::stopCameraCapture
virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType)=0
agora::rtc::ChannelMediaOptions::publishMediaPlayerVideoTrack
Optional< bool > publishMediaPlayerVideoTrack
Definition: IAgoraRtcEngine.h:1166
agora::rtc::IRtcEngine::stopPreview
virtual int stopPreview()=0
agora::rtc::RemoteVideoStats::mosValue
int mosValue
Definition: IAgoraRtcEngine.h:571
agora::rtc::IVideoEffectObject::setVideoEffectIntParam
virtual int setVideoEffectIntParam(const char *option, const char *key, int param)=0
Sets an integer parameter for the video effect.
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:3632
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:2752
agora::rtc::LocalVideoStats::encodedFrameWidth
int encodedFrameWidth
Definition: IAgoraRtcEngine.h:314
agora::rtc::RtcStats
Definition: AgoraBase.h:2318
agora::rtc::LowlightEnhanceOptions
Definition: AgoraBase.h:5144
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:2194
agora::rtc::ChannelMediaOptions::publishLipSyncTrack
Optional< bool > publishLipSyncTrack
Definition: IAgoraRtcEngine.h:1184
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:2281
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3582
agora::rtc::IRtcEngine::setLocalRenderTargetFps
virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps)=0
agora::rtc::RecorderStreamInfo
Definition: AgoraBase.h:7023
agora::rtc::ChannelMediaOptions::publishThirdScreenTrack
Optional< bool > publishThirdScreenTrack
Definition: IAgoraRtcEngine.h:1124
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:2158
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::RemoteVideoStats::width
int width
Definition: IAgoraRtcEngine.h:512
agora::rtc::RtcEngineContext::audioScenario
AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraRtcEngine.h:3351
agora::rtc::RemoteVideoStats::rendererOutputFrameRate
int rendererOutputFrameRate
Definition: IAgoraRtcEngine.h:529
agora::rtc::IRtcEngine::setVoiceBeautifierPreset
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
agora::rtc::RemoteVideoStats::decoderInputFrameRate
int decoderInputFrameRate
Definition: IAgoraRtcEngine.h:523
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:1118
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::RemoteAudioStats::qualityChangedReason
int qualityChangedReason
Definition: IAgoraRtcEngine.h:457
agora::rtc::IRtcEngine::getCallId
virtual int getCallId(agora::util::AString &callId)=0
agora::rtc::InjectStreamConfig
Definition: IAgoraRtcEngine.h:657
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:843
agora::rtc::LocalVideoStats::encodedFrameCount
int encodedFrameCount
Definition: IAgoraRtcEngine.h:337
agora::rtc::PublisherConfiguration::bitrate
int bitrate
Definition: IAgoraRtcEngine.h:732
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:3316
agora::rtc::IRtcEngine::unloadAllEffects
virtual int unloadAllEffects()=0
agora::rtc::ChannelMediaOptions
Definition: IAgoraRtcEngine.h:1060
agora::rtc::IVideoEffectObject
Provides methods to manage and configure video effects, such as beauty, style makeup,...
Definition: IAgoraRtcEngine.h:3137
agora::rtc::IRtcEngine
Definition: IAgoraRtcEngine.h:3740
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:849
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:1204
agora::rtc::AudioRecordingConfiguration
Definition: AgoraBase.h:5993
agora::rtc::IRtcEngine::getEffectCurrentPosition
virtual int getEffectCurrentPosition(int soundId)=0
agora::rtc::ChannelMediaOptions::publishMicrophoneTrack
Optional< bool > publishMicrophoneTrack
Definition: IAgoraRtcEngine.h:1090
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:532
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1100
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:2892
agora::rtc::RemoteVideoStats::height
int height
Definition: IAgoraRtcEngine.h:516
agora::rtc::LocalVideoStats::captureFrameWidth
int captureFrameWidth
Definition: IAgoraRtcEngine.h:293
agora::rtc::IRtcEngine::setAudioEffectPreset
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0
agora::rtc::IRtcEngine::release
static AGORA_CPP_API void release(RtcEngineReleaseCallback callback=nullptr)
agora::rtc::RtcEngineContext::useExternalEglContext
bool useExternalEglContext
Definition: IAgoraRtcEngine.h:3391
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:3622
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:156
agora::rtc::IRtcEngine::getNetworkType
virtual int getNetworkType()=0
agora::rtc::InjectStreamConfig::audioSampleRate
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: IAgoraRtcEngine.h:681
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:728
agora::rtc::IRtcEngine::resumeEffect
virtual int resumeEffect(int soundId)=0
agora::rtc::PublisherConfiguration::injectStreamUrl
const char * injectStreamUrl
Definition: IAgoraRtcEngine.h:755
agora::rtc::ChannelMediaOptions::publishScreenTrack
Optional< bool > publishScreenTrack
Definition: IAgoraRtcEngine.h:1112
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:677
agora::rtc::LocalVideoStats::captureBrightnessLevel
CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel
Definition: IAgoraRtcEngine.h:347
agora::rtc::IRtcEngine::enableVideo
virtual int enableVideo()=0
agora::rtc::IRtcEngineEventHandler::onExtensionStoppedWithContext
virtual void onExtensionStoppedWithContext(const ExtensionContext &context)
Definition: IAgoraRtcEngine.h:2947
agora::rtc::IRtcEngine::setRemoteUserSpatialAudioParams
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams &params)=0
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::BEAUTY
@ BEAUTY
agora::rtc::IVideoEffectObject::VIDEO_EFFECT_NODE_ID::STICKER
@ STICKER
agora::rtc::IRtcEngine::setHeadphoneEQParameters
virtual int setHeadphoneEQParameters(int lowGain, int highGain)=0
agora::rtc::IVideoEffectObject::removeVideoEffect
virtual int removeVideoEffect(uint32_t nodeId)=0
Removes a video effect with specified node ID.
agora::rtc::IRtcEngine::getFaceShapeAreaOptions
virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
agora::rtc::IMetadataObserver::UNKNOWN_METADATA
@ UNKNOWN_METADATA
Definition: IAgoraRtcEngine.h:3427
agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1826
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:2973
agora::rtc::ChannelMediaOptions::audioDelayMs
Optional< int > audioDelayMs
Definition: IAgoraRtcEngine.h:1238
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:1045
agora::rtc::IRtcEngine::unloadEffect
virtual int unloadEffect(int soundId)=0
agora::rtc::VideoCompositingLayout::Region
Definition: IAgoraRtcEngine.h:579
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:2843
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:1130
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:749
agora::rtc::ChannelMediaOptions::publishMixedAudioTrack
Optional< bool > publishMixedAudioTrack
Definition: IAgoraRtcEngine.h:1178
agora::rtc::IRtcEngine::startLocalAudioMixer
virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration &config)=0
agora::rtc::RemoteVideoStats::rxStreamType
VIDEO_STREAM_TYPE rxStreamType
Definition: IAgoraRtcEngine.h:539
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:3453
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:669
agora::rtc::IRtcEngine::setVideoQoEPreference
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
agora::rtc::ChannelMediaOptions::isInteractiveAudience
Optional< bool > isInteractiveAudience
Definition: IAgoraRtcEngine.h:1274
agora::rtc::FaceShapeAreaOptions
Face shape area options. This structure defines options for facial adjustments on different facial ar...
Definition: AgoraBase.h:4857
agora::SpatialAudioParams
Definition: AgoraBase.h:7080
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:2811
agora::rtc::RemoteAudioStats::qoeQuality
int qoeQuality
Definition: IAgoraRtcEngine.h:453
agora::rtc::IRtcEngine::setFaceShapeAreaOptions
virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
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:1663
agora::rtc::IRtcEngineEventHandler::onUserJoined
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1952
agora::rtc::AAudioDeviceManager
Definition: IAgoraRtcEngine.h:8901
agora::rtc::IMetadataObserver::Metadata
Definition: IAgoraRtcEngine.h:3445
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:1911
agora::rtc::RemoteVideoStats::packetLossRate
int packetLossRate
Definition: IAgoraRtcEngine.h:535
agora::rtc::LocalVideoStats::hwEncoderAccelerating
int hwEncoderAccelerating
Definition: IAgoraRtcEngine.h:356
agora::rtc::DeviceInfo
Definition: AgoraBase.h:3443
agora::base::IEngineBase
Definition: AgoraBase.h:7046
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:3610
agora::rtc::VideoRenderingTracingInfo
Definition: AgoraBase.h:6874
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:3360
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:813
agora::rtc::IMetadataObserver::VIDEO_METADATA
@ VIDEO_METADATA
Definition: IAgoraRtcEngine.h:3430
agora::rtc::IRtcEngine::selectAudioTrack
virtual int selectAudioTrack(int index)=0
agora::rtc::RemoteVideoStats
Definition: IAgoraRtcEngine.h:492
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:752
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:3456
agora::rtc::ClientRoleOptions
Definition: AgoraBase.h:2565
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:864
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:2859
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:4672
agora::rtc::VideoCompositingLayout::Region::uid
uid_t uid
Definition: IAgoraRtcEngine.h:582
agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2678
agora::rtc::IVideoEffectObject::getVideoEffectIntParam
virtual int getVideoEffectIntParam(const char *option, const char *key)=0
Gets an integer parameter from the video effect.
agora::rtc::SegmentationProperty
Definition: AgoraBase.h:5344
agora::rtc::VideoCompositingLayout::Region::x
double x
Definition: IAgoraRtcEngine.h:585
Generated by   doxygen 1.8.18