Agora Java API Reference for Android
AgoraBase.h
1 //
2 // Agora Engine SDK
3 //
4 // Created by Sting Feng in 2017-11.
5 // Copyright (c) 2017 Agora.io. All rights reserved.
6 //
7 
8 // This header file is included by both high level and low level APIs,
9 #pragma once // NOLINT(build/header_guard)
10 
11 #include <stdarg.h>
12 #include <stddef.h>
13 #include <stdio.h>
14 #include <string.h>
15 #include <cassert>
16 
17 #include "IAgoraParameter.h"
18 #include "AgoraMediaBase.h"
19 #include "AgoraRefPtr.h"
20 #include "AgoraOptional.h"
21 
22 #define MAX_PATH_260 (260)
23 
24 #if defined(_WIN32)
25 
26 #ifndef WIN32_LEAN_AND_MEAN
27 #define WIN32_LEAN_AND_MEAN
28 #endif // !WIN32_LEAN_AND_MEAN
29 #if defined(__aarch64__)
30 #include <arm64intr.h>
31 #endif
32 #include <Windows.h>
33 
34 #if defined(AGORARTC_EXPORT)
35 #define AGORA_API extern "C" __declspec(dllexport)
36 #define AGORA_CPP_API __declspec(dllexport)
37 #else
38 #define AGORA_API extern "C" __declspec(dllimport)
39 #define AGORA_CPP_API __declspec(dllimport)
40 #endif // AGORARTC_EXPORT
41 
42 #define AGORA_CALL __cdecl
43 
44 #define __deprecated
45 
46 #define AGORA_CPP_INTERNAL_API extern
47 
48 #elif defined(__APPLE__)
49 
50 #include <TargetConditionals.h>
51 
52 #define AGORA_API extern "C" __attribute__((visibility("default")))
53 #define AGORA_CPP_API __attribute__((visibility("default")))
54 #define AGORA_CALL
55 
56 #define AGORA_CPP_INTERNAL_API __attribute__((visibility("hidden")))
57 
58 #elif defined(__ANDROID__) || defined(__linux__)
59 
60 #define AGORA_API extern "C" __attribute__((visibility("default")))
61 #define AGORA_CPP_API __attribute__((visibility("default")))
62 #define AGORA_CALL
63 
64 #define __deprecated
65 
66 #define AGORA_CPP_INTERNAL_API __attribute__((visibility("hidden")))
67 
68 #else // !_WIN32 && !__APPLE__ && !(__ANDROID__ || __linux__)
69 
70 #define AGORA_API extern "C"
71 #define AGORA_CPP_API
72 #define AGORA_CALL
73 
74 #define __deprecated
75 
76 #endif // _WIN32
77 
78 #ifndef OPTIONAL_ENUM_SIZE_T
79 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
80 #define OPTIONAL_ENUM_SIZE_T enum : size_t
81 #else
82 #define OPTIONAL_ENUM_SIZE_T enum
83 #endif
84 #endif
85 
86 #ifndef OPTIONAL_NULLPTR
87 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
88 #define OPTIONAL_NULLPTR nullptr
89 #else
90 #define OPTIONAL_NULLPTR NULL
91 #endif
92 #endif
93 
94 #define INVALID_DISPLAY_ID (-2)
95 
96 namespace agora {
97 namespace util {
98 
99 template <class T>
100 class AutoPtr {
101  protected:
102  typedef T value_type;
103  typedef T* pointer_type;
104 
105  public:
106  explicit AutoPtr(pointer_type p = OPTIONAL_NULLPTR) : ptr_(p) {}
107 
108  ~AutoPtr() {
109  if (ptr_) {
110  ptr_->release();
111  ptr_ = OPTIONAL_NULLPTR;
112  }
113  }
114 
115  operator bool() const { return (ptr_ != OPTIONAL_NULLPTR); }
116 
117  value_type& operator*() const { return *get(); }
118 
119  pointer_type operator->() const { return get(); }
120 
121  pointer_type get() const { return ptr_; }
122 
123  pointer_type release() {
124  pointer_type ret = ptr_;
125  ptr_ = 0;
126  return ret;
127  }
128 
129  void reset(pointer_type ptr = OPTIONAL_NULLPTR) {
130  if (ptr != ptr_ && ptr_) {
131  ptr_->release();
132  }
133 
134  ptr_ = ptr;
135  }
136 
137  template <class C1, class C2>
138  bool queryInterface(C1* c, C2 iid) {
139  pointer_type p = OPTIONAL_NULLPTR;
140  if (c && !c->queryInterface(iid, reinterpret_cast<void**>(&p))) {
141  reset(p);
142  }
143 
144  return (p != OPTIONAL_NULLPTR);
145  }
146 
147  private:
148  AutoPtr(const AutoPtr&);
149  AutoPtr& operator=(const AutoPtr&);
150 
151  private:
152  pointer_type ptr_;
153 };
154 
155 template <class T>
156 class CopyableAutoPtr : public AutoPtr<T> {
157  typedef typename AutoPtr<T>::pointer_type pointer_type;
158 
159  public:
160  explicit CopyableAutoPtr(pointer_type p = 0) : AutoPtr<T>(p) {}
161  CopyableAutoPtr(const CopyableAutoPtr& rhs) { this->reset(rhs.clone()); }
162  CopyableAutoPtr& operator=(const CopyableAutoPtr& rhs) {
163  if (this != &rhs) this->reset(rhs.clone());
164  return *this;
165  }
166  pointer_type clone() const {
167  if (!this->get()) return OPTIONAL_NULLPTR;
168  return this->get()->clone();
169  }
170 };
171 
172 class IString {
173  public:
174  virtual bool empty() const = 0;
175  virtual const char* c_str() = 0;
176  virtual const char* data() = 0;
177  virtual size_t length() = 0;
178  virtual IString* clone() = 0;
179  virtual void release() = 0;
180  virtual ~IString() {}
181 };
183 
184 class IIterator {
185  public:
186  virtual void* current() = 0;
187  virtual const void* const_current() const = 0;
188  virtual bool next() = 0;
189  virtual void release() = 0;
190  virtual ~IIterator() {}
191 };
192 
193 class IContainer {
194  public:
195  virtual IIterator* begin() = 0;
196  virtual size_t size() const = 0;
197  virtual void release() = 0;
198  virtual ~IContainer() {}
199 };
200 
201 template <class T>
203  IIterator* p;
204 
205  public:
206  typedef T value_type;
207  typedef value_type& reference;
208  typedef const value_type& const_reference;
209  typedef value_type* pointer;
210  typedef const value_type* const_pointer;
211  explicit AOutputIterator(IIterator* it = OPTIONAL_NULLPTR) : p(it) {}
212  ~AOutputIterator() {
213  if (p) p->release();
214  }
215  AOutputIterator(const AOutputIterator& rhs) : p(rhs.p) {}
216  AOutputIterator& operator++() {
217  p->next();
218  return *this;
219  }
220  bool operator==(const AOutputIterator& rhs) const {
221  if (p && rhs.p)
222  return p->current() == rhs.p->current();
223  else
224  return valid() == rhs.valid();
225  }
226  bool operator!=(const AOutputIterator& rhs) const { return !this->operator==(rhs); }
227  reference operator*() { return *reinterpret_cast<pointer>(p->current()); }
228  const_reference operator*() const { return *reinterpret_cast<const_pointer>(p->const_current()); }
229  bool valid() const { return p && p->current() != OPTIONAL_NULLPTR; }
230 };
231 
232 template <class T>
233 class AList {
234  IContainer* container;
235  bool owner;
236 
237  public:
238  typedef T value_type;
239  typedef value_type& reference;
240  typedef const value_type& const_reference;
241  typedef value_type* pointer;
242  typedef const value_type* const_pointer;
243  typedef size_t size_type;
246 
247  public:
248  AList() : container(OPTIONAL_NULLPTR), owner(false) {}
249  AList(IContainer* c, bool take_ownership) : container(c), owner(take_ownership) {}
250  ~AList() { reset(); }
251  void reset(IContainer* c = OPTIONAL_NULLPTR, bool take_ownership = false) {
252  if (owner && container) container->release();
253  container = c;
254  owner = take_ownership;
255  }
256  iterator begin() { return container ? iterator(container->begin()) : iterator(OPTIONAL_NULLPTR); }
257  iterator end() { return iterator(OPTIONAL_NULLPTR); }
258  size_type size() const { return container ? container->size() : 0; }
259  bool empty() const { return size() == 0; }
260 };
261 
262 } // namespace util
263 
267 enum CHANNEL_PROFILE_TYPE {
273  CHANNEL_PROFILE_COMMUNICATION = 0,
279  CHANNEL_PROFILE_LIVE_BROADCASTING = 1,
284  CHANNEL_PROFILE_GAME __deprecated = 2,
290  CHANNEL_PROFILE_CLOUD_GAMING __deprecated = 3,
291 
296  CHANNEL_PROFILE_COMMUNICATION_1v1 __deprecated = 4,
297 };
298 
302 enum WARN_CODE_TYPE {
307  WARN_INVALID_VIEW = 8,
312  WARN_INIT_VIDEO = 16,
317  WARN_PENDING = 20,
322  WARN_NO_AVAILABLE_CHANNEL = 103,
328  WARN_LOOKUP_CHANNEL_TIMEOUT = 104,
333  WARN_LOOKUP_CHANNEL_REJECTED = 105,
339  WARN_OPEN_CHANNEL_TIMEOUT = 106,
344  WARN_OPEN_CHANNEL_REJECTED = 107,
345 
346  // sdk: 100~1000
350  WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111,
354  WARN_SET_CLIENT_ROLE_TIMEOUT = 118,
358  WARN_OPEN_CHANNEL_INVALID_TICKET = 121,
362  WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122,
366  WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131,
370  WARN_CHANNEL_CONNECTION_IP_CHANGED = 132,
374  WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133,
377  WARN_CHANNEL_SOCKET_ERROR = 134,
381  WARN_AUDIO_MIXING_OPEN_ERROR = 701,
385  WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014,
389  WARN_ADM_RUNTIME_RECORDING_WARNING = 1016,
393  WARN_ADM_RECORD_AUDIO_SILENCE = 1019,
397  WARN_ADM_PLAYOUT_MALFUNCTION = 1020,
401  WARN_ADM_RECORD_MALFUNCTION = 1021,
405  WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031,
409  WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032,
417  WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040,
421  WARN_APM_HOWLING = 1051,
425  WARN_ADM_GLITCH_STATE = 1052,
429  WARN_ADM_IMPROPER_SETTINGS = 1053,
433  WARN_ADM_POP_STATE = 1055,
437  WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322,
442  WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323,
450  WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324,
451 };
452 
456 enum ERROR_CODE_TYPE {
460  ERR_OK = 0,
461  // 1~1000
465  ERR_FAILED = 1,
470  ERR_INVALID_ARGUMENT = 2,
477  ERR_NOT_READY = 3,
481  ERR_NOT_SUPPORTED = 4,
485  ERR_REFUSED = 5,
489  ERR_BUFFER_TOO_SMALL = 6,
493  ERR_NOT_INITIALIZED = 7,
497  ERR_INVALID_STATE = 8,
502  ERR_NO_PERMISSION = 9,
508  ERR_TIMEDOUT = 10,
513  ERR_CANCELED = 11,
519  ERR_TOO_OFTEN = 12,
525  ERR_BIND_SOCKET = 13,
530  ERR_NET_DOWN = 14,
536  ERR_JOIN_CHANNEL_REJECTED = 17,
543  ERR_LEAVE_CHANNEL_REJECTED = 18,
547  ERR_ALREADY_IN_USE = 19,
552  ERR_ABORTED = 20,
557  ERR_INIT_NET_ENGINE = 21,
562  ERR_RESOURCE_LIMITED = 22,
569  ERR_INVALID_APP_ID = 101,
574  ERR_INVALID_CHANNEL_NAME = 102,
580  ERR_NO_SERVER_RESOURCES = 103,
593  ERR_TOKEN_EXPIRED = 109,
610  ERR_INVALID_TOKEN = 110,
615  ERR_CONNECTION_INTERRUPTED = 111, // only used in web sdk
620  ERR_CONNECTION_LOST = 112, // only used in web sdk
625  ERR_NOT_IN_CHANNEL = 113,
630  ERR_SIZE_TOO_LARGE = 114,
635  ERR_BITRATE_LIMIT = 115,
640  ERR_TOO_MANY_DATA_STREAMS = 116,
644  ERR_STREAM_MESSAGE_TIMEOUT = 117,
648  ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119,
653  ERR_DECRYPTION_FAILED = 120,
657  ERR_INVALID_USER_ID = 121,
662  ERR_DATASTREAM_DECRYPTION_FAILED = 122,
666  ERR_CLIENT_IS_BANNED_BY_SERVER = 123,
672  ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130,
673 
677  ERR_LICENSE_CREDENTIAL_INVALID = 131,
678 
683  ERR_INVALID_USER_ACCOUNT = 134,
684 
691  ERR_MODULE_NOT_FOUND = 157,
692 
693  // Licensing, keep the license error code same as the main version
694  ERR_CERT_RAW = 157,
695  ERR_CERT_JSON_PART = 158,
696  ERR_CERT_JSON_INVAL = 159,
697  ERR_CERT_JSON_NOMEM = 160,
698  ERR_CERT_CUSTOM = 161,
699  ERR_CERT_CREDENTIAL = 162,
700  ERR_CERT_SIGN = 163,
701  ERR_CERT_FAIL = 164,
702  ERR_CERT_BUF = 165,
703  ERR_CERT_NULL = 166,
704  ERR_CERT_DUEDATE = 167,
705  ERR_CERT_REQUEST = 168,
706 
707  // PcmSend Error num
708  ERR_PCMSEND_FORMAT = 200, // unsupport pcm format
709  ERR_PCMSEND_BUFFEROVERFLOW = 201, // buffer overflow, the pcm send rate too quickly
710 
712  // signaling: 400~600
713  ERR_LOGIN_ALREADY_LOGIN = 428,
714 
716  // 1001~2000
720  ERR_LOAD_MEDIA_ENGINE = 1001,
726  ERR_ADM_GENERAL_ERROR = 1005,
731  ERR_ADM_INIT_PLAYOUT = 1008,
735  ERR_ADM_START_PLAYOUT = 1009,
739  ERR_ADM_STOP_PLAYOUT = 1010,
744  ERR_ADM_INIT_RECORDING = 1011,
748  ERR_ADM_START_RECORDING = 1012,
752  ERR_ADM_STOP_RECORDING = 1013,
756  ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501,
757 };
758 
759 enum LICENSE_ERROR_TYPE {
763  LICENSE_ERR_INVALID = 1,
767  LICENSE_ERR_EXPIRE = 2,
771  LICENSE_ERR_MINUTES_EXCEED = 3,
775  LICENSE_ERR_LIMITED_PERIOD = 4,
779  LICENSE_ERR_DIFF_DEVICES = 5,
783  LICENSE_ERR_INTERNAL = 99,
784 };
785 
789 enum AUDIO_SESSION_OPERATION_RESTRICTION {
793  AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0,
797  AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1,
801  AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1,
806  AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2,
811  AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7,
812 };
813 
814 typedef const char* user_id_t;
815 typedef void* view_t;
816 
820 struct UserInfo {
830  bool hasAudio;
836  bool hasVideo;
837 
838  UserInfo() : hasAudio(false), hasVideo(false) {}
839 };
840 
841 typedef util::AList<UserInfo> UserList;
842 
843 // Shared between Agora Service and Rtc Engine
844 namespace rtc {
845 
849 enum USER_OFFLINE_REASON_TYPE {
853  USER_OFFLINE_QUIT = 0,
859  USER_OFFLINE_DROPPED = 1,
863  USER_OFFLINE_BECOME_AUDIENCE = 2,
864 };
865 
866 enum INTERFACE_ID_TYPE {
867  AGORA_IID_AUDIO_DEVICE_MANAGER = 1,
868  AGORA_IID_VIDEO_DEVICE_MANAGER = 2,
869  AGORA_IID_PARAMETER_ENGINE = 3,
870  AGORA_IID_MEDIA_ENGINE = 4,
871  AGORA_IID_AUDIO_ENGINE = 5,
872  AGORA_IID_VIDEO_ENGINE = 6,
873  AGORA_IID_RTC_CONNECTION = 7,
874  AGORA_IID_SIGNALING_ENGINE = 8,
875  AGORA_IID_MEDIA_ENGINE_REGULATOR = 9,
876  AGORA_IID_LOCAL_SPATIAL_AUDIO = 11,
877  AGORA_IID_STATE_SYNC = 13,
878  AGORA_IID_META_SERVICE = 14,
879  AGORA_IID_MUSIC_CONTENT_CENTER = 15,
880  AGORA_IID_H265_TRANSCODER = 16,
881 };
882 
886 enum QUALITY_TYPE {
891  QUALITY_UNKNOWN __deprecated = 0,
895  QUALITY_EXCELLENT = 1,
900  QUALITY_GOOD = 2,
904  QUALITY_POOR = 3,
908  QUALITY_BAD = 4,
912  QUALITY_VBAD = 5,
916  QUALITY_DOWN = 6,
920  QUALITY_UNSUPPORTED = 7,
924  QUALITY_DETECTING = 8,
925 };
926 
930 enum FIT_MODE_TYPE {
935  MODE_COVER = 1,
936 
942  MODE_CONTAIN = 2,
943 };
944 
948 enum VIDEO_ORIENTATION {
952  VIDEO_ORIENTATION_0 = 0,
956  VIDEO_ORIENTATION_90 = 90,
960  VIDEO_ORIENTATION_180 = 180,
964  VIDEO_ORIENTATION_270 = 270
965 };
966 
970 enum FRAME_RATE {
974  FRAME_RATE_FPS_1 = 1,
978  FRAME_RATE_FPS_7 = 7,
982  FRAME_RATE_FPS_10 = 10,
986  FRAME_RATE_FPS_15 = 15,
990  FRAME_RATE_FPS_24 = 24,
994  FRAME_RATE_FPS_30 = 30,
998  FRAME_RATE_FPS_60 = 60,
999 };
1000 
1001 enum FRAME_WIDTH {
1002  FRAME_WIDTH_960 = 960,
1003 };
1004 
1005 enum FRAME_HEIGHT {
1006  FRAME_HEIGHT_540 = 540,
1007 };
1008 
1012 enum VIDEO_FRAME_TYPE {
1014  VIDEO_FRAME_TYPE_BLANK_FRAME = 0,
1016  VIDEO_FRAME_TYPE_KEY_FRAME = 3,
1018  VIDEO_FRAME_TYPE_DELTA_FRAME = 4,
1020  VIDEO_FRAME_TYPE_B_FRAME = 5,
1022  VIDEO_FRAME_TYPE_DROPPABLE_FRAME = 6,
1024  VIDEO_FRAME_TYPE_UNKNOW
1025 };
1026 
1030 enum ORIENTATION_MODE {
1038  ORIENTATION_MODE_ADAPTIVE = 0,
1045  ORIENTATION_MODE_FIXED_LANDSCAPE = 1,
1052  ORIENTATION_MODE_FIXED_PORTRAIT = 2,
1053 };
1054 
1058 enum DEGRADATION_PREFERENCE {
1065  MAINTAIN_AUTO = -1,
1073  MAINTAIN_QUALITY = 0,
1079  MAINTAIN_FRAMERATE = 1,
1086  MAINTAIN_BALANCED = 2,
1090  MAINTAIN_RESOLUTION = 3,
1094  DISABLED = 100,
1095 };
1096 
1104  int width;
1108  int height;
1109  VideoDimensions() : width(640), height(480) {}
1110  VideoDimensions(int w, int h) : width(w), height(h) {}
1111  bool operator==(const VideoDimensions& rhs) const {
1112  return width == rhs.width && height == rhs.height;
1113  }
1114 };
1115 
1121 const int STANDARD_BITRATE = 0;
1122 
1130 const int COMPATIBLE_BITRATE = -1;
1131 
1135 const int DEFAULT_MIN_BITRATE = -1;
1136 
1140 const int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
1141 
1145 enum SCREEN_CAPTURE_FRAMERATE_CAPABILITY {
1146  SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS = 0,
1147  SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS = 1,
1148  SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS = 2,
1149 };
1150 
1154 enum VIDEO_CODEC_CAPABILITY_LEVEL {
1156  CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1,
1158  CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT = 5,
1160  CODEC_CAPABILITY_LEVEL_1080P30FPS = 10,
1162  CODEC_CAPABILITY_LEVEL_1080P60FPS = 20,
1164  CODEC_CAPABILITY_LEVEL_4K60FPS = 30,
1165 };
1166 
1170 enum VIDEO_CODEC_TYPE {
1176  VIDEO_CODEC_NONE = 0,
1180  VIDEO_CODEC_VP8 = 1,
1184  VIDEO_CODEC_H264 = 2,
1188  VIDEO_CODEC_H265 = 3,
1194  VIDEO_CODEC_GENERIC = 6,
1199  VIDEO_CODEC_GENERIC_H264 = 7,
1204  VIDEO_CODEC_AV1 = 12,
1208  VIDEO_CODEC_VP9 = 13,
1212  VIDEO_CODEC_GENERIC_JPEG = 20,
1213 };
1214 
1218 enum CAMERA_FOCAL_LENGTH_TYPE {
1222  CAMERA_FOCAL_LENGTH_DEFAULT = 0,
1226  CAMERA_FOCAL_LENGTH_WIDE_ANGLE = 1,
1230  CAMERA_FOCAL_LENGTH_ULTRA_WIDE = 2,
1234  CAMERA_FOCAL_LENGTH_TELEPHOTO = 3,
1235 };
1236 
1240 enum TCcMode {
1244  CC_ENABLED,
1248  CC_DISABLED,
1249 };
1250 
1258  TCcMode ccMode;
1263  VIDEO_CODEC_TYPE codecType;
1264 
1325 
1326  SenderOptions() : ccMode(CC_ENABLED), codecType(VIDEO_CODEC_H265), targetBitrate(6500) {}
1327 };
1328 
1332 enum AUDIO_CODEC_TYPE {
1336  AUDIO_CODEC_OPUS = 1,
1337  // kIsac = 2,
1341  AUDIO_CODEC_PCMA = 3,
1345  AUDIO_CODEC_PCMU = 4,
1349  AUDIO_CODEC_G722 = 5,
1350  // kIlbc = 6,
1352  // AUDIO_CODEC_AAC = 7,
1356  AUDIO_CODEC_AACLC = 8,
1360  AUDIO_CODEC_HEAAC = 9,
1364  AUDIO_CODEC_JC1 = 10,
1368  AUDIO_CODEC_HEAAC2 = 11,
1372  AUDIO_CODEC_LPCNET = 12,
1376  AUDIO_CODEC_OPUSMC = 13,
1377 };
1378 
1382 enum AUDIO_ENCODING_TYPE {
1387  AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101,
1392  AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102,
1397  AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201,
1402  AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202,
1407  AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203,
1412  AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302,
1417  AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303,
1422  AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101,
1427  AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102,
1432  AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302,
1437  AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303,
1438 };
1439 
1443 enum WATERMARK_FIT_MODE {
1448  FIT_MODE_COVER_POSITION,
1453  FIT_MODE_USE_IMAGE_RATIO
1454 };
1455 
1461 
1467  bool speech;
1474 };
1475 
1481  : codec(AUDIO_CODEC_AACLC),
1482  sampleRateHz(0),
1483  samplesPerChannel(0),
1484  numberOfChannels(0),
1485  captureTimeMs(0) {}
1486 
1488  : codec(rhs.codec),
1497  AUDIO_CODEC_TYPE codec;
1516 
1520  int64_t captureTimeMs;
1521 };
1527  : samplesPerChannel(0), channelNum(0), samplesOut(0), elapsedTimeMs(0), ntpTimeMs(0) {}
1528 
1531  channelNum(rhs.channelNum),
1532  samplesOut(rhs.samplesOut),
1534  ntpTimeMs(rhs.ntpTimeMs) {}
1535 
1540 
1541  int16_t channelNum;
1542 
1543  // Output
1547  size_t samplesOut;
1551  int64_t elapsedTimeMs;
1555  int64_t ntpTimeMs;
1556 };
1560 enum H264PacketizeMode {
1564  NonInterleaved = 0, // Mode 1 - STAP-A, FU-A is allowed
1568  SingleNalUnit, // Mode 0 - only single NALU allowed
1569 };
1570 
1574 enum VIDEO_STREAM_TYPE {
1578  VIDEO_STREAM_HIGH = 0,
1582  VIDEO_STREAM_LOW = 1,
1586  VIDEO_STREAM_LAYER_1 = 4,
1590  VIDEO_STREAM_LAYER_2 = 5,
1594  VIDEO_STREAM_LAYER_3 = 6,
1598  VIDEO_STREAM_LAYER_4 = 7,
1602  VIDEO_STREAM_LAYER_5 = 8,
1606  VIDEO_STREAM_LAYER_6 = 9,
1607 
1608 };
1609 
1624 
1626 };
1627 
1630 enum MAX_USER_ACCOUNT_LENGTH_TYPE {
1633  MAX_USER_ACCOUNT_LENGTH = 256
1634 };
1635 
1642  : uid(0),
1643  codecType(VIDEO_CODEC_H264),
1644  width(0),
1645  height(0),
1646  framesPerSecond(0),
1647  frameType(VIDEO_FRAME_TYPE_BLANK_FRAME),
1648  rotation(VIDEO_ORIENTATION_0),
1649  trackId(0),
1650  captureTimeMs(0),
1651  decodeTimeMs(0),
1652  streamType(VIDEO_STREAM_HIGH),
1653  presentationMs(-1) {}
1654 
1656  : uid(rhs.uid),
1657  codecType(rhs.codecType),
1658  width(rhs.width),
1659  height(rhs.height),
1661  frameType(rhs.frameType),
1662  rotation(rhs.rotation),
1663  trackId(rhs.trackId),
1666  streamType(rhs.streamType),
1667  presentationMs(rhs.presentationMs) {}
1668 
1669  EncodedVideoFrameInfo& operator=(const EncodedVideoFrameInfo& rhs) {
1670  if (this == &rhs) return *this;
1671  uid = rhs.uid;
1672  codecType = rhs.codecType;
1673  width = rhs.width;
1674  height = rhs.height;
1676  frameType = rhs.frameType;
1677  rotation = rhs.rotation;
1678  trackId = rhs.trackId;
1680  decodeTimeMs = rhs.decodeTimeMs;
1681  streamType = rhs.streamType;
1682  presentationMs = rhs.presentationMs;
1683  return *this;
1684  }
1685 
1689  uid_t uid;
1694  VIDEO_CODEC_TYPE codecType;
1698  int width;
1702  int height;
1712  VIDEO_FRAME_TYPE frameType;
1716  VIDEO_ORIENTATION rotation;
1720  int trackId; // This can be reserved for multiple video tracks, we need to create different ssrc
1721  // and additional payload for later implementation.
1725  int64_t captureTimeMs;
1729  int64_t decodeTimeMs;
1733  VIDEO_STREAM_TYPE streamType;
1734 
1735  // @technical preview
1736  int64_t presentationMs;
1737 };
1738 
1742 enum COMPRESSION_PREFERENCE {
1749  PREFER_COMPRESSION_AUTO = -1,
1753  PREFER_LOW_LATENCY = 0,
1757  PREFER_QUALITY = 1,
1758 };
1759 
1763 enum ENCODING_PREFERENCE {
1767  PREFER_AUTO = -1,
1771  PREFER_SOFTWARE = 0,
1775  PREFER_HARDWARE = 1,
1776 };
1777 
1785  ENCODING_PREFERENCE encodingPreference;
1786 
1790  COMPRESSION_PREFERENCE compressionPreference;
1791 
1797 
1798  AdvanceOptions() : encodingPreference(PREFER_AUTO),
1799  compressionPreference(PREFER_COMPRESSION_AUTO),
1800  encodeAlpha(false) {}
1801 
1802  AdvanceOptions(ENCODING_PREFERENCE encoding_preference,
1803  COMPRESSION_PREFERENCE compression_preference,
1804  bool encode_alpha) :
1805  encodingPreference(encoding_preference),
1806  compressionPreference(compression_preference),
1807  encodeAlpha(encode_alpha) {}
1808 
1809  bool operator==(const AdvanceOptions& rhs) const {
1810  return encodingPreference == rhs.encodingPreference &&
1811  compressionPreference == rhs.compressionPreference &&
1812  encodeAlpha == rhs.encodeAlpha;
1813  }
1814 };
1815 
1819 enum VIDEO_MIRROR_MODE_TYPE {
1823  VIDEO_MIRROR_MODE_AUTO = 0,
1827  VIDEO_MIRROR_MODE_ENABLED = 1,
1831  VIDEO_MIRROR_MODE_DISABLED = 2,
1832 };
1833 
1834 #if defined(__APPLE__) && TARGET_OS_IOS
1835 
1838 enum CAMERA_FORMAT_TYPE {
1840  CAMERA_FORMAT_NV12,
1842  CAMERA_FORMAT_BGRA,
1843 };
1844 #endif
1845 
1846 enum VIDEO_MODULE_TYPE {
1848  VIDEO_MODULE_CAPTURER = 0,
1850  VIDEO_MODULE_SOFTWARE_ENCODER = 1,
1852  VIDEO_MODULE_HARDWARE_ENCODER = 2,
1854  VIDEO_MODULE_SOFTWARE_DECODER = 3,
1856  VIDEO_MODULE_HARDWARE_DECODER = 4,
1858  VIDEO_MODULE_RENDERER = 5,
1859 };
1860 
1861 enum HDR_CAPABILITY {
1863  HDR_CAPABILITY_UNKNOWN = -1,
1865  HDR_CAPABILITY_UNSUPPORTED = 0,
1867  HDR_CAPABILITY_SUPPORTED = 1,
1868 };
1869 
1871 enum CODEC_CAP_MASK {
1873  CODEC_CAP_MASK_NONE = 0,
1874 
1876  CODEC_CAP_MASK_HW_DEC = 1 << 0,
1877 
1879  CODEC_CAP_MASK_HW_ENC = 1 << 1,
1880 
1882  CODEC_CAP_MASK_SW_DEC = 1 << 2,
1883 
1885  CODEC_CAP_MASK_SW_ENC = 1 << 3,
1886 };
1887 
1889  VIDEO_CODEC_CAPABILITY_LEVEL hwDecodingLevel;
1890  VIDEO_CODEC_CAPABILITY_LEVEL swDecodingLevel;
1891 
1892  CodecCapLevels()
1893  : hwDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED),
1894  swDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED) {}
1895 };
1896 
1900  VIDEO_CODEC_TYPE codecType;
1905 
1906  CodecCapInfo() : codecType(VIDEO_CODEC_NONE), codecCapMask(0) {}
1907 };
1908 
1915  CAMERA_FOCAL_LENGTH_TYPE focalLengthType;
1916 };
1917 
1925  VIDEO_CODEC_TYPE codecType;
1991  int bitrate;
1992 
2012  ORIENTATION_MODE orientationMode;
2016  DEGRADATION_PREFERENCE degradationPreference;
2017 
2023  VIDEO_MIRROR_MODE_TYPE mirrorMode;
2024 
2029 
2030  VideoEncoderConfiguration(const VideoDimensions& d, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror = VIDEO_MIRROR_MODE_DISABLED)
2031  : codecType(VIDEO_CODEC_NONE),
2032  dimensions(d),
2033  frameRate(f),
2034  bitrate(b),
2035  minBitrate(DEFAULT_MIN_BITRATE),
2036  orientationMode(m),
2037  degradationPreference(MAINTAIN_AUTO),
2038  mirrorMode(mirror),
2039  advanceOptions(PREFER_AUTO, PREFER_COMPRESSION_AUTO, false) {}
2040  VideoEncoderConfiguration(int width, int height, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror = VIDEO_MIRROR_MODE_DISABLED)
2041  : codecType(VIDEO_CODEC_NONE),
2042  dimensions(width, height),
2043  frameRate(f),
2044  bitrate(b),
2045  minBitrate(DEFAULT_MIN_BITRATE),
2046  orientationMode(m),
2047  degradationPreference(MAINTAIN_AUTO),
2048  mirrorMode(mirror),
2049  advanceOptions(PREFER_AUTO, PREFER_COMPRESSION_AUTO, false) {}
2050  VideoEncoderConfiguration(const VideoEncoderConfiguration& config)
2051  : codecType(config.codecType),
2052  dimensions(config.dimensions),
2053  frameRate(config.frameRate),
2054  bitrate(config.bitrate),
2055  minBitrate(config.minBitrate),
2058  mirrorMode(config.mirrorMode),
2059  advanceOptions(config.advanceOptions) {}
2060  VideoEncoderConfiguration()
2061  : codecType(VIDEO_CODEC_NONE),
2062  dimensions(FRAME_WIDTH_960, FRAME_HEIGHT_540),
2063  frameRate(FRAME_RATE_FPS_15),
2064  bitrate(STANDARD_BITRATE),
2065  minBitrate(DEFAULT_MIN_BITRATE),
2066  orientationMode(ORIENTATION_MODE_ADAPTIVE),
2067  degradationPreference(MAINTAIN_AUTO),
2068  mirrorMode(VIDEO_MIRROR_MODE_DISABLED),
2069  advanceOptions(PREFER_AUTO, PREFER_COMPRESSION_AUTO, false) {}
2070 
2071  VideoEncoderConfiguration& operator=(const VideoEncoderConfiguration& rhs) {
2072  if (this == &rhs) return *this;
2073  codecType = rhs.codecType;
2074  dimensions = rhs.dimensions;
2075  frameRate = rhs.frameRate;
2076  bitrate = rhs.bitrate;
2077  minBitrate = rhs.minBitrate;
2078  orientationMode = rhs.orientationMode;
2079  degradationPreference = rhs.degradationPreference;
2080  mirrorMode = rhs.mirrorMode;
2081  advanceOptions = rhs.advanceOptions;
2082  return *this;
2083  }
2084 };
2085 
2110  bool ordered;
2111 };
2112 
2116 enum SIMULCAST_STREAM_MODE {
2117  /*
2118  * disable simulcast stream until receive request for enable simulcast stream by other broadcaster
2119  */
2120  AUTO_SIMULCAST_STREAM = -1,
2121  /*
2122  * disable simulcast stream
2123  */
2124  DISABLE_SIMULCAST_STREAM = 0,
2125  /*
2126  * always enable simulcast stream
2127  */
2128  ENABLE_SIMULCAST_STREAM = 1,
2129 };
2130 
2148  SimulcastStreamConfig() : dimensions(160, 120), kBitrate(65), framerate(5) {}
2150  bool operator==(const SimulcastStreamConfig& rhs) const {
2151  return dimensions == rhs.dimensions && kBitrate == rhs.kBitrate && framerate == rhs.framerate;
2152  }
2153 };
2154 
2195  };
2208  bool enable;
2209  StreamLayerConfig() : dimensions(0, 0), framerate(0), enable(false) {}
2210  };
2211 
2216 };
2221 struct Rectangle {
2225  int x;
2229  int y;
2233  int width;
2237  int height;
2238 
2239  Rectangle() : x(0), y(0), width(0), height(0) {}
2240  Rectangle(int xx, int yy, int ww, int hh) : x(xx), y(yy), width(ww), height(hh) {}
2241 };
2242 
2259  float xRatio;
2265  float yRatio;
2272  float widthRatio;
2273 
2274  WatermarkRatio() : xRatio(0.0), yRatio(0.0), widthRatio(0.0) {}
2275  WatermarkRatio(float x, float y, float width) : xRatio(x), yRatio(y), widthRatio(width) {}
2276 };
2277 
2306  WATERMARK_FIT_MODE mode;
2307 
2309  : visibleInPreview(true),
2310  positionInLandscapeMode(0, 0, 0, 0),
2311  positionInPortraitMode(0, 0, 0, 0),
2312  mode(FIT_MODE_COVER_POSITION) {}
2313 };
2314 
2318 struct RtcStats {
2322  unsigned int duration;
2326  unsigned int txBytes;
2330  unsigned int rxBytes;
2334  unsigned int txAudioBytes;
2338  unsigned int txVideoBytes;
2342  unsigned int rxAudioBytes;
2346  unsigned int rxVideoBytes;
2350  unsigned short txKBitRate;
2354  unsigned short rxKBitRate;
2358  unsigned short rxAudioKBitRate;
2362  unsigned short txAudioKBitRate;
2366  unsigned short rxVideoKBitRate;
2370  unsigned short txVideoKBitRate;
2374  unsigned short lastmileDelay;
2378  unsigned int userCount;
2386  double cpuAppUsage;
2478  RtcStats()
2479  : duration(0),
2480  txBytes(0),
2481  rxBytes(0),
2482  txAudioBytes(0),
2483  txVideoBytes(0),
2484  rxAudioBytes(0),
2485  rxVideoBytes(0),
2486  txKBitRate(0),
2487  rxKBitRate(0),
2488  rxAudioKBitRate(0),
2489  txAudioKBitRate(0),
2490  rxVideoKBitRate(0),
2491  txVideoKBitRate(0),
2492  lastmileDelay(0),
2493  userCount(0),
2494  cpuAppUsage(0.0),
2495  cpuTotalUsage(0.0),
2496  gatewayRtt(0),
2497  memoryAppUsageRatio(0.0),
2498  memoryTotalUsageRatio(0.0),
2500  connectTimeMs(0),
2510  txPacketLossRate(0),
2511  rxPacketLossRate(0) {}
2512 };
2513 
2517 enum CLIENT_ROLE_TYPE {
2521  CLIENT_ROLE_BROADCASTER = 1,
2525  CLIENT_ROLE_AUDIENCE = 2,
2526 };
2527 
2532 enum QUALITY_ADAPT_INDICATION {
2536  ADAPT_NONE = 0,
2540  ADAPT_UP_BANDWIDTH = 1,
2544  ADAPT_DOWN_BANDWIDTH = 2,
2545 };
2546 
2551 enum AUDIENCE_LATENCY_LEVEL_TYPE {
2555  AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1,
2559  AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2,
2560 };
2561 
2570  AUDIENCE_LATENCY_LEVEL_TYPE audienceLatencyLevel;
2571 
2572  ClientRoleOptions() : audienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY) {}
2573 };
2574 
2578 enum EXPERIENCE_QUALITY_TYPE {
2580  EXPERIENCE_QUALITY_GOOD = 0,
2582  EXPERIENCE_QUALITY_BAD = 1,
2583 };
2584 
2588 enum EXPERIENCE_POOR_REASON {
2592  EXPERIENCE_REASON_NONE = 0,
2596  REMOTE_NETWORK_QUALITY_POOR = 1,
2600  LOCAL_NETWORK_QUALITY_POOR = 2,
2604  WIRELESS_SIGNAL_POOR = 4,
2609  WIFI_BLUETOOTH_COEXIST = 8,
2610 };
2611 
2615 enum AUDIO_AINS_MODE {
2619  AINS_MODE_BALANCED = 0,
2623  AINS_MODE_AGGRESSIVE = 1,
2627  AINS_MODE_ULTRALOWLATENCY = 2
2628 };
2629 
2633 enum AUDIO_PROFILE_TYPE {
2643  AUDIO_PROFILE_DEFAULT = 0,
2647  AUDIO_PROFILE_SPEECH_STANDARD = 1,
2651  AUDIO_PROFILE_MUSIC_STANDARD = 2,
2658  AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3,
2662  AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4,
2669  AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5,
2673  AUDIO_PROFILE_IOT = 6,
2674  AUDIO_PROFILE_NUM = 7
2675 };
2676 
2680 enum AUDIO_SCENARIO_TYPE {
2685  AUDIO_SCENARIO_DEFAULT = 0,
2691  AUDIO_SCENARIO_GAME_STREAMING = 3,
2697  AUDIO_SCENARIO_CHATROOM = 5,
2702  AUDIO_SCENARIO_CHORUS = 7,
2706  AUDIO_SCENARIO_MEETING = 8,
2710  AUDIO_SCENARIO_AI_SERVER = 9,
2714  AUDIO_SCENARIO_AI_CLIENT = 10,
2718  AUDIO_SCENARIO_NUM = 11,
2719 };
2720 
2724 struct VideoFormat {
2725  OPTIONAL_ENUM_SIZE_T{
2727  kMaxWidthInPixels = 3840,
2729  kMaxHeightInPixels = 2160,
2731  kMaxFps = 60,
2732  };
2733 
2737  int width; // Number of pixels.
2741  int height; // Number of pixels.
2745  int fps;
2746  VideoFormat() : width(FRAME_WIDTH_960), height(FRAME_HEIGHT_540), fps(FRAME_RATE_FPS_15) {}
2747  VideoFormat(int w, int h, int f) : width(w), height(h), fps(f) {}
2748 
2749  bool operator<(const VideoFormat& fmt) const {
2750  if (height != fmt.height) {
2751  return height < fmt.height;
2752  } else if (width != fmt.width) {
2753  return width < fmt.width;
2754  } else {
2755  return fps < fmt.fps;
2756  }
2757  }
2758  bool operator==(const VideoFormat& fmt) const {
2759  return width == fmt.width && height == fmt.height && fps == fmt.fps;
2760  }
2761  bool operator!=(const VideoFormat& fmt) const { return !operator==(fmt); }
2762 };
2763 
2767 enum VIDEO_CONTENT_HINT {
2771  CONTENT_HINT_NONE,
2778  CONTENT_HINT_MOTION,
2784  CONTENT_HINT_DETAILS
2785 };
2789 enum SCREEN_SCENARIO_TYPE {
2795  SCREEN_SCENARIO_DOCUMENT = 1,
2800  SCREEN_SCENARIO_GAMING = 2,
2805  SCREEN_SCENARIO_VIDEO = 3,
2811  SCREEN_SCENARIO_RDC = 4,
2812 };
2813 
2817 enum VIDEO_APPLICATION_SCENARIO_TYPE {
2821  APPLICATION_SCENARIO_GENERAL = 0,
2825  APPLICATION_SCENARIO_MEETING = 1,
2829  APPLICATION_SCENARIO_1V1 = 2,
2833  APPLICATION_SCENARIO_LIVESHOW = 3,
2834 };
2835 
2839 enum VIDEO_QOE_PREFERENCE_TYPE {
2843  VIDEO_QOE_PREFERENCE_BALANCE = 1,
2847  VIDEO_QOE_PREFERENCE_DELAY_FIRST = 2,
2851  VIDEO_QOE_PREFERENCE_PICTURE_QUALITY_FIRST = 3,
2855  VIDEO_QOE_PREFERENCE_FLUENCY_FIRST = 4,
2856 
2857 };
2858 
2862 enum CAPTURE_BRIGHTNESS_LEVEL_TYPE {
2867  CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1,
2870  CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0,
2873  CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1,
2876  CAPTURE_BRIGHTNESS_LEVEL_DARK = 2,
2877 };
2878 
2879 enum CAMERA_STABILIZATION_MODE {
2882  CAMERA_STABILIZATION_MODE_OFF = -1,
2885  CAMERA_STABILIZATION_MODE_AUTO = 0,
2888  CAMERA_STABILIZATION_MODE_LEVEL_1 = 1,
2891  CAMERA_STABILIZATION_MODE_LEVEL_2 = 2,
2894  CAMERA_STABILIZATION_MODE_LEVEL_3 = 3,
2897  CAMERA_STABILIZATION_MODE_MAX_LEVEL = CAMERA_STABILIZATION_MODE_LEVEL_3,
2898 };
2899 
2903 enum LOCAL_AUDIO_STREAM_STATE {
2907  LOCAL_AUDIO_STREAM_STATE_STOPPED = 0,
2911  LOCAL_AUDIO_STREAM_STATE_RECORDING = 1,
2915  LOCAL_AUDIO_STREAM_STATE_ENCODING = 2,
2919  LOCAL_AUDIO_STREAM_STATE_FAILED = 3
2920 };
2921 
2925 enum LOCAL_AUDIO_STREAM_REASON {
2929  LOCAL_AUDIO_STREAM_REASON_OK = 0,
2934  LOCAL_AUDIO_STREAM_REASON_FAILURE = 1,
2938  LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
2945  LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY = 3,
2949  LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE = 4,
2953  LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE = 5,
2956  LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE = 6,
2959  LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE = 7,
2963  LOCAL_AUDIO_STREAM_REASON_INTERRUPTED = 8,
2966  LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID = 9,
2969  LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID = 10,
2970 };
2971 
2974 enum LOCAL_VIDEO_STREAM_STATE {
2978  LOCAL_VIDEO_STREAM_STATE_STOPPED = 0,
2983  LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1,
2987  LOCAL_VIDEO_STREAM_STATE_ENCODING = 2,
2991  LOCAL_VIDEO_STREAM_STATE_FAILED = 3
2992 };
2993 
2997 enum LOCAL_VIDEO_STREAM_REASON {
3001  LOCAL_VIDEO_STREAM_REASON_OK = 0,
3005  LOCAL_VIDEO_STREAM_REASON_FAILURE = 1,
3010  LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
3015  LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY = 3,
3021  LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE = 4,
3025  LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT = 5,
3030  LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND = 6,
3037  LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7,
3043  LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND = 8,
3048  LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED = 9,
3053  LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID = 10,
3058  LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT = 14,
3063  LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR = 15,
3067  LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE = 101,
3073  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11,
3088  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED = 12,
3090  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED = 13,
3092  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20,
3094  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE = 21,
3096  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION = 22,
3102  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK = 24,
3105  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN = 25,
3107  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN = 26,
3109  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED = 27,
3117  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED = 28,
3119  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED = 29,
3121  LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED = 30,
3122 
3123 };
3124 
3128 enum REMOTE_AUDIO_STATE {
3134  REMOTE_AUDIO_STATE_STOPPED =
3135  0, // Default state, audio is started or remote user disabled/muted audio stream
3139  REMOTE_AUDIO_STATE_STARTING = 1, // The first audio frame packet has been received
3145  REMOTE_AUDIO_STATE_DECODING =
3146  2, // The first remote audio frame has been decoded or fronzen state ends
3151  REMOTE_AUDIO_STATE_FROZEN = 3, // Remote audio is frozen, probably due to network issue
3156  REMOTE_AUDIO_STATE_FAILED = 4, // Remote audio play failed
3157 };
3158 
3162 enum REMOTE_AUDIO_STATE_REASON {
3166  REMOTE_AUDIO_REASON_INTERNAL = 0,
3170  REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1,
3174  REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2,
3179  REMOTE_AUDIO_REASON_LOCAL_MUTED = 3,
3184  REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4,
3189  REMOTE_AUDIO_REASON_REMOTE_MUTED = 5,
3194  REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6,
3198  REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7,
3202  REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE = 8,
3206  REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED = 9,
3207 };
3208 
3212 enum REMOTE_VIDEO_STATE {
3219  REMOTE_VIDEO_STATE_STOPPED = 0,
3223  REMOTE_VIDEO_STATE_STARTING = 1,
3230  REMOTE_VIDEO_STATE_DECODING = 2,
3234  REMOTE_VIDEO_STATE_FROZEN = 3,
3238  REMOTE_VIDEO_STATE_FAILED = 4,
3239 };
3243 enum REMOTE_VIDEO_STATE_REASON {
3247  REMOTE_VIDEO_STATE_REASON_INTERNAL = 0,
3251  REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1,
3255  REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2,
3259  REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3,
3263  REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4,
3267  REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5,
3271  REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6,
3275  REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7,
3279  REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8,
3283  REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9,
3286  REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_LOW = 10,
3289  REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_HIGH = 11,
3292  REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND = 12,
3293 
3296  REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT = 13,
3297 
3298 };
3299 
3303 enum REMOTE_USER_STATE {
3307  USER_STATE_MUTE_AUDIO = (1 << 0),
3311  USER_STATE_MUTE_VIDEO = (1 << 1),
3315  USER_STATE_ENABLE_VIDEO = (1 << 4),
3319  USER_STATE_ENABLE_LOCAL_VIDEO = (1 << 8),
3320 };
3321 
3327  VideoTrackInfo()
3328  : isLocal(false),
3329  ownerUid(0),
3330  trackId(0),
3331  channelId(OPTIONAL_NULLPTR),
3332  codecType(VIDEO_CODEC_H265),
3333  encodedFrameOnly(false),
3334  sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
3335  observationPosition(agora::media::base::POSITION_POST_CAPTURER) {}
3341  bool isLocal;
3345  uid_t ownerUid;
3349  track_id_t trackId;
3353  const char* channelId;
3357  VIDEO_CODEC_TYPE codecType;
3367  VIDEO_SOURCE_TYPE sourceType;
3372 };
3373 
3378 enum REMOTE_VIDEO_DOWNSCALE_LEVEL {
3382  REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE,
3386  REMOTE_VIDEO_DOWNSCALE_LEVEL_1,
3390  REMOTE_VIDEO_DOWNSCALE_LEVEL_2,
3394  REMOTE_VIDEO_DOWNSCALE_LEVEL_3,
3398  REMOTE_VIDEO_DOWNSCALE_LEVEL_4,
3399 };
3400 
3411  uid_t uid;
3417  unsigned int volume; // [0,255]
3428  unsigned int vad;
3434  double voicePitch;
3435 
3436  AudioVolumeInfo() : uid(0), volume(0), vad(0), voicePitch(0.0) {}
3437 };
3438 
3442 struct DeviceInfo {
3443  /*
3444  * Whether the audio device supports ultra-low-latency capture and playback:
3445  * - `true`: The device supports ultra-low-latency capture and playback.
3446  * - `false`: The device does not support ultra-low-latency capture and playback.
3447  */
3448  bool isLowLatencyAudioSupported;
3449 
3450  DeviceInfo() : isLowLatencyAudioSupported(false) {}
3451 };
3452 
3457  public:
3458  virtual ~IPacketObserver() {}
3462  struct Packet {
3468  const unsigned char* buffer;
3472  unsigned int size;
3473 
3474  Packet() : buffer(OPTIONAL_NULLPTR), size(0) {}
3475  };
3483  virtual bool onSendAudioPacket(Packet& packet) = 0;
3491  virtual bool onSendVideoPacket(Packet& packet) = 0;
3499  virtual bool onReceiveAudioPacket(Packet& packet) = 0;
3507  virtual bool onReceiveVideoPacket(Packet& packet) = 0;
3508 };
3509 
3513 enum AUDIO_SAMPLE_RATE_TYPE {
3517  AUDIO_SAMPLE_RATE_32000 = 32000,
3521  AUDIO_SAMPLE_RATE_44100 = 44100,
3525  AUDIO_SAMPLE_RATE_48000 = 48000,
3526 };
3530 enum VIDEO_CODEC_TYPE_FOR_STREAM {
3534  VIDEO_CODEC_H264_FOR_STREAM = 1,
3538  VIDEO_CODEC_H265_FOR_STREAM = 2,
3539 };
3540 
3544 enum VIDEO_CODEC_PROFILE_TYPE {
3548  VIDEO_CODEC_PROFILE_BASELINE = 66,
3553  VIDEO_CODEC_PROFILE_MAIN = 77,
3557  VIDEO_CODEC_PROFILE_HIGH = 100,
3558 };
3559 
3563 enum AUDIO_CODEC_PROFILE_TYPE {
3567  AUDIO_CODEC_PROFILE_LC_AAC = 0,
3571  AUDIO_CODEC_PROFILE_HE_AAC = 1,
3575  AUDIO_CODEC_PROFILE_HE_AAC_V2 = 2,
3576 };
3577 
3602  unsigned short txPacketLossRate;
3619 };
3620 
3624 enum RTMP_STREAM_PUBLISH_STATE {
3629  RTMP_STREAM_PUBLISH_STATE_IDLE = 0,
3634  RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1,
3639  RTMP_STREAM_PUBLISH_STATE_RUNNING = 2,
3650  RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3,
3656  RTMP_STREAM_PUBLISH_STATE_FAILURE = 4,
3661  RTMP_STREAM_PUBLISH_STATE_DISCONNECTING = 5,
3662 };
3663 
3667 enum RTMP_STREAM_PUBLISH_REASON {
3671  RTMP_STREAM_PUBLISH_REASON_OK = 0,
3678  RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT = 1,
3682  RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED = 2,
3687  RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT = 3,
3692  RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR = 4,
3696  RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR = 5,
3700  RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN = 6,
3704  RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT = 7,
3708  RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED = 8,
3712  RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND = 9,
3717  RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED = 10,
3722  RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER =
3723  11, // Note: match to ERR_PUBLISH_STREAM_NOT_BROADCASTER in AgoraBase.h
3729  RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM =
3730  13, // Note: match to ERR_PUBLISH_STREAM_TRANSCODING_NO_MIX_STREAM in AgoraBase.h
3734  RTMP_STREAM_PUBLISH_REASON_NET_DOWN = 14, // Note: match to ERR_NET_DOWN in AgoraBase.h
3738  RTMP_STREAM_PUBLISH_REASON_INVALID_APPID =
3739  15, // Note: match to ERR_PUBLISH_STREAM_APPID_INVALID in AgoraBase.h
3741  RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE = 16,
3746  RTMP_STREAM_UNPUBLISH_REASON_OK = 100,
3747 };
3748 
3750 enum RTMP_STREAMING_EVENT {
3755  RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1,
3760  RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2,
3764  RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT = 3,
3768  RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN = 4,
3769 };
3770 
3774 typedef struct RtcImage {
3779  const char* url;
3784  int x;
3789  int y;
3793  int width;
3797  int height;
3805  int zOrder;
3811  double alpha;
3812 
3813  RtcImage() : url(OPTIONAL_NULLPTR), x(0), y(0), width(0), height(0), zOrder(0), alpha(1.0) {}
3814 } RtcImage;
3822  LiveStreamAdvancedFeature() : featureName(OPTIONAL_NULLPTR), opened(false) {}
3823  LiveStreamAdvancedFeature(const char* feat_name, bool open)
3824  : featureName(feat_name), opened(open) {}
3826  // static const char* LBHQ = "lbhq";
3828  // static const char* VEO = "veo";
3829 
3834  const char* featureName;
3835 
3841  bool opened;
3842 };
3843 
3847 enum CONNECTION_STATE_TYPE {
3854  CONNECTION_STATE_DISCONNECTED = 1,
3863  CONNECTION_STATE_CONNECTING = 2,
3871  CONNECTION_STATE_CONNECTED = 3,
3881  CONNECTION_STATE_RECONNECTING = 4,
3890  CONNECTION_STATE_FAILED = 5,
3891 };
3892 
3900  uid_t uid;
3906  int x;
3912  int y;
3916  int width;
3920  int height;
3928  int zOrder;
3934  double alpha;
3956 
3957  TranscodingUser()
3958  : uid(0), x(0), y(0), width(0), height(0), zOrder(0), alpha(1.0), audioChannel(0) {}
3959 };
3960 
3971  int width;
3978  int height;
3991 
3998 
4006  VIDEO_CODEC_PROFILE_TYPE videoCodecProfile;
4010  unsigned int backgroundColor;
4012  VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType;
4016  unsigned int userCount;
4027 
4030  const char* metadata;
4041  unsigned int watermarkCount;
4042 
4054  unsigned int backgroundImageCount;
4055 
4058  AUDIO_SAMPLE_RATE_TYPE audioSampleRate;
4074  AUDIO_CODEC_PROFILE_TYPE audioCodecProfile;
4079 
4081  unsigned int advancedFeatureCount;
4082 
4083  LiveTranscoding()
4084  : width(360),
4085  height(640),
4086  videoBitrate(400),
4087  videoFramerate(15),
4088  lowLatency(false),
4089  videoGop(30),
4090  videoCodecProfile(VIDEO_CODEC_PROFILE_HIGH),
4091  backgroundColor(0x000000),
4092  videoCodecType(VIDEO_CODEC_H264_FOR_STREAM),
4093  userCount(0),
4094  transcodingUsers(OPTIONAL_NULLPTR),
4095  transcodingExtraInfo(OPTIONAL_NULLPTR),
4096  metadata(OPTIONAL_NULLPTR),
4097  watermark(OPTIONAL_NULLPTR),
4098  watermarkCount(0),
4099  backgroundImage(OPTIONAL_NULLPTR),
4101  audioSampleRate(AUDIO_SAMPLE_RATE_48000),
4102  audioBitrate(48),
4103  audioChannels(1),
4104  audioCodecProfile(AUDIO_CODEC_PROFILE_LC_AAC),
4105  advancedFeatures(OPTIONAL_NULLPTR),
4106  advancedFeatureCount(0) {}
4107 };
4108 
4116  VIDEO_SOURCE_TYPE sourceType;
4128  const char* imageUrl;
4137  int x;
4142  int y;
4146  int width;
4150  int height;
4157  int zOrder;
4163  double alpha;
4170  bool mirror;
4171 
4173  : sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
4174  remoteUserUid(0),
4175  imageUrl(OPTIONAL_NULLPTR),
4176  x(0),
4177  y(0),
4178  width(0),
4179  height(0),
4180  zOrder(0),
4181  alpha(1.0),
4182  mirror(false) {}
4183 };
4184 
4192  unsigned int streamCount;
4211 
4213  : streamCount(0),
4214  videoInputStreams(OPTIONAL_NULLPTR),
4216  syncWithPrimaryCamera(true) {}
4217 };
4218 
4219 enum VIDEO_TRANSCODER_ERROR {
4223  VT_ERR_VIDEO_SOURCE_NOT_READY = 1,
4227  VT_ERR_INVALID_VIDEO_SOURCE_TYPE = 2,
4231  VT_ERR_INVALID_IMAGE_PATH = 3,
4235  VT_ERR_UNSUPPORT_IMAGE_FORMAT = 4,
4239  VT_ERR_INVALID_LAYOUT = 5,
4243  VT_ERR_INTERNAL = 20
4244 };
4245 
4246 
4254  AUDIO_SOURCE_TYPE sourceType;
4264  const char* channelId;
4269  track_id_t trackId;
4270 
4271  MixedAudioStream(AUDIO_SOURCE_TYPE source)
4272  : sourceType(source),
4273  remoteUserUid(0),
4274  channelId(NULL),
4275  trackId(-1) {}
4276 
4277  MixedAudioStream(AUDIO_SOURCE_TYPE source, track_id_t track)
4278  : sourceType(source),
4279  trackId(track) {}
4280 
4281  MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char* channel)
4282  : sourceType(source),
4283  remoteUserUid(uid),
4284  channelId(channel) {}
4285 
4286  MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char* channel, track_id_t track)
4287  : sourceType(source),
4288  remoteUserUid(uid),
4289  channelId(channel),
4290  trackId(track) {}
4291 
4292 };
4293 
4301  unsigned int streamCount;
4306 
4313 
4315 };
4316 
4345 };
4346 
4350 enum LASTMILE_PROBE_RESULT_STATE {
4354  LASTMILE_PROBE_RESULT_COMPLETE = 1,
4359  LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2,
4364  LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
4365 };
4366 
4374  unsigned int packetLossRate;
4378  unsigned int jitter;
4382  unsigned int availableBandwidth;
4383 
4385 };
4386 
4394  LASTMILE_PROBE_RESULT_STATE state;
4406  unsigned int rtt;
4407 
4408  LastmileProbeResult() : state(LASTMILE_PROBE_RESULT_UNAVAILABLE), rtt(0) {}
4409 };
4410 
4414 enum CONNECTION_CHANGED_REASON_TYPE {
4418  CONNECTION_CHANGED_CONNECTING = 0,
4422  CONNECTION_CHANGED_JOIN_SUCCESS = 1,
4426  CONNECTION_CHANGED_INTERRUPTED = 2,
4431  CONNECTION_CHANGED_BANNED_BY_SERVER = 3,
4436  CONNECTION_CHANGED_JOIN_FAILED = 4,
4440  CONNECTION_CHANGED_LEAVE_CHANNEL = 5,
4444  CONNECTION_CHANGED_INVALID_APP_ID = 6,
4449  CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7,
4458  CONNECTION_CHANGED_INVALID_TOKEN = 8,
4462  CONNECTION_CHANGED_TOKEN_EXPIRED = 9,
4470  CONNECTION_CHANGED_REJECTED_BY_SERVER = 10,
4474  CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11,
4478  CONNECTION_CHANGED_RENEW_TOKEN = 12,
4483  CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13,
4488  CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14,
4492  CONNECTION_CHANGED_REJOIN_SUCCESS = 15,
4496  CONNECTION_CHANGED_LOST = 16,
4500  CONNECTION_CHANGED_ECHO_TEST = 17,
4504  CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER = 18,
4508  CONNECTION_CHANGED_SAME_UID_LOGIN = 19,
4512  CONNECTION_CHANGED_TOO_MANY_BROADCASTERS = 20,
4513 
4517  CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE = 21,
4518  /*
4519  * 22: The connection is failed due to certification verify failure.
4520  */
4521  CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE = 22,
4525  CONNECTION_CHANGED_STREAM_CHANNEL_NOT_AVAILABLE = 23,
4529  CONNECTION_CHANGED_INCONSISTENT_APPID = 24,
4530 };
4531 
4535 enum CLIENT_ROLE_CHANGE_FAILED_REASON {
4539  CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1,
4543  CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED = 2,
4548  CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT __deprecated = 3,
4553  CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED __deprecated = 4,
4554 };
4555 
4559 enum WLACC_MESSAGE_REASON {
4563  WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0,
4567  WLACC_MESSAGE_REASON_CHANNEL_CONGESTION = 1,
4568 };
4569 
4573 enum WLACC_SUGGEST_ACTION {
4577  WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI = 0,
4581  WLACC_SUGGEST_ACTION_CONNECT_SSID = 1,
4586  WLACC_SUGGEST_ACTION_CHECK_5G = 2,
4591  WLACC_SUGGEST_ACTION_MODIFY_SSID = 3,
4592 };
4593 
4597 struct WlAccStats {
4601  unsigned short e2eDelayPercent;
4605  unsigned short frozenRatioPercent;
4609  unsigned short lossRatePercent;
4610 };
4611 
4615 enum NETWORK_TYPE {
4619  NETWORK_TYPE_UNKNOWN = -1,
4623  NETWORK_TYPE_DISCONNECTED = 0,
4627  NETWORK_TYPE_LAN = 1,
4631  NETWORK_TYPE_WIFI = 2,
4635  NETWORK_TYPE_MOBILE_2G = 3,
4639  NETWORK_TYPE_MOBILE_3G = 4,
4643  NETWORK_TYPE_MOBILE_4G = 5,
4647  NETWORK_TYPE_MOBILE_5G = 6,
4648 };
4649 
4653 enum VIDEO_VIEW_SETUP_MODE {
4657  VIDEO_VIEW_SETUP_REPLACE = 0,
4661  VIDEO_VIEW_SETUP_ADD = 1,
4665  VIDEO_VIEW_SETUP_REMOVE = 2,
4666 };
4667 
4671 struct VideoCanvas {
4675  uid_t uid;
4676 
4681  uid_t subviewUid;
4685  view_t view;
4694  media::base::RENDER_MODE_TYPE renderMode;
4704  VIDEO_MIRROR_MODE_TYPE mirrorMode;
4709  VIDEO_VIEW_SETUP_MODE setupMode;
4714  VIDEO_SOURCE_TYPE sourceType;
4737  media::base::VIDEO_MODULE_POSITION position;
4738 
4739  VideoCanvas()
4740  : uid(0),
4741  subviewUid(0),
4742  view(NULL),
4743  backgroundColor(0x00000000),
4744  renderMode(media::base::RENDER_MODE_HIDDEN),
4745  mirrorMode(VIDEO_MIRROR_MODE_AUTO),
4746  setupMode(VIDEO_VIEW_SETUP_REPLACE),
4747  sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
4748  mediaPlayerId(-ERR_NOT_READY),
4749  cropArea(0, 0, 0, 0),
4750  enableAlphaMask(false),
4751  position(media::base::POSITION_POST_CAPTURER) {}
4752 
4753  VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt)
4754  : uid(0),
4755  subviewUid(0),
4756  view(v),
4757  backgroundColor(0x00000000),
4758  renderMode(m),
4759  mirrorMode(mt),
4760  setupMode(VIDEO_VIEW_SETUP_REPLACE),
4761  sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
4762  mediaPlayerId(-ERR_NOT_READY),
4763  cropArea(0, 0, 0, 0),
4764  enableAlphaMask(false),
4765  position(media::base::POSITION_POST_CAPTURER) {}
4766 
4767  VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
4768  : uid(u),
4769  subviewUid(0),
4770  view(v),
4771  backgroundColor(0x00000000),
4772  renderMode(m),
4773  mirrorMode(mt),
4774  setupMode(VIDEO_VIEW_SETUP_REPLACE),
4775  sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
4776  mediaPlayerId(-ERR_NOT_READY),
4777  cropArea(0, 0, 0, 0),
4778  enableAlphaMask(false),
4779  position(media::base::POSITION_POST_CAPTURER) {}
4780 
4781  VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u,
4782  uid_t subu)
4783  : uid(u),
4784  subviewUid(subu),
4785  view(v),
4786  backgroundColor(0x00000000),
4787  renderMode(m),
4788  mirrorMode(mt),
4789  setupMode(VIDEO_VIEW_SETUP_REPLACE),
4790  sourceType(VIDEO_SOURCE_CAMERA_PRIMARY),
4791  mediaPlayerId(-ERR_NOT_READY),
4792  cropArea(0, 0, 0, 0),
4793  enableAlphaMask(false),
4794  position(media::base::POSITION_POST_CAPTURER) {}
4795 };
4796 
4809  };
4810 
4815 
4819 
4824 
4829 
4834 
4835  BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness,
4836  float redness, float sharpness)
4837  : lighteningContrastLevel(contrastLevel),
4838  lighteningLevel(lightening),
4839  smoothnessLevel(smoothness),
4840  rednessLevel(redness),
4841  sharpnessLevel(sharpness) {}
4842 
4843  BeautyOptions()
4845  lighteningLevel(0),
4846  smoothnessLevel(0),
4847  rednessLevel(0),
4848  sharpnessLevel(0) {}
4849 };
4850 
4885  };
4886 
4890 
4897 
4898  FaceShapeAreaOptions(FACE_SHAPE_AREA shapeArea, int areaIntensity) : shapeArea(shapeArea), shapeIntensity(areaIntensity) {}
4899 
4901 };
4902 
4915  };
4916 
4920 
4924 
4926 
4928 };
4929 
4949  const char * path;
4950 
4954  float strength;
4955 
4956  FilterEffectOptions(const char * lut3dPath, float filterStrength) : path(lut3dPath), strength(filterStrength) {}
4957 
4958  FilterEffectOptions() : path(OPTIONAL_NULLPTR), strength(0.5) {}
4959 };
4960 
4972  };
4988  };
4989 
4993 
4997 
4999  : mode(lowlightMode), level(lowlightLevel) {}
5000 
5003 };
5018  };
5038  };
5042 
5046 
5048  : mode(denoiserMode), level(denoiserLevel) {}
5049 
5051 };
5052 
5063 
5073 
5074  ColorEnhanceOptions(float stength, float skinProtect)
5075  : strengthLevel(stength), skinProtectLevel(skinProtect) {}
5076 
5078 };
5079 
5107  };
5108 
5121  };
5122 
5126 
5136  unsigned int color;
5137 
5146  const char* source;
5147 
5153 
5156  color(0xffffff),
5157  source(OPTIONAL_NULLPTR),
5159 };
5160 
5162  enum SEG_MODEL_TYPE {
5163 
5164  SEG_MODEL_AI = 1,
5165  SEG_MODEL_GREEN = 2
5166  };
5167 
5168  SEG_MODEL_TYPE modelType;
5169 
5170  float greenCapacity;
5171 
5172  SegmentationProperty() : modelType(SEG_MODEL_AI), greenCapacity(0.5) {}
5173 };
5174 
5177 enum AUDIO_TRACK_TYPE {
5181  AUDIO_TRACK_INVALID = -1,
5188  AUDIO_TRACK_MIXABLE = 0,
5194  AUDIO_TRACK_DIRECT = 1,
5195 };
5196 
5212 
5214 };
5215 
5236 enum VOICE_BEAUTIFIER_PRESET {
5239  VOICE_BEAUTIFIER_OFF = 0x00000000,
5245  CHAT_BEAUTIFIER_MAGNETIC = 0x01010100,
5251  CHAT_BEAUTIFIER_FRESH = 0x01010200,
5257  CHAT_BEAUTIFIER_VITALITY = 0x01010300,
5267  SINGING_BEAUTIFIER = 0x01020100,
5270  TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100,
5273  TIMBRE_TRANSFORMATION_DEEP = 0x01030200,
5276  TIMBRE_TRANSFORMATION_MELLOW = 0x01030300,
5279  TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400,
5282  TIMBRE_TRANSFORMATION_FULL = 0x01030500,
5285  TIMBRE_TRANSFORMATION_CLEAR = 0x01030600,
5288  TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700,
5291  TIMBRE_TRANSFORMATION_RINGING = 0x01030800,
5302  ULTRA_HIGH_QUALITY_VOICE = 0x01040100
5303 };
5304 
5327 enum AUDIO_EFFECT_PRESET {
5330  AUDIO_EFFECT_OFF = 0x00000000,
5333  ROOM_ACOUSTICS_KTV = 0x02010100,
5336  ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200,
5339  ROOM_ACOUSTICS_STUDIO = 0x02010300,
5342  ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400,
5349  ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500,
5352  ROOM_ACOUSTICS_SPACIAL = 0x02010600,
5355  ROOM_ACOUSTICS_ETHEREAL = 0x02010700,
5367  ROOM_ACOUSTICS_3D_VOICE = 0x02010800,
5378  ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND = 0x02010900,
5386  ROOM_ACOUSTICS_CHORUS = 0x02010D00,
5393  VOICE_CHANGER_EFFECT_UNCLE = 0x02020100,
5399  VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200,
5405  VOICE_CHANGER_EFFECT_BOY = 0x02020300,
5412  VOICE_CHANGER_EFFECT_SISTER = 0x02020400,
5418  VOICE_CHANGER_EFFECT_GIRL = 0x02020500,
5422  VOICE_CHANGER_EFFECT_PIGKING = 0x02020600,
5425  VOICE_CHANGER_EFFECT_HULK = 0x02020700,
5432  STYLE_TRANSFORMATION_RNB = 0x02030100,
5439  STYLE_TRANSFORMATION_POPULAR = 0x02030200,
5444  PITCH_CORRECTION = 0x02040100,
5445 
5449 };
5450 
5453 enum VOICE_CONVERSION_PRESET {
5456  VOICE_CONVERSION_OFF = 0x00000000,
5460  VOICE_CHANGER_NEUTRAL = 0x03010100,
5464  VOICE_CHANGER_SWEET = 0x03010200,
5468  VOICE_CHANGER_SOLID = 0x03010300,
5472  VOICE_CHANGER_BASS = 0x03010400,
5475  VOICE_CHANGER_CARTOON = 0x03010500,
5478  VOICE_CHANGER_CHILDLIKE = 0x03010600,
5481  VOICE_CHANGER_PHONE_OPERATOR = 0x03010700,
5484  VOICE_CHANGER_MONSTER = 0x03010800,
5487  VOICE_CHANGER_TRANSFORMERS = 0x03010900,
5490  VOICE_CHANGER_GROOT = 0x03010A00,
5493  VOICE_CHANGER_DARTH_VADER = 0x03010B00,
5496  VOICE_CHANGER_IRON_LADY = 0x03010C00,
5499  VOICE_CHANGER_SHIN_CHAN = 0x03010D00,
5502  VOICE_CHANGER_GIRLISH_MAN = 0x03010E00,
5505  VOICE_CHANGER_CHIPMUNK = 0x03010F00,
5506 
5507 };
5508 
5511 enum HEADPHONE_EQUALIZER_PRESET {
5514  HEADPHONE_EQUALIZER_OFF = 0x00000000,
5517  HEADPHONE_EQUALIZER_OVEREAR = 0x04000001,
5520  HEADPHONE_EQUALIZER_INEAR = 0x04000002
5521 };
5522 
5525 enum VOICE_AI_TUNER_TYPE {
5528  VOICE_AI_TUNER_MATURE_MALE,
5531  VOICE_AI_TUNER_FRESH_MALE,
5534  VOICE_AI_TUNER_ELEGANT_FEMALE,
5537  VOICE_AI_TUNER_SWEET_FEMALE,
5540  VOICE_AI_TUNER_WARM_MALE_SINGING,
5543  VOICE_AI_TUNER_GENTLE_FEMALE_SINGING,
5546  VOICE_AI_TUNER_HUSKY_MALE_SINGING,
5549  VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING,
5552  VOICE_AI_TUNER_POWERFUL_MALE_SINGING,
5555  VOICE_AI_TUNER_DREAMY_FEMALE_SINGING,
5556 };
5557 
5587  int bitrate;
5611 
5619  unsigned int highLightColor;
5629 
5631  : dimensions(1920, 1080),
5632  frameRate(5),
5633  bitrate(STANDARD_BITRATE),
5634  captureMouseCursor(true),
5635  windowFocus(false),
5636  excludeWindowList(OPTIONAL_NULLPTR),
5637  excludeWindowCount(0),
5638  highLightWidth(0),
5639  highLightColor(0),
5640  enableHighLight(false) {}
5641  ScreenCaptureParameters(const VideoDimensions& d, int f, int b)
5642  : dimensions(d),
5643  frameRate(f),
5644  bitrate(b),
5645  captureMouseCursor(true),
5646  windowFocus(false),
5647  excludeWindowList(OPTIONAL_NULLPTR),
5648  excludeWindowCount(0),
5649  highLightWidth(0),
5650  highLightColor(0),
5651  enableHighLight(false) {}
5652  ScreenCaptureParameters(int width, int height, int f, int b)
5653  : dimensions(width, height),
5654  frameRate(f),
5655  bitrate(b),
5656  captureMouseCursor(true),
5657  windowFocus(false),
5658  excludeWindowList(OPTIONAL_NULLPTR),
5659  excludeWindowCount(0),
5660  highLightWidth(0),
5661  highLightColor(0),
5662  enableHighLight(false) {}
5663  ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs)
5664  : dimensions(width, height),
5665  frameRate(f),
5666  bitrate(b),
5667  captureMouseCursor(cur),
5668  windowFocus(fcs),
5669  excludeWindowList(OPTIONAL_NULLPTR),
5670  excludeWindowCount(0),
5671  highLightWidth(0),
5672  highLightColor(0),
5673  enableHighLight(false) {}
5674  ScreenCaptureParameters(int width, int height, int f, int b, view_t* ex, int cnt)
5675  : dimensions(width, height),
5676  frameRate(f),
5677  bitrate(b),
5678  captureMouseCursor(true),
5679  windowFocus(false),
5680  excludeWindowList(ex),
5681  excludeWindowCount(cnt),
5682  highLightWidth(0),
5683  highLightColor(0),
5684  enableHighLight(false) {}
5685  ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs, view_t* ex,
5686  int cnt)
5687  : dimensions(width, height),
5688  frameRate(f),
5689  bitrate(b),
5690  captureMouseCursor(cur),
5691  windowFocus(fcs),
5692  excludeWindowList(ex),
5693  excludeWindowCount(cnt),
5694  highLightWidth(0),
5695  highLightColor(0),
5696  enableHighLight(false) {}
5697 };
5698 
5702 enum AUDIO_RECORDING_QUALITY_TYPE {
5707  AUDIO_RECORDING_QUALITY_LOW = 0,
5712  AUDIO_RECORDING_QUALITY_MEDIUM = 1,
5717  AUDIO_RECORDING_QUALITY_HIGH = 2,
5721  AUDIO_RECORDING_QUALITY_ULTRA_HIGH = 3,
5722 };
5723 
5727 enum AUDIO_FILE_RECORDING_TYPE {
5731  AUDIO_FILE_RECORDING_MIC = 1,
5735  AUDIO_FILE_RECORDING_PLAYBACK = 2,
5739  AUDIO_FILE_RECORDING_MIXED = 3,
5740 };
5741 
5745 enum AUDIO_ENCODED_FRAME_OBSERVER_POSITION {
5749  AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1,
5753  AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2,
5757  AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3,
5758 };
5759 
5769  const char* filePath;
5775  bool encode;
5790  AUDIO_FILE_RECORDING_TYPE fileRecordingType;
5795  AUDIO_RECORDING_QUALITY_TYPE quality;
5796 
5803 
5805  : filePath(OPTIONAL_NULLPTR),
5806  encode(false),
5807  sampleRate(32000),
5808  fileRecordingType(AUDIO_FILE_RECORDING_MIXED),
5809  quality(AUDIO_RECORDING_QUALITY_LOW),
5810  recordingChannel(1) {}
5811 
5812  AudioRecordingConfiguration(const char* file_path, int sample_rate,
5813  AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
5814  : filePath(file_path),
5815  encode(false),
5816  sampleRate(sample_rate),
5817  fileRecordingType(AUDIO_FILE_RECORDING_MIXED),
5818  quality(quality_type),
5819  recordingChannel(channel) {}
5820 
5821  AudioRecordingConfiguration(const char* file_path, bool enc, int sample_rate,
5822  AUDIO_FILE_RECORDING_TYPE type,
5823  AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
5824  : filePath(file_path),
5825  encode(enc),
5826  sampleRate(sample_rate),
5827  fileRecordingType(type),
5828  quality(quality_type),
5829  recordingChannel(channel) {}
5830 
5831  AudioRecordingConfiguration(const AudioRecordingConfiguration& rhs)
5832  : filePath(rhs.filePath),
5833  encode(rhs.encode),
5834  sampleRate(rhs.sampleRate),
5836  quality(rhs.quality),
5838 };
5839 
5847  AUDIO_ENCODED_FRAME_OBSERVER_POSITION postionType;
5851  AUDIO_ENCODING_TYPE encodingType;
5852 
5854  : postionType(AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK),
5855  encodingType(AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM) {}
5856 };
5861  public:
5874  virtual void onRecordAudioEncodedFrame(const uint8_t* frameBuffer, int length,
5875  const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
5876 
5889  virtual void onPlaybackAudioEncodedFrame(const uint8_t* frameBuffer, int length,
5890  const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
5891 
5904  virtual void onMixedAudioEncodedFrame(const uint8_t* frameBuffer, int length,
5905  const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
5906 
5907  virtual ~IAudioEncodedFrameObserver() {}
5908 };
5909 
5912 enum AREA_CODE {
5916  AREA_CODE_CN = 0x00000001,
5920  AREA_CODE_NA = 0x00000002,
5924  AREA_CODE_EU = 0x00000004,
5928  AREA_CODE_AS = 0x00000008,
5932  AREA_CODE_JP = 0x00000010,
5936  AREA_CODE_IN = 0x00000020,
5940  AREA_CODE_GLOB = (0xFFFFFFFF)
5941 };
5942 
5947 enum AREA_CODE_EX {
5951  AREA_CODE_OC = 0x00000040,
5955  AREA_CODE_SA = 0x00000080,
5959  AREA_CODE_AF = 0x00000100,
5963  AREA_CODE_KR = 0x00000200,
5967  AREA_CODE_HKMC = 0x00000400,
5971  AREA_CODE_US = 0x00000800,
5975  AREA_CODE_RU = 0x00001000,
5979  AREA_CODE_OVS = 0xFFFFFFFE
5980 };
5981 
5985 enum CHANNEL_MEDIA_RELAY_ERROR {
5988  RELAY_OK = 0,
5991  RELAY_ERROR_SERVER_ERROR_RESPONSE = 1,
5998  RELAY_ERROR_SERVER_NO_RESPONSE = 2,
6001  RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3,
6004  RELAY_ERROR_FAILED_JOIN_SRC = 4,
6007  RELAY_ERROR_FAILED_JOIN_DEST = 5,
6010  RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6,
6013  RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7,
6017  RELAY_ERROR_SERVER_CONNECTION_LOST = 8,
6020  RELAY_ERROR_INTERNAL_ERROR = 9,
6023  RELAY_ERROR_SRC_TOKEN_EXPIRED = 10,
6026  RELAY_ERROR_DEST_TOKEN_EXPIRED = 11,
6027 };
6028 
6032 enum CHANNEL_MEDIA_RELAY_STATE {
6036  RELAY_STATE_IDLE = 0,
6039  RELAY_STATE_CONNECTING = 1,
6042  RELAY_STATE_RUNNING = 2,
6045  RELAY_STATE_FAILURE = 3,
6046 };
6047 
6053  uid_t uid;
6057  const char* channelName;
6061  const char* token;
6062 
6063  ChannelMediaInfo() : uid(0), channelName(NULL), token(NULL) {}
6064  ChannelMediaInfo(const char* c, const char* t, uid_t u) : uid(u), channelName(c), token(t) {}
6065 };
6066 
6104 
6106  : srcInfo(OPTIONAL_NULLPTR), destInfos(OPTIONAL_NULLPTR), destCount(0) {}
6107 };
6108 
6117 
6119 
6120  bool operator==(const UplinkNetworkInfo& rhs) const {
6122  }
6123 };
6124 
6130  const char* userId;
6134  VIDEO_STREAM_TYPE stream_type;
6138  REMOTE_VIDEO_DOWNSCALE_LEVEL current_downscale_level;
6143 
6145  : userId(OPTIONAL_NULLPTR),
6146  stream_type(VIDEO_STREAM_HIGH),
6147  current_downscale_level(REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE),
6148  expected_bitrate_bps(-1) {}
6149 
6151  : stream_type(rhs.stream_type),
6154  if (rhs.userId != OPTIONAL_NULLPTR) {
6155  const size_t len = std::strlen(rhs.userId);
6156  char* buf = new char[len + 1];
6157  std::memcpy(buf, rhs.userId, len);
6158  buf[len] = '\0';
6159  userId = buf;
6160  }
6161  }
6162 
6163  PeerDownlinkInfo& operator=(const PeerDownlinkInfo& rhs) {
6164  if (this == &rhs) return *this;
6165  userId = OPTIONAL_NULLPTR;
6166  stream_type = rhs.stream_type;
6167  current_downscale_level = rhs.current_downscale_level;
6168  expected_bitrate_bps = rhs.expected_bitrate_bps;
6169  if (rhs.userId != OPTIONAL_NULLPTR) {
6170  const size_t len = std::strlen(rhs.userId);
6171  char* buf = new char[len + 1];
6172  std::memcpy(buf, rhs.userId, len);
6173  buf[len] = '\0';
6174  userId = buf;
6175  }
6176  return *this;
6177  }
6178 
6179  ~PeerDownlinkInfo() { delete[] userId; }
6180  };
6181 
6202 
6207  peer_downlink_info(OPTIONAL_NULLPTR),
6209 
6214  peer_downlink_info(OPTIONAL_NULLPTR),
6216  if (total_received_video_count <= 0) return;
6217  peer_downlink_info = new PeerDownlinkInfo[total_received_video_count];
6218  for (int i = 0; i < total_received_video_count; ++i)
6220  }
6221 
6222  DownlinkNetworkInfo& operator=(const DownlinkNetworkInfo& rhs) {
6223  if (this == &rhs) return *this;
6224  lastmile_buffer_delay_time_ms = rhs.lastmile_buffer_delay_time_ms;
6225  bandwidth_estimation_bps = rhs.bandwidth_estimation_bps;
6226  total_downscale_level_count = rhs.total_downscale_level_count;
6227  peer_downlink_info = OPTIONAL_NULLPTR;
6228  total_received_video_count = rhs.total_received_video_count;
6229  if (total_received_video_count > 0) {
6230  peer_downlink_info = new PeerDownlinkInfo[total_received_video_count];
6231  for (int i = 0; i < total_received_video_count; ++i)
6232  peer_downlink_info[i] = rhs.peer_downlink_info[i];
6233  }
6234  return *this;
6235  }
6236 
6237  ~DownlinkNetworkInfo() { delete[] peer_downlink_info; }
6238 };
6239 
6246 enum ENCRYPTION_MODE {
6249  AES_128_XTS = 1,
6252  AES_128_ECB = 2,
6255  AES_256_XTS = 3,
6258  SM4_128_ECB = 4,
6261  AES_128_GCM = 5,
6264  AES_256_GCM = 6,
6268  AES_128_GCM2 = 7,
6272  AES_256_GCM2 = 8,
6275  MODE_END,
6276 };
6277 
6284  ENCRYPTION_MODE encryptionMode;
6291  const char* encryptionKey;
6299  uint8_t encryptionKdfSalt[32];
6300 
6301  bool datastreamEncryptionEnabled;
6302 
6304  : encryptionMode(AES_128_GCM2),
6305  encryptionKey(OPTIONAL_NULLPTR),
6306  datastreamEncryptionEnabled(false) {
6307  memset(encryptionKdfSalt, 0, sizeof(encryptionKdfSalt));
6308  }
6309 
6311  const char* getEncryptionString() const {
6312  switch (encryptionMode) {
6313  case AES_128_XTS:
6314  return "aes-128-xts";
6315  case AES_128_ECB:
6316  return "aes-128-ecb";
6317  case AES_256_XTS:
6318  return "aes-256-xts";
6319  case SM4_128_ECB:
6320  return "sm4-128-ecb";
6321  case AES_128_GCM:
6322  return "aes-128-gcm";
6323  case AES_256_GCM:
6324  return "aes-256-gcm";
6325  case AES_128_GCM2:
6326  return "aes-128-gcm-2";
6327  case AES_256_GCM2:
6328  return "aes-256-gcm-2";
6329  default:
6330  return "aes-128-gcm-2";
6331  }
6332  return "aes-128-gcm-2";
6333  }
6335 };
6336 
6339 enum ENCRYPTION_ERROR_TYPE {
6343  ENCRYPTION_ERROR_INTERNAL_FAILURE = 0,
6348  ENCRYPTION_ERROR_DECRYPTION_FAILURE = 1,
6352  ENCRYPTION_ERROR_ENCRYPTION_FAILURE = 2,
6357  ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE = 3,
6361  ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE = 4,
6362 };
6363 
6364 enum UPLOAD_ERROR_REASON {
6365  UPLOAD_SUCCESS = 0,
6366  UPLOAD_NET_ERROR = 1,
6367  UPLOAD_SERVER_ERROR = 2,
6368 };
6369 
6372 enum PERMISSION_TYPE {
6376  RECORD_AUDIO = 0,
6380  CAMERA = 1,
6381 
6382  SCREEN_CAPTURE = 2,
6383 };
6384 
6388 enum STREAM_SUBSCRIBE_STATE {
6392  SUB_STATE_IDLE = 0,
6406  SUB_STATE_NO_SUBSCRIBED = 1,
6410  SUB_STATE_SUBSCRIBING = 2,
6414  SUB_STATE_SUBSCRIBED = 3
6415 };
6416 
6420 enum STREAM_PUBLISH_STATE {
6424  PUB_STATE_IDLE = 0,
6435  PUB_STATE_NO_PUBLISHED = 1,
6439  PUB_STATE_PUBLISHING = 2,
6443  PUB_STATE_PUBLISHED = 3
6444 };
6445 
6450  view_t view;
6451  bool enableAudio;
6452  bool enableVideo;
6453  const char* token;
6454  const char* channelId;
6455  int intervalInSeconds;
6456 
6457  EchoTestConfiguration(view_t v, bool ea, bool ev, const char* t, const char* c, const int is)
6458  : view(v), enableAudio(ea), enableVideo(ev), token(t), channelId(c), intervalInSeconds(is) {}
6459 
6461  : view(OPTIONAL_NULLPTR),
6462  enableAudio(true),
6463  enableVideo(true),
6464  token(OPTIONAL_NULLPTR),
6465  channelId(OPTIONAL_NULLPTR),
6466  intervalInSeconds(2) {}
6467 };
6468 
6472 struct UserInfo {
6476  uid_t uid;
6480  char userAccount[MAX_USER_ACCOUNT_LENGTH];
6481 
6482  UserInfo() : uid(0) { userAccount[0] = '\0'; }
6483 };
6484 
6488 enum EAR_MONITORING_FILTER_TYPE {
6492  EAR_MONITORING_FILTER_NONE = (1 << 0),
6497  EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1 << 1),
6501  EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1 << 2),
6507  EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER = (1 << 15),
6508 };
6509 
6513 enum THREAD_PRIORITY_TYPE {
6517  LOWEST = 0,
6521  LOW = 1,
6525  NORMAL = 2,
6529  HIGH = 3,
6533  HIGHEST = 4,
6537  CRITICAL = 5,
6538 };
6539 
6540 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
6541 
6545 struct ScreenVideoParameters {
6572  VideoDimensions dimensions;
6578  int frameRate = 15;
6583  int bitrate;
6584  /*
6585  * The content hint of the screen sharing:
6586  */
6587  VIDEO_CONTENT_HINT contentHint = VIDEO_CONTENT_HINT::CONTENT_HINT_MOTION;
6588 
6589  ScreenVideoParameters() : dimensions(1280, 720) {}
6590 };
6591 
6595 struct ScreenAudioParameters {
6599  int sampleRate = 16000;
6603  int channels = 2;
6608  int captureSignalVolume = 100;
6609 };
6610 
6614 struct ScreenCaptureParameters2 {
6624  bool captureAudio = false;
6628  ScreenAudioParameters audioParams;
6638  bool captureVideo = true;
6642  ScreenVideoParameters videoParams;
6643 };
6644 #endif
6645 
6649 enum MEDIA_TRACE_EVENT {
6653  MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0,
6657  MEDIA_TRACE_EVENT_VIDEO_DECODED,
6658 };
6659 
6713 };
6714 
6715 enum CONFIG_FETCH_TYPE {
6719  CONFIG_FETCH_TYPE_INITIALIZE = 1,
6723  CONFIG_FETCH_TYPE_JOIN_CHANNEL = 2,
6724 };
6725 
6727 enum LOCAL_PROXY_MODE {
6730  ConnectivityFirst = 0,
6733  LocalOnly = 1,
6734 };
6735 
6739  const char* serverDomain;
6742  const char* serverPath;
6751 
6752  LogUploadServerInfo() : serverDomain(NULL), serverPath(NULL), serverPort(0), serverHttps(true) {}
6753 
6754  LogUploadServerInfo(const char* domain, const char* path, int port, bool https)
6755  : serverDomain(domain), serverPath(path), serverPort(port), serverHttps(https) {}
6756 };
6757 
6762 };
6763 
6767  const char** ipList;
6773  const char** domainList;
6781  const char* verifyDomainName;
6784  LOCAL_PROXY_MODE mode;
6795  : ipList(NULL),
6796  ipListSize(0),
6797  domainList(NULL),
6798  domainListSize(0),
6799  verifyDomainName(NULL),
6800  mode(ConnectivityFirst),
6801  disableAut(true) {}
6802 };
6803 
6804 enum RecorderStreamType {
6805  RTC,
6806  PREVIEW,
6807 };
6808 
6816  const char* channelId;
6820  uid_t uid;
6824  RecorderStreamType type;
6825  RecorderStreamInfo() : channelId(NULL), uid(0), type(RTC) {}
6826  RecorderStreamInfo(const char* channelId, uid_t uid)
6827  : channelId(channelId), uid(uid), type(RTC) {}
6828  RecorderStreamInfo(const char* channelId, uid_t uid, RecorderStreamType type)
6829  : channelId(channelId), uid(uid), type(type) {}
6830 };
6831 } // namespace rtc
6832 
6833 namespace base {
6834 
6836  public:
6837  virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid, void** inter) = 0;
6838  virtual ~IEngineBase() {}
6839 };
6840 
6841 class AParameter : public agora::util::AutoPtr<IAgoraParameter> {
6842  public:
6843  AParameter(IEngineBase& engine) { initialize(&engine); }
6844  AParameter(IEngineBase* engine) { initialize(engine); }
6846 
6847  private:
6848  bool initialize(IEngineBase* engine) {
6849  IAgoraParameter* p = OPTIONAL_NULLPTR;
6850  if (engine && !engine->queryInterface(rtc::AGORA_IID_PARAMETER_ENGINE, (void**)&p)) reset(p);
6851  return p != OPTIONAL_NULLPTR;
6852  }
6853 };
6854 
6856  public:
6857  virtual ~LicenseCallback() {}
6858  virtual void onCertificateRequired() = 0;
6859  virtual void onLicenseRequest() = 0;
6860  virtual void onLicenseValidated() = 0;
6861  virtual void onLicenseError(int result) = 0;
6862 };
6863 
6864 } // namespace base
6865 
6902 };
6906 struct VideoLayout {
6910  const char* channelId;
6914  rtc::uid_t uid;
6918  user_id_t strUid;
6922  uint32_t x;
6926  uint32_t y;
6930  uint32_t width;
6934  uint32_t height;
6939  uint32_t videoState;
6940 
6941  VideoLayout()
6942  : channelId(OPTIONAL_NULLPTR),
6943  uid(0),
6944  strUid(OPTIONAL_NULLPTR),
6945  x(0),
6946  y(0),
6947  width(0),
6948  height(0),
6949  videoState(0) {}
6950 };
6951 } // namespace agora
6952 
6958 AGORA_API const char* AGORA_CALL getAgoraSdkVersion(int* build);
6959 
6965 AGORA_API const char* AGORA_CALL getAgoraSdkErrorDescription(int err);
6966 
6967 AGORA_API int AGORA_CALL setAgoraSdkExternalSymbolLoader(void* (*func)(const char* symname));
6968 
6976 AGORA_API int AGORA_CALL createAgoraCredential(agora::util::AString& credential);
6977 
6991 AGORA_API int AGORA_CALL getAgoraCertificateVerifyResult(const char* credential_buf,
6992  int credential_len,
6993  const char* certificate_buf,
6994  int certificate_len);
6995 
7003 AGORA_API void setAgoraLicenseCallback(agora::base::LicenseCallback* callback);
7004 
7012 AGORA_API agora::base::LicenseCallback* getAgoraLicenseCallback();
7013 
7014 /*
7015  * Get monotonic time in ms which can be used by capture time,
7016  * typical scenario is as follows:
7017  *
7018  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
7019  * | // custom audio/video base capture time, e.g. the first audio/video capture time. | | int64_t
7020  * custom_capture_time_base; | | | |
7021  * int64_t agora_monotonic_time = getAgoraCurrentMonotonicTimeInMs(); |
7022  * | | | // offset is fixed once calculated in the begining. | | const int64_t offset =
7023  * agora_monotonic_time - custom_capture_time_base; | | | | //
7024  * realtime_custom_audio/video_capture_time is the origin capture time that customer provided.| | //
7025  * actual_audio/video_capture_time is the actual capture time transfered to sdk. | |
7026  * int64_t actual_audio_capture_time = realtime_custom_audio_capture_time + offset; |
7027  * | int64_t actual_video_capture_time = realtime_custom_video_capture_time + offset; |
7028  * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
7029  *
7030  * @return
7031  * - >= 0: Success.
7032  * - < 0: Failure.
7033  */
7034 AGORA_API int64_t AGORA_CALL getAgoraCurrentMonotonicTimeInMs();
agora::rtc::LiveTranscoding::transcodingUsers
TranscodingUser * transcodingUsers
Definition: AgoraBase.h:4020
agora::rtc::LogUploadServerInfo::serverDomain
const char * serverDomain
Definition: AgoraBase.h:6739
agora::rtc::IPacketObserver::onReceiveVideoPacket
virtual bool onReceiveVideoPacket(Packet &packet)=0
agora::rtc::VideoCanvas::mediaPlayerId
int mediaPlayerId
Definition: AgoraBase.h:4720
agora::rtc::RtcImage::width
int width
Definition: AgoraBase.h:3793
agora::rtc::TranscodingVideoStream::zOrder
int zOrder
Definition: AgoraBase.h:4157
agora::rtc::RtcStats::firstAudioPacketDuration
int firstAudioPacketDuration
Definition: AgoraBase.h:2429
agora::VideoLayout
Definition: AgoraBase.h:6906
agora::rtc::FilterEffectOptions::strength
float strength
Definition: AgoraBase.h:4954
agora::rtc::SimulcastConfig::STREAM_LAYER_1
@ STREAM_LAYER_1
Definition: AgoraBase.h:2166
agora::VideoLayout::channelId
const char * channelId
Definition: AgoraBase.h:6910
agora::rtc::UserInfo
Definition: AgoraBase.h:6472
agora::rtc::FilterEffectOptions
Definition: AgoraBase.h:4934
agora::rtc::TranscodingVideoStream::alpha
double alpha
Definition: AgoraBase.h:4163
agora::rtc::EncodedAudioFrameInfo::captureTimeMs
int64_t captureTimeMs
Definition: AgoraBase.h:1520
agora::rtc::VideoEncoderConfiguration::degradationPreference
DEGRADATION_PREFERENCE degradationPreference
Definition: AgoraBase.h:2016
agora::rtc::LastmileProbeResult
Definition: AgoraBase.h:4390
agora::rtc::AudioEncodedFrameObserverConfig
Definition: AgoraBase.h:5843
agora::rtc::ScreenCaptureParameters
Definition: AgoraBase.h:5561
agora::VideoLayout::x
uint32_t x
Definition: AgoraBase.h:6922
agora::rtc::WatermarkRatio
Definition: AgoraBase.h:2252
agora::rtc::AudioVolumeInfo
Definition: AgoraBase.h:3404
agora::rtc::VirtualBackgroundSource::BACKGROUND_BLUR_DEGREE
BACKGROUND_BLUR_DEGREE
Definition: AgoraBase.h:5111
agora::rtc::LastmileProbeResult::uplinkReport
LastmileProbeOneWayResult uplinkReport
Definition: AgoraBase.h:4398
agora::rtc::EncodedVideoFrameInfo::rotation
VIDEO_ORIENTATION rotation
Definition: AgoraBase.h:1716
agora::rtc::AdvancedConfigInfo::logUploadServer
LogUploadServerInfo logUploadServer
Definition: AgoraBase.h:6761
agora::rtc::BeautyOptions
Definition: AgoraBase.h:4799
agora::rtc::SenderOptions
Definition: AgoraBase.h:1254
agora::rtc::ScreenCaptureParameters::bitrate
int bitrate
Definition: AgoraBase.h:5587
agora::rtc::BeautyOptions::lighteningLevel
float lighteningLevel
Definition: AgoraBase.h:4818
agora::rtc::RtcStats::txVideoBytes
unsigned int txVideoBytes
Definition: AgoraBase.h:2338
agora::rtc::VirtualBackgroundSource::BACKGROUND_BLUR
@ BACKGROUND_BLUR
Definition: AgoraBase.h:5102
agora::rtc::LiveTranscoding::backgroundColor
unsigned int backgroundColor
Definition: AgoraBase.h:4010
agora::base::IAgoraParameter
Definition: IAgoraParameter.h:147
agora::rtc::AudioVolumeInfo::voicePitch
double voicePitch
Definition: AgoraBase.h:3434
agora::rtc::LastmileProbeConfig
Definition: AgoraBase.h:4320
agora::rtc::TranscodingUser::y
int y
Definition: AgoraBase.h:3912
agora::rtc::ScreenCaptureParameters::highLightWidth
int highLightWidth
Definition: AgoraBase.h:5615
agora::rtc::RtcStats::rxKBitRate
unsigned short rxKBitRate
Definition: AgoraBase.h:2354
agora::rtc::RtcStats::memoryTotalUsageRatio
double memoryTotalUsageRatio
Definition: AgoraBase.h:2414
agora::rtc::LocalAudioStats::txPacketLossRate
unsigned short txPacketLossRate
Definition: AgoraBase.h:3602
agora::rtc::VideoFormat::fps
int fps
Definition: AgoraBase.h:2745
agora::SpatialAudioParams::speaker_elevation
Optional< double > speaker_elevation
Definition: AgoraBase.h:6877
agora::rtc::VideoEncoderConfiguration::minBitrate
int minBitrate
Definition: AgoraBase.h:2008
agora::rtc::ScreenCaptureParameters::enableHighLight
bool enableHighLight
Definition: AgoraBase.h:5628
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_AUTO
@ VIDEO_DENOISER_AUTO
Definition: AgoraBase.h:5015
agora::rtc::VideoCanvas::setupMode
VIDEO_VIEW_SETUP_MODE setupMode
Definition: AgoraBase.h:4709
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY
@ LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY
Definition: AgoraBase.h:4982
agora::rtc::TranscodingUser::audioChannel
int audioChannel
Definition: AgoraBase.h:3955
agora::rtc::SimulcastConfig::StreamLayerIndex
StreamLayerIndex
Definition: AgoraBase.h:2162
agora::rtc::RtcStats::firstAudioPacketDurationAfterUnmute
int firstAudioPacketDurationAfterUnmute
Definition: AgoraBase.h:2449
agora::rtc::SimulcastConfig::STREAM_LAYER_2
@ STREAM_LAYER_2
Definition: AgoraBase.h:2170
agora::rtc::VideoFormat::width
int width
Definition: AgoraBase.h:2737
agora::rtc::ScreenCaptureParameters::windowFocus
bool windowFocus
Definition: AgoraBase.h:5599
agora::rtc::AudioEncodedFrameObserverConfig::encodingType
AUDIO_ENCODING_TYPE encodingType
Definition: AgoraBase.h:5851
agora::rtc::SenderOptions::codecType
VIDEO_CODEC_TYPE codecType
Definition: AgoraBase.h:1263
agora::rtc::EncodedAudioFrameInfo::codec
AUDIO_CODEC_TYPE codec
Definition: AgoraBase.h:1497
agora::rtc::LiveTranscoding::videoGop
int videoGop
Definition: AgoraBase.h:4001
agora::rtc::ChannelMediaRelayConfiguration::destCount
int destCount
Definition: AgoraBase.h:6103
agora::rtc::LocalAudioStats::audioDeviceDelay
int audioDeviceDelay
Definition: AgoraBase.h:3606
agora::rtc::LastmileProbeOneWayResult::jitter
unsigned int jitter
Definition: AgoraBase.h:4378
agora::rtc::BeautyOptions::smoothnessLevel
float smoothnessLevel
Definition: AgoraBase.h:4823
agora::rtc::VideoDenoiserOptions::level
VIDEO_DENOISER_LEVEL level
Definition: AgoraBase.h:5045
agora::rtc::VideoCanvas::mirrorMode
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition: AgoraBase.h:4704
agora::rtc::RtcStats::duration
unsigned int duration
Definition: AgoraBase.h:2322
agora::rtc::SimulcastStreamConfig::framerate
int framerate
Definition: AgoraBase.h:2147
agora::rtc::VideoDimensions::height
int height
Definition: AgoraBase.h:1108
agora::rtc::LocalAccessPointConfiguration::mode
LOCAL_PROXY_MODE mode
Definition: AgoraBase.h:6784
agora::rtc::LastmileProbeConfig::probeUplink
bool probeUplink
Definition: AgoraBase.h:4327
agora::rtc::RecorderStreamInfo::channelId
const char * channelId
Definition: AgoraBase.h:6816
agora::rtc::LocalAccessPointConfiguration
Definition: AgoraBase.h:6764
agora::rtc::FilterEffectOptions::path
const char * path
Definition: AgoraBase.h:4949
agora::rtc::LiveTranscoding::videoCodecType
VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType
Definition: AgoraBase.h:4012
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_MODE
VIDEO_DENOISER_MODE
Definition: AgoraBase.h:5012
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_NOSEWIDTH
@ FACE_SHAPE_AREA_NOSEWIDTH
Definition: AgoraBase.h:4882
agora::rtc::LiveTranscoding
Definition: AgoraBase.h:3964
agora::rtc::RtcStats::txBytes
unsigned int txBytes
Definition: AgoraBase.h:2326
agora::rtc::VideoFormat::height
int height
Definition: AgoraBase.h:2741
agora::rtc::Rectangle
Definition: AgoraBase.h:2221
agora::rtc::LocalAccessPointConfiguration::ipList
const char ** ipList
Definition: AgoraBase.h:6767
agora::rtc::VideoCanvas::uid
uid_t uid
Definition: AgoraBase.h:4675
agora::rtc::RtcStats::firstVideoPacketDuration
int firstVideoPacketDuration
Definition: AgoraBase.h:2434
agora::rtc::AudioRecordingConfiguration::filePath
const char * filePath
Definition: AgoraBase.h:5769
agora::rtc::EncodedVideoFrameInfo
Definition: AgoraBase.h:1640
agora::rtc::ColorEnhanceOptions::strengthLevel
float strengthLevel
Definition: AgoraBase.h:5062
agora::SpatialAudioParams::speaker_distance
Optional< double > speaker_distance
Definition: AgoraBase.h:6881
agora::rtc::VirtualBackgroundSource::BACKGROUND_NONE
@ BACKGROUND_NONE
Definition: AgoraBase.h:5090
agora::rtc::FaceShapeBeautyOptions::shapeStyle
FACE_SHAPE_BEAUTY_STYLE shapeStyle
Definition: AgoraBase.h:4919
agora::rtc::BeautyOptions::rednessLevel
float rednessLevel
Definition: AgoraBase.h:4828
agora::rtc::RtcStats::rxVideoBytes
unsigned int rxVideoBytes
Definition: AgoraBase.h:2346
agora::rtc::TranscodingVideoStream::remoteUserUid
uid_t remoteUserUid
Definition: AgoraBase.h:4122
agora::rtc::VideoEncoderConfiguration::dimensions
VideoDimensions dimensions
Definition: AgoraBase.h:1929
agora::rtc::EncodedVideoFrameInfo::uid
uid_t uid
Definition: AgoraBase.h:1689
agora::rtc::EncodedAudioFrameInfo
Definition: AgoraBase.h:1479
agora::util::AutoPtr
Definition: AgoraBase.h:100
agora::rtc::LastmileProbeOneWayResult::packetLossRate
unsigned int packetLossRate
Definition: AgoraBase.h:4374
agora::UserInfo::hasAudio
bool hasAudio
Definition: AgoraBase.h:830
agora::rtc::ScreenCaptureParameters::excludeWindowCount
int excludeWindowCount
Definition: AgoraBase.h:5610
agora::rtc::IPacketObserver::Packet
Definition: AgoraBase.h:3462
agora::rtc::AudioTrackConfig::enableLocalPlayback
bool enableLocalPlayback
Definition: AgoraBase.h:5205
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_NOSELENGTH
@ FACE_SHAPE_AREA_NOSELENGTH
Definition: AgoraBase.h:4880
agora::rtc::LiveTranscoding::audioCodecProfile
AUDIO_CODEC_PROFILE_TYPE audioCodecProfile
Definition: AgoraBase.h:4074
agora::rtc::RecorderStreamInfo::uid
uid_t uid
Definition: AgoraBase.h:6820
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1921
agora::rtc::Rectangle::width
int width
Definition: AgoraBase.h:2233
agora::rtc::SimulcastConfig::StreamLayerConfig::framerate
int framerate
Definition: AgoraBase.h:2204
agora::rtc::VideoEncoderConfiguration::bitrate
int bitrate
Definition: AgoraBase.h:1991
agora::rtc::VideoRenderingTracingInfo::remoteJoined2UnmuteVideo
int remoteJoined2UnmuteVideo
Definition: AgoraBase.h:6703
agora::util::AList
Definition: AgoraBase.h:233
agora::rtc::RtcStats::firstVideoKeyFrameDecodedDurationAfterUnmute
int firstVideoKeyFrameDecodedDurationAfterUnmute
Definition: AgoraBase.h:2464
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1610
agora::rtc::TranscodingUser
Definition: AgoraBase.h:3896
agora::rtc::EchoTestConfiguration
Definition: AgoraBase.h:6449
agora::rtc::RtcImage
Definition: AgoraBase.h:3774
agora::rtc::TranscodingUser::x
int x
Definition: AgoraBase.h:3906
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_FACECONTOUR
@ FACE_SHAPE_AREA_FACECONTOUR
Definition: AgoraBase.h:4866
agora::rtc::ChannelMediaInfo::token
const char * token
Definition: AgoraBase.h:6061
agora::rtc::VideoRenderingTracingInfo::remoteJoined2PacketReceived
int remoteJoined2PacketReceived
Definition: AgoraBase.h:6712
agora::rtc::AudioRecordingConfiguration::encode
bool encode
Definition: AgoraBase.h:5775
agora::rtc::BeautyOptions::lighteningContrastLevel
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition: AgoraBase.h:4814
agora::rtc::WatermarkRatio::yRatio
float yRatio
Definition: AgoraBase.h:2265
agora::SpatialAudioParams::enable_blur
Optional< bool > enable_blur
Definition: AgoraBase.h:6889
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2134
agora::rtc::LiveTranscoding::audioBitrate
int audioBitrate
Definition: AgoraBase.h:4062
agora::rtc::FaceShapeAreaOptions::shapeArea
FACE_SHAPE_AREA shapeArea
Definition: AgoraBase.h:4889
agora::rtc::ChannelMediaRelayConfiguration::destInfos
ChannelMediaInfo * destInfos
Definition: AgoraBase.h:6098
agora::rtc::RtcImage::x
int x
Definition: AgoraBase.h:3784
agora::rtc::VirtualBackgroundSource::background_source_type
BACKGROUND_SOURCE_TYPE background_source_type
Definition: AgoraBase.h:5125
agora::rtc::FaceShapeBeautyOptions
Definition: AgoraBase.h:4907
agora::rtc::TranscodingVideoStream::sourceType
VIDEO_SOURCE_TYPE sourceType
Definition: AgoraBase.h:4116
agora::rtc::LocalTranscoderConfiguration::syncWithPrimaryCamera
bool syncWithPrimaryCamera
Definition: AgoraBase.h:4210
agora::rtc::RtcImage::zOrder
int zOrder
Definition: AgoraBase.h:3805
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_FACELENGTH
@ FACE_SHAPE_AREA_FACELENGTH
Definition: AgoraBase.h:4868
agora::rtc::MixedAudioStream
Definition: AgoraBase.h:4250
agora::rtc::ClientRoleOptions::audienceLatencyLevel
AUDIENCE_LATENCY_LEVEL_TYPE audienceLatencyLevel
Definition: AgoraBase.h:2570
agora::rtc::AudioVolumeInfo::volume
unsigned int volume
Definition: AgoraBase.h:3417
agora::rtc::TranscodingUser::uid
uid_t uid
Definition: AgoraBase.h:3900
agora::rtc::VideoCanvas::enableAlphaMask
bool enableAlphaMask
Definition: AgoraBase.h:4732
agora::rtc::VideoRenderingTracingInfo::elapsedTime
int elapsedTime
Definition: AgoraBase.h:6667
agora::rtc::LiveStreamAdvancedFeature::featureName
const char * featureName
Definition: AgoraBase.h:3834
agora::rtc::AdvancedConfigInfo
Definition: AgoraBase.h:6758
agora::rtc::Rectangle::y
int y
Definition: AgoraBase.h:2229
agora::rtc::LocalAudioStats::sentBitrate
int sentBitrate
Definition: AgoraBase.h:3593
agora::rtc::RtcImage::url
const char * url
Definition: AgoraBase.h:3779
agora::rtc::IPacketObserver::Packet::buffer
const unsigned char * buffer
Definition: AgoraBase.h:3468
agora::rtc::EncodedVideoFrameInfo::decodeTimeMs
int64_t decodeTimeMs
Definition: AgoraBase.h:1729
agora::rtc::RtcStats::firstVideoKeyFrameRenderedDurationAfterUnmute
int firstVideoKeyFrameRenderedDurationAfterUnmute
Definition: AgoraBase.h:2469
agora::rtc::SimulcastConfig::configs
StreamLayerConfig configs[STREAM_LAYER_COUNT_MAX]
Definition: AgoraBase.h:2215
agora::rtc::ColorEnhanceOptions
Definition: AgoraBase.h:5057
agora::rtc::AudioRecordingConfiguration::sampleRate
int sampleRate
Definition: AgoraBase.h:5786
agora::UserInfo::userId
util::AString userId
Definition: AgoraBase.h:824
agora::rtc::WatermarkOptions::positionInPortraitMode
Rectangle positionInPortraitMode
Definition: AgoraBase.h:2297
agora::rtc::LocalAccessPointConfiguration::advancedConfig
AdvancedConfigInfo advancedConfig
Definition: AgoraBase.h:6787
agora::rtc::LastmileProbeResult::downlinkReport
LastmileProbeOneWayResult downlinkReport
Definition: AgoraBase.h:4402
agora::rtc::LiveTranscoding::watermarkCount
unsigned int watermarkCount
Definition: AgoraBase.h:4041
agora::rtc::Rectangle::x
int x
Definition: AgoraBase.h:2225
agora::rtc::LocalTranscoderConfiguration::videoInputStreams
TranscodingVideoStream * videoInputStreams
Definition: AgoraBase.h:4196
agora::util::IString
Definition: AgoraBase.h:172
agora::rtc::LocalAccessPointConfiguration::verifyDomainName
const char * verifyDomainName
Definition: AgoraBase.h:6781
agora::SpatialAudioParams::enable_air_absorb
Optional< bool > enable_air_absorb
Definition: AgoraBase.h:6893
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_LEVEL
LOW_LIGHT_ENHANCE_LEVEL
Definition: AgoraBase.h:4976
agora::rtc::EncodedAudioFrameInfo::advancedSettings
EncodedAudioFrameAdvancedSettings advancedSettings
Definition: AgoraBase.h:1515
agora::rtc::LocalTranscoderConfiguration
Definition: AgoraBase.h:4188
agora::rtc::BeautyOptions::LIGHTENING_CONTRAST_LEVEL
LIGHTENING_CONTRAST_LEVEL
Definition: AgoraBase.h:4802
agora::rtc::WatermarkRatio::xRatio
float xRatio
Definition: AgoraBase.h:2259
agora::rtc::LocalAudioStats::sentSampleRate
int sentSampleRate
Definition: AgoraBase.h:3589
agora::rtc::VideoSubscriptionOptions::type
Optional< VIDEO_STREAM_TYPE > type
Definition: AgoraBase.h:1617
agora::rtc::RecorderStreamInfo::type
RecorderStreamType type
Definition: AgoraBase.h:6824
agora::rtc::LocalAudioMixerConfiguration::audioInputStreams
MixedAudioStream * audioInputStreams
Definition: AgoraBase.h:4305
agora::rtc::LastmileProbeConfig::expectedDownlinkBitrate
unsigned int expectedDownlinkBitrate
Definition: AgoraBase.h:4344
agora::rtc::RtcStats::cpuTotalUsage
double cpuTotalUsage
Definition: AgoraBase.h:2397
agora::rtc::IPacketObserver::Packet::size
unsigned int size
Definition: AgoraBase.h:3472
agora::rtc::LiveTranscoding::advancedFeatures
LiveStreamAdvancedFeature * advancedFeatures
Definition: AgoraBase.h:4078
agora::rtc::LiveTranscoding::backgroundImageCount
unsigned int backgroundImageCount
Definition: AgoraBase.h:4054
agora::rtc::IPacketObserver
Definition: AgoraBase.h:3456
agora::rtc::LiveTranscoding::backgroundImage
RtcImage * backgroundImage
Definition: AgoraBase.h:4049
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_CHIN
@ FACE_SHAPE_AREA_CHIN
Definition: AgoraBase.h:4876
agora::rtc::RtcStats::cpuAppUsage
double cpuAppUsage
Definition: AgoraBase.h:2386
agora::VideoLayout::width
uint32_t width
Definition: AgoraBase.h:6930
agora::rtc::VideoFormat
Definition: AgoraBase.h:2724
agora::rtc::AdvanceOptions
Definition: AgoraBase.h:1781
agora::rtc::TranscodingUser::alpha
double alpha
Definition: AgoraBase.h:3934
agora::rtc::MixedAudioStream::trackId
track_id_t trackId
Definition: AgoraBase.h:4269
agora::rtc::WatermarkOptions::watermarkRatio
WatermarkRatio watermarkRatio
Definition: AgoraBase.h:2302
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_CHEEKBONE
@ FACE_SHAPE_AREA_CHEEKBONE
Definition: AgoraBase.h:4872
agora::rtc::DataStreamConfig
Definition: AgoraBase.h:2089
agora::rtc::AdvanceOptions::compressionPreference
COMPRESSION_PREFERENCE compressionPreference
Definition: AgoraBase.h:1790
agora::rtc::LocalAudioMixerConfiguration::streamCount
unsigned int streamCount
Definition: AgoraBase.h:4301
agora::rtc::RtcStats::txAudioBytes
unsigned int txAudioBytes
Definition: AgoraBase.h:2334
agora::rtc::RtcStats::connectTimeMs
int connectTimeMs
Definition: AgoraBase.h:2424
agora::rtc::LastmileProbeResult::state
LASTMILE_PROBE_RESULT_STATE state
Definition: AgoraBase.h:4394
agora::rtc::VideoEncoderConfiguration::advanceOptions
AdvanceOptions advanceOptions
Definition: AgoraBase.h:2028
agora::rtc::VideoCanvas::position
media::base::VIDEO_MODULE_POSITION position
Definition: AgoraBase.h:4737
agora::rtc::ChannelMediaInfo::channelName
const char * channelName
Definition: AgoraBase.h:6057
agora::rtc::LiveTranscoding::height
int height
Definition: AgoraBase.h:3978
agora::rtc::EncodedAudioFrameAdvancedSettings::speech
bool speech
Definition: AgoraBase.h:1467
agora::rtc::LocalAudioMixerConfiguration
Definition: AgoraBase.h:4297
agora::rtc::EncodedVideoFrameInfo::codecType
VIDEO_CODEC_TYPE codecType
Definition: AgoraBase.h:1694
agora::rtc::RtcStats::txVideoKBitRate
unsigned short txVideoKBitRate
Definition: AgoraBase.h:2370
agora::rtc::RtcStats::rxAudioBytes
unsigned int rxAudioBytes
Definition: AgoraBase.h:2342
agora::rtc::EncodedAudioFrameAdvancedSettings::sendEvenIfEmpty
bool sendEvenIfEmpty
Definition: AgoraBase.h:1473
agora::SpatialAudioParams::enable_doppler
Optional< bool > enable_doppler
Definition: AgoraBase.h:6901
agora::rtc::RtcStats::txAudioKBitRate
unsigned short txAudioKBitRate
Definition: AgoraBase.h:2362
agora::VideoLayout::height
uint32_t height
Definition: AgoraBase.h:6934
agora::rtc::AudioVolumeInfo::uid
uid_t uid
Definition: AgoraBase.h:3411
agora::rtc::BeautyOptions::LIGHTENING_CONTRAST_LOW
@ LIGHTENING_CONTRAST_LOW
Definition: AgoraBase.h:4804
agora::rtc::LiveTranscoding::videoBitrate
int videoBitrate
Definition: AgoraBase.h:3984
agora::rtc::FaceShapeBeautyOptions::FACE_SHAPE_BEAUTY_STYLE_FEMALE
@ FACE_SHAPE_BEAUTY_STYLE_FEMALE
Definition: AgoraBase.h:4912
agora::rtc::VideoTrackInfo::trackId
track_id_t trackId
Definition: AgoraBase.h:3349
agora::rtc::VideoTrackInfo::encodedFrameOnly
bool encodedFrameOnly
Definition: AgoraBase.h:3363
agora::rtc::FaceShapeBeautyOptions::FACE_SHAPE_BEAUTY_STYLE
FACE_SHAPE_BEAUTY_STYLE
Definition: AgoraBase.h:4910
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_CHEEK
@ FACE_SHAPE_AREA_CHEEK
Definition: AgoraBase.h:4874
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_MOUTHSCALE
@ FACE_SHAPE_AREA_MOUTHSCALE
Definition: AgoraBase.h:4884
agora::rtc::TranscodingUser::width
int width
Definition: AgoraBase.h:3916
agora::rtc::FaceShapeBeautyOptions::FACE_SHAPE_BEAUTY_STYLE_MALE
@ FACE_SHAPE_BEAUTY_STYLE_MALE
Definition: AgoraBase.h:4914
agora::rtc::ScreenCaptureParameters::highLightColor
unsigned int highLightColor
Definition: AgoraBase.h:5619
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_FACEWIDTH
@ FACE_SHAPE_AREA_FACEWIDTH
Definition: AgoraBase.h:4870
agora::base::AParameter
Definition: AgoraBase.h:6841
agora::rtc::BeautyOptions::sharpnessLevel
float sharpnessLevel
Definition: AgoraBase.h:4833
agora::rtc::EncryptionConfig::encryptionMode
ENCRYPTION_MODE encryptionMode
Definition: AgoraBase.h:6284
agora::util::AOutputIterator
Definition: AgoraBase.h:202
agora::rtc::WatermarkOptions::positionInLandscapeMode
Rectangle positionInLandscapeMode
Definition: AgoraBase.h:2292
agora::rtc::IAudioEncodedFrameObserver
Definition: AgoraBase.h:5860
agora::rtc::EncodedVideoFrameInfo::width
int width
Definition: AgoraBase.h:1698
agora::rtc::VideoTrackInfo::ownerUid
uid_t ownerUid
Definition: AgoraBase.h:3345
agora::rtc::VideoRenderingTracingInfo::join2JoinSuccess
int join2JoinSuccess
Definition: AgoraBase.h:6678
agora::rtc::LastmileProbeOneWayResult::availableBandwidth
unsigned int availableBandwidth
Definition: AgoraBase.h:4382
agora::rtc::EncodedVideoFrameInfo::captureTimeMs
int64_t captureTimeMs
Definition: AgoraBase.h:1725
agora::rtc::EncodedVideoFrameInfo::framesPerSecond
int framesPerSecond
Definition: AgoraBase.h:1708
agora::rtc::LiveTranscoding::transcodingExtraInfo
const char * transcodingExtraInfo
Definition: AgoraBase.h:4026
agora::rtc::SimulcastConfig::StreamLayerConfig
Definition: AgoraBase.h:2196
agora::rtc::VideoTrackInfo::codecType
VIDEO_CODEC_TYPE codecType
Definition: AgoraBase.h:3357
agora::rtc::LiveTranscoding::metadata
const char * metadata
Definition: AgoraBase.h:4030
agora::rtc::LiveTranscoding::audioSampleRate
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition: AgoraBase.h:4058
agora::rtc::ChannelMediaRelayConfiguration
Definition: AgoraBase.h:6069
agora::rtc::VirtualBackgroundSource::blur_degree
BACKGROUND_BLUR_DEGREE blur_degree
Definition: AgoraBase.h:5152
agora::rtc::UserInfo::uid
uid_t uid
Definition: AgoraBase.h:6476
agora::rtc::DataStreamConfig::ordered
bool ordered
Definition: AgoraBase.h:2110
agora::rtc::LiveStreamAdvancedFeature
Definition: AgoraBase.h:3821
agora::rtc::VirtualBackgroundSource::color
unsigned int color
Definition: AgoraBase.h:5136
agora::rtc::LastmileProbeOneWayResult
Definition: AgoraBase.h:4370
agora::rtc::VideoDenoiserOptions
Definition: AgoraBase.h:5009
agora::rtc::WatermarkRatio::widthRatio
float widthRatio
Definition: AgoraBase.h:2272
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_LEVEL_HIGH_QUALITY
@ VIDEO_DENOISER_LEVEL_HIGH_QUALITY
Definition: AgoraBase.h:5029
agora::rtc::VideoCanvas::cropArea
Rectangle cropArea
Definition: AgoraBase.h:4726
agora::rtc::AudioPcmDataInfo::samplesOut
size_t samplesOut
Definition: AgoraBase.h:1547
agora::rtc::VideoEncoderConfiguration::frameRate
int frameRate
Definition: AgoraBase.h:1933
agora::rtc::Rectangle::height
int height
Definition: AgoraBase.h:2237
agora::rtc::AudioPcmDataInfo::elapsedTimeMs
int64_t elapsedTimeMs
Definition: AgoraBase.h:1551
agora::rtc::WatermarkOptions::mode
WATERMARK_FIT_MODE mode
Definition: AgoraBase.h:2306
agora::rtc::MixedAudioStream::channelId
const char * channelId
Definition: AgoraBase.h:4264
agora::rtc::EncodedAudioFrameInfo::sampleRateHz
int sampleRateHz
Definition: AgoraBase.h:1501
agora::UserInfo
Definition: AgoraBase.h:820
agora::rtc::RtcStats::txPacketLossRate
int txPacketLossRate
Definition: AgoraBase.h:2473
agora::rtc::VirtualBackgroundSource
Definition: AgoraBase.h:5083
agora::rtc::WlAccStats::frozenRatioPercent
unsigned short frozenRatioPercent
Definition: AgoraBase.h:4605
agora::rtc::LowlightEnhanceOptions::level
LOW_LIGHT_ENHANCE_LEVEL level
Definition: AgoraBase.h:4996
agora::rtc::VideoCanvas::view
view_t view
Definition: AgoraBase.h:4685
agora::rtc::TranscodingVideoStream::imageUrl
const char * imageUrl
Definition: AgoraBase.h:4128
agora::rtc::AudioEncodedFrameObserverConfig::postionType
AUDIO_ENCODED_FRAME_OBSERVER_POSITION postionType
Definition: AgoraBase.h:5847
agora::rtc::IPacketObserver::onSendAudioPacket
virtual bool onSendAudioPacket(Packet &packet)=0
agora::rtc::EncryptionConfig::encryptionKdfSalt
uint8_t encryptionKdfSalt[32]
Definition: AgoraBase.h:6299
agora::rtc::WlAccStats::lossRatePercent
unsigned short lossRatePercent
Definition: AgoraBase.h:4609
agora::rtc::VirtualBackgroundSource::BACKGROUND_IMG
@ BACKGROUND_IMG
Definition: AgoraBase.h:5098
agora::rtc::LiveTranscoding::watermark
RtcImage * watermark
Definition: AgoraBase.h:4036
agora::rtc::AudioVolumeInfo::vad
unsigned int vad
Definition: AgoraBase.h:3428
agora::rtc::ChannelMediaInfo
Definition: AgoraBase.h:6050
agora::UserInfo::hasVideo
bool hasVideo
Definition: AgoraBase.h:836
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_MANUAL
@ LOW_LIGHT_ENHANCE_MANUAL
Definition: AgoraBase.h:4971
agora::VideoLayout::y
uint32_t y
Definition: AgoraBase.h:6926
agora::rtc::WlAccStats
Definition: AgoraBase.h:4597
agora::rtc::LocalAudioStats::aecEstimatedDelay
int aecEstimatedDelay
Definition: AgoraBase.h:3618
agora::rtc::VideoCanvas::renderMode
media::base::RENDER_MODE_TYPE renderMode
Definition: AgoraBase.h:4694
agora::SpatialAudioParams::speaker_orientation
Optional< int > speaker_orientation
Definition: AgoraBase.h:6885
agora::rtc::LocalAudioStats::earMonitorDelay
int earMonitorDelay
Definition: AgoraBase.h:3614
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA
FACE_SHAPE_AREA
Definition: AgoraBase.h:4858
agora::rtc::VideoTrackInfo::sourceType
VIDEO_SOURCE_TYPE sourceType
Definition: AgoraBase.h:3367
agora::rtc::RtcStats::txKBitRate
unsigned short txKBitRate
Definition: AgoraBase.h:2350
agora::rtc::EncodedAudioFrameInfo::numberOfChannels
int numberOfChannels
Definition: AgoraBase.h:1511
agora::rtc::EncodedVideoFrameInfo::streamType
VIDEO_STREAM_TYPE streamType
Definition: AgoraBase.h:1733
agora::rtc::SimulcastConfig::STREAM_LAYER_6
@ STREAM_LAYER_6
Definition: AgoraBase.h:2186
agora::rtc::LocalAudioStats::audioPlayoutDelay
int audioPlayoutDelay
Definition: AgoraBase.h:3610
agora::SpatialAudioParams::speaker_attenuation
Optional< double > speaker_attenuation
Definition: AgoraBase.h:6897
agora::rtc::VideoTrackInfo::observationPosition
uint32_t observationPosition
Definition: AgoraBase.h:3371
agora::rtc::AdvanceOptions::encodeAlpha
bool encodeAlpha
Definition: AgoraBase.h:1796
agora::VideoLayout::strUid
user_id_t strUid
Definition: AgoraBase.h:6918
agora::rtc::LogUploadServerInfo
Definition: AgoraBase.h:6736
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_LEVEL
VIDEO_DENOISER_LEVEL
Definition: AgoraBase.h:5022
agora::rtc::AudioTrackConfig::enableAudioProcessing
bool enableAudioProcessing
Definition: AgoraBase.h:5211
agora::rtc::VideoCanvas::sourceType
VIDEO_SOURCE_TYPE sourceType
Definition: AgoraBase.h:4714
agora::rtc::CodecCapInfo
Definition: AgoraBase.h:1898
agora::rtc::ScreenCaptureParameters::frameRate
int frameRate
Definition: AgoraBase.h:5581
agora::rtc::AudioRecordingConfiguration::recordingChannel
int recordingChannel
Definition: AgoraBase.h:5802
agora::rtc::RtcStats::firstVideoKeyFramePacketDurationAfterUnmute
int firstVideoKeyFramePacketDurationAfterUnmute
Definition: AgoraBase.h:2459
agora::rtc::LiveTranscoding::audioChannels
int audioChannels
Definition: AgoraBase.h:4071
agora::rtc::RtcImage::height
int height
Definition: AgoraBase.h:3797
agora::rtc::SimulcastStreamConfig::dimensions
VideoDimensions dimensions
Definition: AgoraBase.h:2138
agora::rtc::EncodedVideoFrameInfo::frameType
VIDEO_FRAME_TYPE frameType
Definition: AgoraBase.h:1712
agora::rtc::LastmileProbeConfig::probeDownlink
bool probeDownlink
Definition: AgoraBase.h:4333
agora::rtc::RtcStats::userCount
unsigned int userCount
Definition: AgoraBase.h:2378
agora::rtc::LocalTranscoderConfiguration::streamCount
unsigned int streamCount
Definition: AgoraBase.h:4192
agora::rtc::BeautyOptions::LIGHTENING_CONTRAST_HIGH
@ LIGHTENING_CONTRAST_HIGH
Definition: AgoraBase.h:4808
agora::base::LicenseCallback
Definition: AgoraBase.h:6855
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:6279
agora::rtc::LiveTranscoding::videoCodecProfile
VIDEO_CODEC_PROFILE_TYPE videoCodecProfile
Definition: AgoraBase.h:4006
agora::rtc::SimulcastConfig::STREAM_LOW
@ STREAM_LOW
Definition: AgoraBase.h:2190
agora::rtc::VirtualBackgroundSource::BACKGROUND_SOURCE_TYPE
BACKGROUND_SOURCE_TYPE
Definition: AgoraBase.h:5086
agora::rtc::VideoRenderingTracingInfo::start2JoinChannel
int start2JoinChannel
Definition: AgoraBase.h:6674
agora::rtc::VideoCanvas::backgroundColor
uint32_t backgroundColor
Definition: AgoraBase.h:4689
agora::rtc::LocalAccessPointConfiguration::disableAut
bool disableAut
Definition: AgoraBase.h:6793
agora::rtc::ScreenCaptureParameters::dimensions
VideoDimensions dimensions
Definition: AgoraBase.h:5575
agora::rtc::VideoDimensions::width
int width
Definition: AgoraBase.h:1104
agora::rtc::TranscodingVideoStream::x
int x
Definition: AgoraBase.h:4137
agora::rtc::LiveTranscoding::lowLatency
bool lowLatency
Definition: AgoraBase.h:3997
agora::rtc::TranscodingVideoStream
Definition: AgoraBase.h:4112
agora::rtc::VirtualBackgroundSource::source
const char * source
Definition: AgoraBase.h:5146
agora::rtc::LogUploadServerInfo::serverPath
const char * serverPath
Definition: AgoraBase.h:6742
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_EYESCALE
@ FACE_SHAPE_AREA_EYESCALE
Definition: AgoraBase.h:4878
agora::rtc::SimulcastConfig::STREAM_LAYER_5
@ STREAM_LAYER_5
Definition: AgoraBase.h:2182
agora::VideoLayout::videoState
uint32_t videoState
Definition: AgoraBase.h:6939
agora::rtc::MixedAudioStream::sourceType
AUDIO_SOURCE_TYPE sourceType
Definition: AgoraBase.h:4254
agora::rtc::RtcStats
Definition: AgoraBase.h:2318
agora::rtc::VideoSubscriptionOptions::encodedFrameOnly
Optional< bool > encodedFrameOnly
Definition: AgoraBase.h:1623
agora::rtc::IAudioEncodedFrameObserver::onRecordAudioEncodedFrame
virtual void onRecordAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
agora::rtc::VirtualBackgroundSource::BACKGROUND_VIDEO
@ BACKGROUND_VIDEO
Definition: AgoraBase.h:5106
agora::rtc::WatermarkOptions::visibleInPreview
bool visibleInPreview
Definition: AgoraBase.h:2287
agora::rtc::LowlightEnhanceOptions
Definition: AgoraBase.h:4961
agora::rtc::TranscodingUser::zOrder
int zOrder
Definition: AgoraBase.h:3928
agora::rtc::LiveTranscoding::width
int width
Definition: AgoraBase.h:3971
agora::rtc::AudioPcmDataInfo
Definition: AgoraBase.h:1525
agora::rtc::RtcStats::rxBytes
unsigned int rxBytes
Definition: AgoraBase.h:2330
agora::rtc::RtcStats::rxVideoKBitRate
unsigned short rxVideoKBitRate
Definition: AgoraBase.h:2366
agora::rtc::VideoDenoiserOptions::mode
VIDEO_DENOISER_MODE mode
Definition: AgoraBase.h:5041
agora::rtc::RtcStats::rxAudioKBitRate
unsigned short rxAudioKBitRate
Definition: AgoraBase.h:2358
agora::rtc::LocalAudioStats::numChannels
int numChannels
Definition: AgoraBase.h:3585
agora::rtc::VideoRenderingTracingInfo::remoteJoined2SetView
int remoteJoined2SetView
Definition: AgoraBase.h:6694
agora::rtc::SimulcastConfig::STREAM_LAYER_COUNT_MAX
@ STREAM_LAYER_COUNT_MAX
Definition: AgoraBase.h:2194
agora::rtc::WatermarkOptions
Definition: AgoraBase.h:2281
agora::rtc::VideoEncoderConfiguration::mirrorMode
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition: AgoraBase.h:2023
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3581
agora::rtc::RecorderStreamInfo
Definition: AgoraBase.h:6812
agora::rtc::LogUploadServerInfo::serverPort
int serverPort
Definition: AgoraBase.h:6745
agora::rtc::SimulcastConfig
Definition: AgoraBase.h:2158
agora::rtc::ScreenCaptureParameters::captureMouseCursor
bool captureMouseCursor
Definition: AgoraBase.h:5592
agora::rtc::MixedAudioStream::remoteUserUid
uid_t remoteUserUid
Definition: AgoraBase.h:4259
agora::rtc::RtcImage::y
int y
Definition: AgoraBase.h:3789
agora::rtc::FocalLengthInfo::focalLengthType
CAMERA_FOCAL_LENGTH_TYPE focalLengthType
Definition: AgoraBase.h:1915
agora::rtc::EncodedAudioFrameAdvancedSettings
Definition: AgoraBase.h:1459
agora::rtc::RtcStats::memoryAppUsageRatio
double memoryAppUsageRatio
Definition: AgoraBase.h:2409
agora::rtc::RtcStats::gatewayRtt
int gatewayRtt
Definition: AgoraBase.h:2404
agora::rtc::LastmileProbeConfig::expectedUplinkBitrate
unsigned int expectedUplinkBitrate
Definition: AgoraBase.h:4339
agora::rtc::VideoTrackInfo::isLocal
bool isLocal
Definition: AgoraBase.h:3341
agora::rtc::IAudioEncodedFrameObserver::onPlaybackAudioEncodedFrame
virtual void onPlaybackAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
agora::rtc::AdvanceOptions::encodingPreference
ENCODING_PREFERENCE encodingPreference
Definition: AgoraBase.h:1785
agora::rtc::VideoTrackInfo::channelId
const char * channelId
Definition: AgoraBase.h:3353
agora::rtc::IAudioEncodedFrameObserver::onMixedAudioEncodedFrame
virtual void onMixedAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_LEVEL_FAST
@ LOW_LIGHT_ENHANCE_LEVEL_FAST
Definition: AgoraBase.h:4987
agora::rtc::RtcStats::firstVideoKeyFramePacketDuration
int firstVideoKeyFramePacketDuration
Definition: AgoraBase.h:2439
agora::rtc::CodecCapInfo::codecLevels
CodecCapLevels codecLevels
Definition: AgoraBase.h:1904
agora::rtc::LiveTranscoding::advancedFeatureCount
unsigned int advancedFeatureCount
Definition: AgoraBase.h:4081
agora::rtc::CodecCapInfo::codecCapMask
int codecCapMask
Definition: AgoraBase.h:1902
agora::rtc::AudioRecordingConfiguration
Definition: AgoraBase.h:5763
agora::SpatialAudioParams::speaker_azimuth
Optional< double > speaker_azimuth
Definition: AgoraBase.h:6873
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_MODE
LOW_LIGHT_ENHANCE_MODE
Definition: AgoraBase.h:4965
agora::util::IContainer
Definition: AgoraBase.h:193
agora::rtc::VirtualBackgroundSource::BLUR_DEGREE_HIGH
@ BLUR_DEGREE_HIGH
Definition: AgoraBase.h:5120
agora::rtc::LocalAudioMixerConfiguration::syncWithLocalMic
bool syncWithLocalMic
Definition: AgoraBase.h:4312
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1100
agora::rtc::VirtualBackgroundSource::BLUR_DEGREE_LOW
@ BLUR_DEGREE_LOW
Definition: AgoraBase.h:5114
agora::rtc::VideoRenderingTracingInfo::joinSuccess2RemoteJoined
int joinSuccess2RemoteJoined
Definition: AgoraBase.h:6686
agora::rtc::FaceShapeAreaOptions::shapeIntensity
int shapeIntensity
Definition: AgoraBase.h:4896
agora::rtc::TranscodingVideoStream::height
int height
Definition: AgoraBase.h:4150
agora::rtc::DataStreamConfig::syncWithAudio
bool syncWithAudio
Definition: AgoraBase.h:2101
agora::rtc::LowlightEnhanceOptions::mode
LOW_LIGHT_ENHANCE_MODE mode
Definition: AgoraBase.h:4992
agora::rtc::LiveTranscoding::userCount
unsigned int userCount
Definition: AgoraBase.h:4016
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_FOREHEAD
@ FACE_SHAPE_AREA_FOREHEAD
Definition: AgoraBase.h:4864
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:156
agora::rtc::CodecCapInfo::codecType
VIDEO_CODEC_TYPE codecType
Definition: AgoraBase.h:1900
agora::rtc::AudioTrackConfig
Definition: AgoraBase.h:5199
agora::rtc::FocalLengthInfo::cameraDirection
int cameraDirection
Definition: AgoraBase.h:1913
agora::rtc::LocalAccessPointConfiguration::ipListSize
int ipListSize
Definition: AgoraBase.h:6770
agora::rtc::SimulcastConfig::STREAM_LAYER_4
@ STREAM_LAYER_4
Definition: AgoraBase.h:2178
agora::rtc::TranscodingVideoStream::width
int width
Definition: AgoraBase.h:4146
agora::rtc::TranscodingVideoStream::mirror
bool mirror
Definition: AgoraBase.h:4170
agora::rtc::SimulcastStreamConfig::kBitrate
int kBitrate
Definition: AgoraBase.h:2143
agora::rtc::RtcImage::alpha
double alpha
Definition: AgoraBase.h:3811
agora::rtc::TranscodingVideoStream::mediaPlayerId
int mediaPlayerId
Definition: AgoraBase.h:4132
agora::rtc::VideoCanvas::subviewUid
uid_t subviewUid
Definition: AgoraBase.h:4681
agora::rtc::EncryptionConfig::encryptionKey
const char * encryptionKey
Definition: AgoraBase.h:6291
agora::rtc::EncodedVideoFrameInfo::trackId
int trackId
Definition: AgoraBase.h:1720
agora::rtc::VirtualBackgroundSource::BLUR_DEGREE_MEDIUM
@ BLUR_DEGREE_MEDIUM
Definition: AgoraBase.h:5117
agora::rtc::ScreenCaptureParameters::excludeWindowList
view_t * excludeWindowList
Definition: AgoraBase.h:5606
agora::rtc::LocalAccessPointConfiguration::domainList
const char ** domainList
Definition: AgoraBase.h:6773
agora::rtc::SimulcastConfig::STREAM_LAYER_3
@ STREAM_LAYER_3
Definition: AgoraBase.h:2174
agora::rtc::IPacketObserver::onSendVideoPacket
virtual bool onSendVideoPacket(Packet &packet)=0
agora::rtc::AudioPcmDataInfo::samplesPerChannel
size_t samplesPerChannel
Definition: AgoraBase.h:1539
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:3326
agora::rtc::LocalTranscoderConfiguration::videoOutputConfiguration
VideoEncoderConfiguration videoOutputConfiguration
Definition: AgoraBase.h:4201
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_HEADSCALE
@ FACE_SHAPE_AREA_HEADSCALE
Definition: AgoraBase.h:4862
agora::rtc::SenderOptions::ccMode
TCcMode ccMode
Definition: AgoraBase.h:1258
agora::rtc::SimulcastConfig::StreamLayerConfig::dimensions
VideoDimensions dimensions
Definition: AgoraBase.h:2200
agora::rtc::VirtualBackgroundSource::BACKGROUND_COLOR
@ BACKGROUND_COLOR
Definition: AgoraBase.h:5094
agora::rtc::AudioPcmDataInfo::ntpTimeMs
int64_t ntpTimeMs
Definition: AgoraBase.h:1555
agora::rtc::LowlightEnhanceOptions::LOW_LIGHT_ENHANCE_AUTO
@ LOW_LIGHT_ENHANCE_AUTO
Definition: AgoraBase.h:4969
agora::rtc::RtcStats::firstVideoPacketDurationAfterUnmute
int firstVideoPacketDurationAfterUnmute
Definition: AgoraBase.h:2454
agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA_NONE
@ FACE_SHAPE_AREA_NONE
Definition: AgoraBase.h:4860
agora::rtc::LiveTranscoding::videoFramerate
int videoFramerate
Definition: AgoraBase.h:3990
agora::rtc::RtcStats::rxPacketLossRate
int rxPacketLossRate
Definition: AgoraBase.h:2477
agora::rtc::RtcStats::lastmileDelay
unsigned short lastmileDelay
Definition: AgoraBase.h:2374
agora::rtc::FaceShapeAreaOptions
Definition: AgoraBase.h:4855
agora::rtc::CodecCapLevels
Definition: AgoraBase.h:1888
agora::SpatialAudioParams
Definition: AgoraBase.h:6869
agora::rtc::ColorEnhanceOptions::skinProtectLevel
float skinProtectLevel
Definition: AgoraBase.h:5072
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_LEVEL_FAST
@ VIDEO_DENOISER_LEVEL_FAST
Definition: AgoraBase.h:5037
agora::rtc::VideoEncoderConfiguration::codecType
VIDEO_CODEC_TYPE codecType
Definition: AgoraBase.h:1925
agora::rtc::LastmileProbeResult::rtt
unsigned int rtt
Definition: AgoraBase.h:4406
agora::rtc::TranscodingVideoStream::y
int y
Definition: AgoraBase.h:4142
agora::rtc::RtcStats::packetsBeforeFirstKeyFramePacket
int packetsBeforeFirstKeyFramePacket
Definition: AgoraBase.h:2444
agora::rtc::BeautyOptions::LIGHTENING_CONTRAST_NORMAL
@ LIGHTENING_CONTRAST_NORMAL
Definition: AgoraBase.h:4806
agora::rtc::ChannelMediaRelayConfiguration::srcInfo
ChannelMediaInfo * srcInfo
Definition: AgoraBase.h:6082
agora::rtc::VideoEncoderConfiguration::orientationMode
ORIENTATION_MODE orientationMode
Definition: AgoraBase.h:2012
agora::rtc::WlAccStats::e2eDelayPercent
unsigned short e2eDelayPercent
Definition: AgoraBase.h:4601
agora::rtc::LiveStreamAdvancedFeature::opened
bool opened
Definition: AgoraBase.h:3841
agora::rtc::FocalLengthInfo
Definition: AgoraBase.h:1911
agora::rtc::DeviceInfo
Definition: AgoraBase.h:3442
agora::base::IEngineBase
Definition: AgoraBase.h:6835
agora::rtc::SenderOptions::targetBitrate
int targetBitrate
Definition: AgoraBase.h:1324
agora::rtc::AudioRecordingConfiguration::quality
AUDIO_RECORDING_QUALITY_TYPE quality
Definition: AgoraBase.h:5795
agora::util::IIterator
Definition: AgoraBase.h:184
agora::rtc::UserInfo::userAccount
char userAccount[MAX_USER_ACCOUNT_LENGTH]
Definition: AgoraBase.h:6480
agora::rtc::VideoRenderingTracingInfo
Definition: AgoraBase.h:6663
agora::rtc::LogUploadServerInfo::serverHttps
bool serverHttps
Definition: AgoraBase.h:6750
agora::rtc::VideoDenoiserOptions::VIDEO_DENOISER_MANUAL
@ VIDEO_DENOISER_MANUAL
Definition: AgoraBase.h:5017
agora::rtc::EncodedAudioFrameInfo::samplesPerChannel
int samplesPerChannel
Definition: AgoraBase.h:1507
agora::rtc::EncodedVideoFrameInfo::height
int height
Definition: AgoraBase.h:1702
agora::rtc::RtcStats::memoryAppUsageInKbytes
int memoryAppUsageInKbytes
Definition: AgoraBase.h:2419
agora::rtc::FaceShapeBeautyOptions::styleIntensity
int styleIntensity
Definition: AgoraBase.h:4923
agora::VideoLayout::uid
rtc::uid_t uid
Definition: AgoraBase.h:6914
agora::Optional< VIDEO_STREAM_TYPE >
agora::rtc::LocalAccessPointConfiguration::domainListSize
int domainListSize
Definition: AgoraBase.h:6776
agora::rtc::ClientRoleOptions
Definition: AgoraBase.h:2565
agora::rtc::TranscodingUser::height
int height
Definition: AgoraBase.h:3920
agora::rtc::IPacketObserver::onReceiveAudioPacket
virtual bool onReceiveAudioPacket(Packet &packet)=0
agora::rtc::VideoCanvas
Definition: AgoraBase.h:4671
agora::rtc::LocalAudioStats::internalCodec
int internalCodec
Definition: AgoraBase.h:3597
agora::rtc::AudioRecordingConfiguration::fileRecordingType
AUDIO_FILE_RECORDING_TYPE fileRecordingType
Definition: AgoraBase.h:5790
agora::rtc::SegmentationProperty
Definition: AgoraBase.h:5161
agora::rtc::SimulcastConfig::StreamLayerConfig::enable
bool enable
Definition: AgoraBase.h:2208
agora::rtc::ChannelMediaInfo::uid
uid_t uid
Definition: AgoraBase.h:6053