Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
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
96namespace agora {
97namespace util {
98
99template <class T>
100class 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
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
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
155template <class T>
156class 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()); }
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
172class 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
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
194 public:
195 virtual IIterator* begin() = 0;
196 virtual size_t size() const = 0;
197 virtual void release() = 0;
198 virtual ~IContainer() {}
199};
200
201template <class T>
203 IIterator* p;
204
205 public:
206 typedef T value_type;
210 typedef const value_type* const_pointer;
211 explicit AOutputIterator(IIterator* it = OPTIONAL_NULLPTR) : p(it) {}
213 if (p) p->release();
214 }
215 AOutputIterator(const AOutputIterator& rhs) : p(rhs.p) {}
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
232template <class T>
233class AList {
234 IContainer* container;
235 bool owner;
236
237 public:
238 typedef T value_type;
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
280 CHANNEL_PROFILE_GAME __deprecated = 2,
286 CHANNEL_PROFILE_CLOUD_GAMING __deprecated = 3,
287
292 CHANNEL_PROFILE_COMMUNICATION_1v1 __deprecated = 4,
293};
294
448
463 // 1~1000
616 ERR_CONNECTION_INTERRUPTED = 111, // only used in web sdk
621 ERR_CONNECTION_LOST = 112, // only used in web sdk
669
674
679
687
688 // Licensing, keep the license error code same as the main version
701
702 // PcmSend Error num
706 ERR_PCMSEND_FORMAT = 200, // unsupport pcm format
710 ERR_PCMSEND_BUFFEROVERFLOW = 201, // buffer overflow, the pcm send rate too quickly
711
713 // RDT error code: 250~270
718 ERR_RDT_USER_NOT_EXIST = 250,
723 ERR_RDT_USER_NOT_READY = 251,
728 ERR_RDT_DATA_BLOCKED = 252,
733 ERR_RDT_CMD_EXCEED_LIMIT = 253,
738 ERR_RDT_DATA_EXCEED_LIMIT = 254,
743 ERR_RDT_ENCRYPTION = 255,
745
747 // signaling: 400~600
748 ERR_LOGIN_ALREADY_LOGIN = 428,
749
751 // 1001~2000
792};
793
820
848
849typedef const char* user_id_t;
850typedef void* view_t;
851
855struct UserInfo {
872
873 UserInfo() : hasAudio(false), hasVideo(false) {}
874};
875
877
878// Shared between Agora Service and Rtc Engine
879namespace rtc {
880
901
936
979
997
1019
1054
1058
1062
1092
1119
1162
1175 VideoDimensions() : width(640), height(480) {}
1176 VideoDimensions(int w, int h) : width(w), height(h) {}
1177 bool operator==(const VideoDimensions& rhs) const {
1178 return width == rhs.width && height == rhs.height;
1179 }
1180};
1181
1187const int STANDARD_BITRATE = 0;
1188
1196const int COMPATIBLE_BITRATE = -1;
1197
1201const int DEFAULT_MIN_BITRATE = -1;
1202
1207
1225
1252
1299
1324
1338
1416
1466
1527
1543
1563
1608
1643
1650 NonInterleaved = 0, // Mode 1 - STAP-A, FU-A is allowed
1654 SingleNalUnit, // Mode 0 - only single NALU allowed
1655};
1656
1701
1721
1731
1748
1761
1763 if (this == &rhs) return *this;
1764 codecType = rhs.codecType;
1765 width = rhs.width;
1766 height = rhs.height;
1768 frameType = rhs.frameType;
1769 rotation = rhs.rotation;
1770 trackId = rhs.trackId;
1773 streamType = rhs.streamType;
1775 return *this;
1776 }
1777
1808 int trackId; // This can be reserved for multiple video tracks, we need to create different ssrc
1809 // and additional payload for later implementation.
1822
1823 // @technical preview
1825};
1826
1847
1869
1878
1883
1890
1894
1896 COMPRESSION_PREFERENCE compression_preference,
1897 bool encode_alpha) :
1898 encodingPreference(encoding_preference),
1899 compressionPreference(compression_preference),
1900 encodeAlpha(encode_alpha) {}
1901
1902 bool operator==(const AdvanceOptions& rhs) const {
1903 return encodingPreference == rhs.encodingPreference &&
1905 encodeAlpha == rhs.encodeAlpha;
1906 }
1907};
1908
1929
1930#if defined(__APPLE__) && TARGET_OS_IOS
1940#endif
1941
1956
1965
1995
2015
2035
2053
2082
2103
2110
2115
2156
2158 if (this == &rhs) return *this;
2159 codecType = rhs.codecType;
2160 dimensions = rhs.dimensions;
2161 frameRate = rhs.frameRate;
2162 bitrate = rhs.bitrate;
2163 minBitrate = rhs.minBitrate;
2166 mirrorMode = rhs.mirrorMode;
2168 return *this;
2169 }
2170};
2171
2206
2226
2252
2338
2346 int x;
2350 int y;
2359
2360 Rectangle() : x(0), y(0), width(0), height(0) {}
2361 Rectangle(int xx, int yy, int ww, int hh) : x(xx), y(yy), width(ww), height(hh) {}
2362};
2363
2382 float xRatio;
2388 float yRatio;
2396
2397 WatermarkRatio() : xRatio(0.0), yRatio(0.0), widthRatio(0.0) {}
2398 WatermarkRatio(float x, float y, float width) : xRatio(x), yRatio(y), widthRatio(width) {}
2399};
2400
2446
2474
2492 const char* fontFilePath;
2504 const char* format;
2505
2507};
2508
2516
2530 const char* wmLiteral;
2537 const char* fontFilePath;
2538
2540};
2541
2553
2572
2576 const uint8_t* buffer;
2577
2578 WatermarkBuffer() : buffer(NULL), width(0), height(0), length(0), format(media::base::VIDEO_PIXEL_I420) {}
2579};
2580
2625
2642
2666
2688
2698 uint32_t lanTxBytes;
2702 uint32_t lanRxBytes;
2706 uint32_t wifiTxBytes;
2710 uint32_t wifiRxBytes;
2728 : lanTxBytes(0),
2729 lanRxBytes(0),
2730 wifiTxBytes(0),
2731 wifiRxBytes(0),
2732 mobileTxBytes(0),
2733 mobileRxBytes(0),
2734 activePathNum(0),
2735 pathStats(nullptr) {}
2736};
2737
2741struct RtcStats {
2745 unsigned int duration;
2749 unsigned int txBytes;
2753 unsigned int rxBytes;
2757 unsigned int txAudioBytes;
2761 unsigned int txVideoBytes;
2765 unsigned int rxAudioBytes;
2769 unsigned int rxVideoBytes;
2773 unsigned short txKBitRate;
2777 unsigned short rxKBitRate;
2781 unsigned short rxAudioKBitRate;
2785 unsigned short txAudioKBitRate;
2789 unsigned short rxVideoKBitRate;
2793 unsigned short txVideoKBitRate;
2797 unsigned short lastmileDelay;
2801 unsigned int userCount;
2909
2945};
2946
2960
2979
2994
3007
3021
3048
3071
3119
3162
3169 kMaxWidthInPixels = 3840,
3171 kMaxHeightInPixels = 2160,
3173 kMaxFps = 60,
3174 };
3175
3179 int width; // Number of pixels.
3183 int height; // Number of pixels.
3187 int fps;
3189 VideoFormat(int w, int h, int f) : width(w), height(h), fps(f) {}
3190
3191 bool operator<(const VideoFormat& fmt) const {
3192 if (height != fmt.height) {
3193 return height < fmt.height;
3194 } else if (width != fmt.width) {
3195 return width < fmt.width;
3196 } else {
3197 return fps < fmt.fps;
3198 }
3199 }
3200 bool operator==(const VideoFormat& fmt) const {
3201 return width == fmt.width && height == fmt.height && fps == fmt.fps;
3202 }
3203 bool operator!=(const VideoFormat& fmt) const { return !operator==(fmt); }
3204};
3205
3225
3252
3318
3341
3364
3400
3422
3484
3507
3530
3683 /* 30: (HMOS only) ScreenCapture stopped by user */
3685 /* 31: (HMOS only) ScreenCapture interrupted by other screen capture */
3687 /* 32: (HMOS only) ScreenCapture stopped by SIM call */
3691};
3692
3703 0, // Default state, audio is started or remote user disabled/muted audio stream
3707 REMOTE_AUDIO_STATE_STARTING = 1, // The first audio frame packet has been received
3714 2, // The first remote audio frame has been decoded or fronzen state ends
3719 REMOTE_AUDIO_STATE_FROZEN = 3, // Remote audio is frozen, probably due to network issue
3724 REMOTE_AUDIO_STATE_FAILED = 4, // Remote audio play failed
3725};
3726
3772
3805
3868
3890
3942
3969
3989 unsigned int volume; // [0,255]
4000 unsigned int vad;
4007
4008 AudioVolumeInfo() : uid(0), volume(0), vad(0), voicePitch(0.0) {}
4009};
4010
4027
4032 public:
4033 virtual ~IPacketObserver() {}
4037 struct Packet {
4043 const unsigned char* buffer;
4047 unsigned int size;
4048
4049 Packet() : buffer(OPTIONAL_NULLPTR), size(0) {}
4050 };
4051
4060 virtual bool onSendAudioPacket(Packet& packet) = 0;
4070 virtual bool onSendVideoPacket(Packet& packet) = 0;
4080 virtual bool onReceiveAudioPacket(Packet& packet) = 0;
4090 virtual bool onReceiveVideoPacket(Packet& packet) = 0;
4091};
4092
4110
4123
4143
4161
4205
4244
4326
4349
4357typedef struct RtcImage {
4362 const char* url;
4367 int x;
4372 int y;
4394 double alpha;
4395
4396 RtcImage() : url(OPTIONAL_NULLPTR), x(0), y(0), width(0), height(0), zOrder(0), alpha(1.0) {}
4407 LiveStreamAdvancedFeature() : featureName(OPTIONAL_NULLPTR), opened(false) {}
4408 LiveStreamAdvancedFeature(const char* feat_name, bool open)
4409 : featureName(feat_name), opened(open) {}
4410
4411 // static const char* LBHQ = "lbhq";
4413 // static const char* VEO = "veo";
4414
4419 const char* featureName;
4420
4427};
4428
4480
4494 int x;
4500 int y;
4523 double alpha;
4544
4546 : uid(0), x(0), y(0), width(0), height(0), zOrder(0), alpha(1.0), audioChannel(0) {}
4547};
4548
4582
4591
4606 unsigned int backgroundColor;
4614 unsigned int userCount;
4626
4632 const char* metadata;
4643 unsigned int watermarkCount;
4644
4657
4685
4690
4692 : width(360),
4693 height(640),
4694 videoBitrate(400),
4695 videoFramerate(15),
4696 lowLatency(false),
4697 videoGop(30),
4699 backgroundColor(0x000000),
4701 userCount(0),
4702 transcodingUsers(OPTIONAL_NULLPTR),
4703 transcodingExtraInfo(OPTIONAL_NULLPTR),
4704 metadata(OPTIONAL_NULLPTR),
4705 watermark(OPTIONAL_NULLPTR),
4706 watermarkCount(0),
4707 backgroundImage(OPTIONAL_NULLPTR),
4710 audioBitrate(48),
4711 audioChannels(1),
4713 advancedFeatures(OPTIONAL_NULLPTR),
4715};
4716
4737 const char* imageUrl;
4747 int x;
4752 int y;
4772 double alpha;
4780
4783 remoteUserUid(0),
4784 imageUrl(OPTIONAL_NULLPTR),
4785 x(0),
4786 y(0),
4787 width(0),
4788 height(0),
4789 zOrder(0),
4790 alpha(1.0),
4791 mirror(false) {}
4792};
4793
4827
4858
4859
4887 const char* channelId;
4895
4897 : sourceType(source),
4898 remoteUserUid(0),
4899 channelId(NULL),
4900 trackId(-1) {}
4901
4903 : sourceType(source),
4904 trackId(track) {}
4905
4906 MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char* channel)
4907 : sourceType(source),
4908 remoteUserUid(uid),
4909 channelId(channel) {}
4910
4911 MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char* channel, track_id_t track)
4912 : sourceType(source),
4913 remoteUserUid(uid),
4914 channelId(channel),
4915 trackId(track) {}
4916
4917};
4918
4943
4972
4992
5012
5036
5172
5194 CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT __deprecated = 3,
5200 CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED __deprecated = 4,
5201};
5202
5240
5261
5270
5333
5335 : uid(0),
5336 subviewUid(0),
5337 view(NULL),
5338 backgroundColor(0x00000000),
5339 renderMode(media::base::RENDER_MODE_HIDDEN),
5344 cropArea(0, 0, 0, 0),
5345 enableAlphaMask(false),
5346 position(media::base::POSITION_POST_CAPTURER) {}
5347
5349 : uid(0),
5350 subviewUid(0),
5351 view(v),
5352 backgroundColor(0x00000000),
5353 renderMode(m),
5354 mirrorMode(mt),
5358 cropArea(0, 0, 0, 0),
5359 enableAlphaMask(false),
5360 position(media::base::POSITION_POST_CAPTURER) {}
5361
5363 : uid(u),
5364 subviewUid(0),
5365 view(v),
5366 backgroundColor(0x00000000),
5367 renderMode(m),
5368 mirrorMode(mt),
5372 cropArea(0, 0, 0, 0),
5373 enableAlphaMask(false),
5374 position(media::base::POSITION_POST_CAPTURER) {}
5375
5377 uid_t subu)
5378 : uid(u),
5379 subviewUid(subu),
5380 view(v),
5381 backgroundColor(0x00000000),
5382 renderMode(m),
5383 mirrorMode(mt),
5387 cropArea(0, 0, 0, 0),
5388 enableAlphaMask(false),
5389 position(media::base::POSITION_POST_CAPTURER) {}
5390};
5391
5413
5419
5425
5431
5437
5443
5444 BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness,
5445 float redness, float sharpness)
5446 : lighteningContrastLevel(contrastLevel),
5447 lighteningLevel(lightening),
5448 smoothnessLevel(smoothness),
5449 rednessLevel(redness),
5450 sharpnessLevel(sharpness) {}
5451
5458};
5459
5652
5657
5663
5665
5667};
5668
5712
5736 const char * path;
5737
5743
5744 FilterEffectOptions(const char * lut3dPath, float filterStrength) : path(lut3dPath), strength(filterStrength) {}
5745
5746 FilterEffectOptions() : path(OPTIONAL_NULLPTR), strength(0.5) {}
5747};
5748
5801
5855
5868
5881
5882 ColorEnhanceOptions(float stength, float skinProtect)
5883 : strengthLevel(stength), skinProtectLevel(skinProtect) {}
5884
5886};
5887
5982
6041
6067
6089
6188
6310
6374
6392
6438
6459
6460#if defined(__APPLE__) && !TARGET_OS_IOS
6466#else
6468#endif
6469};
6470
6475
6492
6559
6571 unsigned int highLightColor;
6580
6582 : captureAudio(false),
6583 dimensions(1920, 1080),
6584 frameRate(5),
6586 captureMouseCursor(true),
6587 windowFocus(false),
6588 excludeWindowList(OPTIONAL_NULLPTR),
6590 highLightWidth(0),
6591 highLightColor(0),
6592 enableHighLight(false) {}
6594 : captureAudio(false),dimensions(d),
6595 frameRate(f),
6596 bitrate(b),
6597 captureMouseCursor(true),
6598 windowFocus(false),
6599 excludeWindowList(OPTIONAL_NULLPTR),
6601 highLightWidth(0),
6602 highLightColor(0),
6603 enableHighLight(false) {}
6604 ScreenCaptureParameters(int width, int height, int f, int b)
6605 : captureAudio(false),
6606 dimensions(width, height),
6607 frameRate(f),
6608 bitrate(b),
6609 captureMouseCursor(true),
6610 windowFocus(false),
6611 excludeWindowList(OPTIONAL_NULLPTR),
6613 highLightWidth(0),
6614 highLightColor(0),
6615 enableHighLight(false) {}
6616 ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs)
6617 : captureAudio(false),
6618 dimensions(width, height),
6619 frameRate(f),
6620 bitrate(b),
6621 captureMouseCursor(cur),
6622 windowFocus(fcs),
6623 excludeWindowList(OPTIONAL_NULLPTR),
6625 highLightWidth(0),
6626 highLightColor(0),
6627 enableHighLight(false) {}
6628 ScreenCaptureParameters(int width, int height, int f, int b, view_t* ex, int cnt)
6629 : captureAudio(false),
6630 dimensions(width, height),
6631 frameRate(f),
6632 bitrate(b),
6633 captureMouseCursor(true),
6634 windowFocus(false),
6636 excludeWindowCount(cnt),
6637 highLightWidth(0),
6638 highLightColor(0),
6639 enableHighLight(false) {}
6640 ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs, view_t* ex,
6641 int cnt)
6642 : captureAudio(false),
6643 dimensions(width, height),
6644 frameRate(f),
6645 bitrate(b),
6646 captureMouseCursor(cur),
6647 windowFocus(fcs),
6649 excludeWindowCount(cnt),
6650 highLightWidth(0),
6651 highLightColor(0),
6652 enableHighLight(false) {}
6653};
6654
6680
6698
6716
6726 const char* filePath;
6753
6768
6776
6777 AudioRecordingConfiguration(const char* file_path, int sample_rate,
6778 AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
6779 : filePath(file_path),
6780 encode(false),
6781 sampleRate(sample_rate),
6783 quality(quality_type),
6784 recordingChannel(channel) {}
6785
6786 AudioRecordingConfiguration(const char* file_path, bool enc, int sample_rate,
6788 AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
6789 : filePath(file_path),
6790 encode(enc),
6791 sampleRate(sample_rate),
6792 fileRecordingType(type),
6793 quality(quality_type),
6794 recordingChannel(channel) {}
6795
6803};
6804
6822
6826 public:
6840 virtual void onRecordAudioEncodedFrame(const uint8_t* frameBuffer, int length,
6841 const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
6842
6856 virtual void onPlaybackAudioEncodedFrame(const uint8_t* frameBuffer, int length,
6857 const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
6858
6872 virtual void onMixedAudioEncodedFrame(const uint8_t* frameBuffer, int length,
6873 const EncodedAudioFrameInfo& audioEncodedFrameInfo) = 0;
6874
6876};
6877
6886 AREA_CODE_CN = 0x00000001,
6890 AREA_CODE_NA = 0x00000002,
6894 AREA_CODE_EU = 0x00000004,
6898 AREA_CODE_AS = 0x00000008,
6902 AREA_CODE_JP = 0x00000010,
6906 AREA_CODE_IN = 0x00000020,
6910 AREA_CODE_GLOB = (0xFFFFFFFF)
6911};
6912
6921 AREA_CODE_OC = 0x00000040,
6925 AREA_CODE_SA = 0x00000080,
6929 AREA_CODE_AF = 0x00000100,
6933 AREA_CODE_KR = 0x00000200,
6937 AREA_CODE_HKMC = 0x00000400,
6941 AREA_CODE_US = 0x00000800,
6945 AREA_CODE_RU = 0x00001000,
6949 AREA_CODE_OVS = 0xFFFFFFFE
6950};
6951
7011
7034
7046 const char* channelName;
7050 const char* token;
7051
7052 ChannelMediaInfo() : uid(0), channelName(NULL), token(NULL) {}
7053 ChannelMediaInfo(const char* c, const char* t, uid_t u) : uid(u), channelName(c), token(t) {}
7054};
7055
7101
7117
7123 const char* userId;
7136
7142
7144 : stream_type(rhs.stream_type),
7147 if (rhs.userId != OPTIONAL_NULLPTR) {
7148 const size_t len = std::strlen(rhs.userId);
7149 char* buf = new char[len + 1];
7150 std::memcpy(buf, rhs.userId, len);
7151 buf[len] = '\0';
7152 userId = buf;
7153 }
7154 }
7155
7157 if (this == &rhs) return *this;
7158 userId = OPTIONAL_NULLPTR;
7162 if (rhs.userId != OPTIONAL_NULLPTR) {
7163 const size_t len = std::strlen(rhs.userId);
7164 char* buf = new char[len + 1];
7165 std::memcpy(buf, rhs.userId, len);
7166 buf[len] = '\0';
7167 userId = buf;
7168 }
7169 return *this;
7170 }
7171
7173 };
7174
7195
7202
7214
7229
7231};
7232
7281
7296 const char* encryptionKey;
7304
7311
7314 encryptionKey(OPTIONAL_NULLPTR),
7316 memset(encryptionKdfSalt, 0, sizeof(encryptionKdfSalt));
7317 }
7318
7320 const char* getEncryptionString() const {
7321 switch (encryptionMode) {
7322 case AES_128_XTS:
7323 return "aes-128-xts";
7324 case AES_128_ECB:
7325 return "aes-128-ecb";
7326 case AES_256_XTS:
7327 return "aes-256-xts";
7328 case SM4_128_ECB:
7329 return "sm4-128-ecb";
7330 case AES_128_GCM:
7331 return "aes-128-gcm";
7332 case AES_256_GCM:
7333 return "aes-256-gcm";
7334 case AES_128_GCM2:
7335 return "aes-128-gcm-2";
7336 case AES_256_GCM2:
7337 return "aes-256-gcm-2";
7338 default:
7339 return "aes-128-gcm-2";
7340 }
7341 return "aes-128-gcm-2";
7342 }
7344};
7345
7373
7379
7425
7444
7478
7507
7538 const char* token;
7544 const char* channelId;
7553
7554 EchoTestConfiguration(view_t v, bool ea, bool ev, const char* t, const char* c, const int is)
7555 : view(v), enableAudio(ea), enableVideo(ev), token(t), channelId(c), intervalInSeconds(is) {}
7556
7558 : view(OPTIONAL_NULLPTR),
7559 enableAudio(true),
7560 enableVideo(true),
7561 token(OPTIONAL_NULLPTR),
7562 channelId(OPTIONAL_NULLPTR),
7563 intervalInSeconds(2) {}
7564};
7565
7581
7606
7636
7637#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
7638
7662
7698#endif
7699
7713
7801
7812
7827
7835 const char* serverDomain;
7839 const char* serverPath;
7850
7852
7853 LogUploadServerInfo(const char* domain, const char* path, int port, bool https)
7854 : serverDomain(domain), serverPath(path), serverPort(port), serverHttps(https) {}
7855};
7856
7867
7923
7937
7960
7984
8017} // namespace rtc
8018
8019namespace base {
8020
8022 public:
8023 virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid, void** inter) = 0;
8024 virtual ~IEngineBase() {}
8025};
8026
8027class AParameter : public agora::util::AutoPtr<IAgoraParameter> {
8028 public:
8029 AParameter(IEngineBase& engine) { initialize(&engine); }
8030 AParameter(IEngineBase* engine) { initialize(engine); }
8032
8033 private:
8034 bool initialize(IEngineBase* engine) {
8035 IAgoraParameter* p = OPTIONAL_NULLPTR;
8036 if (engine && !engine->queryInterface(rtc::AGORA_IID_PARAMETER_ENGINE, (void**)&p)) reset(p);
8037 return p != OPTIONAL_NULLPTR;
8038 }
8039};
8040
8042 public:
8043 virtual ~LicenseCallback() {}
8044 virtual void onCertificateRequired() = 0;
8045 virtual void onLicenseRequest() = 0;
8046 virtual void onLicenseValidated() = 0;
8047 virtual void onLicenseError(int result) = 0;
8048};
8049
8050} // namespace base
8051
8133
8140 const char* channelId;
8154 uint32_t x;
8160 uint32_t y;
8164 uint32_t width;
8168 uint32_t height;
8176 uint32_t videoState;
8177
8179 : channelId(OPTIONAL_NULLPTR),
8180 uid(0),
8181 strUid(OPTIONAL_NULLPTR),
8182 x(0),
8183 y(0),
8184 width(0),
8185 height(0),
8186 videoState(0) {}
8187};
8188} // namespace agora
8189
8195AGORA_API const char* AGORA_CALL getAgoraSdkVersion(int* build);
8196
8202AGORA_API const char* AGORA_CALL getAgoraSdkErrorDescription(int err);
8203
8204AGORA_API int AGORA_CALL setAgoraSdkExternalSymbolLoader(void* (*func)(const char* symname));
8205
8213AGORA_API int AGORA_CALL createAgoraCredential(agora::util::AString& credential);
8214
8228AGORA_API int AGORA_CALL getAgoraCertificateVerifyResult(const char* credential_buf,
8229 int credential_len,
8230 const char* certificate_buf,
8231 int certificate_len);
8232
8240AGORA_API void setAgoraLicenseCallback(agora::base::LicenseCallback* callback);
8241
8248
8249AGORA_API agora::base::LicenseCallback* getAgoraLicenseCallback();
8250
8251/*
8252 * Get monotonic time in ms which can be used by capture time,
8253 * typical scenario is as follows:
8254 *
8255 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8256 * | // custom audio/video base capture time, e.g. the first audio/video capture time. | | int64_t
8257 * custom_capture_time_base; | | | |
8258 * int64_t agora_monotonic_time = getAgoraCurrentMonotonicTimeInMs(); |
8259 * | | | // offset is fixed once calculated in the begining. | | const int64_t offset =
8260 * agora_monotonic_time - custom_capture_time_base; | | | | //
8261 * realtime_custom_audio/video_capture_time is the origin capture time that customer provided.| | //
8262 * actual_audio/video_capture_time is the actual capture time transfered to sdk. | |
8263 * int64_t actual_audio_capture_time = realtime_custom_audio_capture_time + offset; |
8264 * | int64_t actual_video_capture_time = realtime_custom_video_capture_time + offset; |
8265 * ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
8266 *
8267 * @return
8268 * - >= 0: Success.
8269 * - < 0: Failure.
8270 */
8271AGORA_API int64_t AGORA_CALL getAgoraCurrentMonotonicTimeInMs();
Definition AgoraOptional.h:413
AParameter(IEngineBase &engine)
Definition AgoraBase.h:8029
AParameter(IEngineBase *engine)
Definition AgoraBase.h:8030
AParameter(IAgoraParameter *p)
Definition AgoraBase.h:8031
The interface class of Agora RTC SDK, which provides JSON configuration information of the SDK.
Definition IAgoraParameter.h:151
Definition AgoraBase.h:8021
virtual ~IEngineBase()
Definition AgoraBase.h:8024
virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid, void **inter)=0
Definition AgoraBase.h:8041
virtual void onLicenseRequest()=0
virtual ~LicenseCallback()
Definition AgoraBase.h:8043
virtual void onLicenseValidated()=0
virtual void onCertificateRequired()=0
virtual void onLicenseError(int result)=0
Definition AgoraBase.h:6825
virtual ~IAudioEncodedFrameObserver()
Definition AgoraBase.h:6875
virtual void onRecordAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
Gets the encoded audio data of the local user.
virtual void onMixedAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
Gets the mixed and encoded audio data of the local and all remote users.
virtual void onPlaybackAudioEncodedFrame(const uint8_t *frameBuffer, int length, const EncodedAudioFrameInfo &audioEncodedFrameInfo)=0
Gets the encoded audio data of all remote users.
Definition AgoraBase.h:4031
virtual bool onReceiveVideoPacket(Packet &packet)=0
Occurs when the local user receives a video packet.
virtual bool onReceiveAudioPacket(Packet &packet)=0
Occurs when the local user receives an audio packet.
virtual ~IPacketObserver()
Definition AgoraBase.h:4033
virtual bool onSendVideoPacket(Packet &packet)=0
Occurs when the local user sends a video packet.
virtual bool onSendAudioPacket(Packet &packet)=0
Occurs when the local user sends an audio packet.
Definition AgoraBase.h:233
iterator begin()
Definition AgoraBase.h:256
AList(IContainer *c, bool take_ownership)
Definition AgoraBase.h:249
~AList()
Definition AgoraBase.h:250
const AOutputIterator< value_type > const_iterator
Definition AgoraBase.h:245
value_type * pointer
Definition AgoraBase.h:241
AOutputIterator< value_type > iterator
Definition AgoraBase.h:244
iterator end()
Definition AgoraBase.h:257
value_type & reference
Definition AgoraBase.h:239
AList()
Definition AgoraBase.h:248
T value_type
Definition AgoraBase.h:238
bool empty() const
Definition AgoraBase.h:259
const value_type * const_pointer
Definition AgoraBase.h:242
size_t size_type
Definition AgoraBase.h:243
void reset(IContainer *c=OPTIONAL_NULLPTR, bool take_ownership=false)
Definition AgoraBase.h:251
size_type size() const
Definition AgoraBase.h:258
const value_type & const_reference
Definition AgoraBase.h:240
Definition AgoraBase.h:202
AOutputIterator & operator++()
Definition AgoraBase.h:216
value_type & reference
Definition AgoraBase.h:207
bool operator!=(const AOutputIterator &rhs) const
Definition AgoraBase.h:226
reference operator*()
Definition AgoraBase.h:227
AOutputIterator(const AOutputIterator &rhs)
Definition AgoraBase.h:215
~AOutputIterator()
Definition AgoraBase.h:212
bool operator==(const AOutputIterator &rhs) const
Definition AgoraBase.h:220
T value_type
Definition AgoraBase.h:206
value_type * pointer
Definition AgoraBase.h:209
const value_type & const_reference
Definition AgoraBase.h:208
const value_type * const_pointer
Definition AgoraBase.h:210
const_reference operator*() const
Definition AgoraBase.h:228
AOutputIterator(IIterator *it=OPTIONAL_NULLPTR)
Definition AgoraBase.h:211
bool valid() const
Definition AgoraBase.h:229
Definition AgoraBase.h:100
value_type & operator*() const
Definition AgoraBase.h:117
void reset(pointer_type ptr=OPTIONAL_NULLPTR)
Definition AgoraBase.h:129
bool queryInterface(C1 *c, C2 iid)
Definition AgoraBase.h:138
pointer_type get() const
Definition AgoraBase.h:121
~AutoPtr()
Definition AgoraBase.h:108
T value_type
Definition AgoraBase.h:102
pointer_type release()
Definition AgoraBase.h:123
pointer_type operator->() const
Definition AgoraBase.h:119
AutoPtr(pointer_type p=OPTIONAL_NULLPTR)
Definition AgoraBase.h:106
T * pointer_type
Definition AgoraBase.h:103
Definition AgoraBase.h:156
CopyableAutoPtr(const CopyableAutoPtr &rhs)
Definition AgoraBase.h:161
pointer_type clone() const
Definition AgoraBase.h:166
CopyableAutoPtr & operator=(const CopyableAutoPtr &rhs)
Definition AgoraBase.h:162
CopyableAutoPtr(pointer_type p=0)
Definition AgoraBase.h:160
Definition AgoraBase.h:193
virtual size_t size() const =0
virtual ~IContainer()
Definition AgoraBase.h:198
virtual void release()=0
virtual IIterator * begin()=0
Definition AgoraBase.h:184
virtual void release()=0
virtual const void * const_current() const =0
virtual void * current()=0
virtual bool next()=0
virtual ~IIterator()
Definition AgoraBase.h:190
Definition AgoraBase.h:172
virtual const char * c_str()=0
virtual bool empty() const =0
virtual IString * clone()=0
virtual size_t length()=0
virtual const char * data()=0
virtual void release()=0
virtual ~IString()
Definition AgoraBase.h:180
Definition IAgoraService.h:73
VIDEO_MODULE_POSITION
The frame position of the video observer.
Definition AgoraMediaBase.h:1239
RENDER_MODE_TYPE
Video display modes.
Definition AgoraMediaBase.h:587
VIDEO_PIXEL_FORMAT
The video pixel format.
Definition AgoraMediaBase.h:519
Definition content_inspect_i.h:15
MEDIA_TRACE_EVENT
The rendering state of the media frame.
Definition AgoraBase.h:7703
@ MEDIA_TRACE_EVENT_VIDEO_RENDERED
Definition AgoraBase.h:7707
@ MEDIA_TRACE_EVENT_VIDEO_DECODED
Definition AgoraBase.h:7711
SIMULCAST_STREAM_MODE
The mode in which the video stream is sent.
Definition AgoraBase.h:2210
@ ENABLE_SIMULCAST_STREAM
Definition AgoraBase.h:2224
@ DISABLE_SIMULCAST_STREAM
Definition AgoraBase.h:2220
@ AUTO_SIMULCAST_STREAM
Definition AgoraBase.h:2216
const int DEFAULT_MIN_BITRATE
Definition AgoraBase.h:1201
AUDIENCE_LATENCY_LEVEL_TYPE
The latency level of an audience member in interactive live streaming. This enum takes effect only wh...
Definition AgoraBase.h:2984
@ AUDIENCE_LATENCY_LEVEL_LOW_LATENCY
Definition AgoraBase.h:2988
@ AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY
Definition AgoraBase.h:2992
VIDEO_CODEC_PROFILE_TYPE
Video codec profile types.
Definition AgoraBase.h:4127
@ VIDEO_CODEC_PROFILE_BASELINE
Definition AgoraBase.h:4131
@ VIDEO_CODEC_PROFILE_MAIN
Definition AgoraBase.h:4136
@ VIDEO_CODEC_PROFILE_HIGH
Definition AgoraBase.h:4141
CAMERA_FOCAL_LENGTH_TYPE
The camera focal length types.
Definition AgoraBase.h:1306
@ CAMERA_FOCAL_LENGTH_DEFAULT
Definition AgoraBase.h:1310
@ CAMERA_FOCAL_LENGTH_TELEPHOTO
Definition AgoraBase.h:1322
@ CAMERA_FOCAL_LENGTH_ULTRA_WIDE
Definition AgoraBase.h:1318
@ CAMERA_FOCAL_LENGTH_WIDE_ANGLE
Definition AgoraBase.h:1314
AUDIO_EFFECT_PRESET
Preset audio effects.
Definition AgoraBase.h:6200
@ ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND
Definition AgoraBase.h:6247
@ STYLE_TRANSFORMATION_RNB
Definition AgoraBase.h:6294
@ ROOM_ACOUSTICS_VOCAL_CONCERT
Definition AgoraBase.h:6212
@ ROOM_ACOUSTICS_STUDIO
Definition AgoraBase.h:6216
@ VOICE_CHANGER_EFFECT_GIRL
Definition AgoraBase.h:6282
@ PITCH_CORRECTION
Definition AgoraBase.h:6304
@ ROOM_ACOUSTICS_PHONOGRAPH
Definition AgoraBase.h:6220
@ ROOM_ACOUSTICS_SPACIAL
Definition AgoraBase.h:6228
@ ROOM_ACOUSTICS_VIRTUAL_STEREO
Definition AgoraBase.h:6224
@ VOICE_CHANGER_EFFECT_HULK
Definition AgoraBase.h:6290
@ VOICE_CHANGER_EFFECT_BOY
Definition AgoraBase.h:6270
@ ROOM_ACOUSTICS_KTV
Definition AgoraBase.h:6208
@ VOICE_CHANGER_EFFECT_UNCLE
Definition AgoraBase.h:6258
@ AUDIO_EFFECT_OFF
Definition AgoraBase.h:6204
@ VOICE_CHANGER_EFFECT_SISTER
Definition AgoraBase.h:6276
@ VOICE_CHANGER_EFFECT_PIGKING
Definition AgoraBase.h:6286
@ ROOM_ACOUSTICS_ETHEREAL
Definition AgoraBase.h:6232
@ STYLE_TRANSFORMATION_POPULAR
Definition AgoraBase.h:6298
@ ROOM_ACOUSTICS_CHORUS
Definition AgoraBase.h:6252
@ VOICE_CHANGER_EFFECT_OLDMAN
Definition AgoraBase.h:6264
@ ROOM_ACOUSTICS_3D_VOICE
Definition AgoraBase.h:6240
LOCAL_AUDIO_STREAM_STATE
The state of the local audio.
Definition AgoraBase.h:3404
@ LOCAL_AUDIO_STREAM_STATE_FAILED
Definition AgoraBase.h:3420
@ LOCAL_AUDIO_STREAM_STATE_RECORDING
Definition AgoraBase.h:3412
@ LOCAL_AUDIO_STREAM_STATE_STOPPED
Definition AgoraBase.h:3408
@ LOCAL_AUDIO_STREAM_STATE_ENCODING
Definition AgoraBase.h:3416
VOICE_BEAUTIFIER_PRESET
The options for SDK preset voice beautifier effects.
Definition AgoraBase.h:6111
@ TIMBRE_TRANSFORMATION_DEEP
Definition AgoraBase.h:6151
@ SINGING_BEAUTIFIER
Definition AgoraBase.h:6143
@ TIMBRE_TRANSFORMATION_MELLOW
Definition AgoraBase.h:6155
@ CHAT_BEAUTIFIER_MAGNETIC
Definition AgoraBase.h:6121
@ TIMBRE_TRANSFORMATION_FULL
Definition AgoraBase.h:6163
@ VOICE_BEAUTIFIER_OFF
Definition AgoraBase.h:6115
@ TIMBRE_TRANSFORMATION_CLEAR
Definition AgoraBase.h:6167
@ ULTRA_HIGH_QUALITY_VOICE
Definition AgoraBase.h:6186
@ TIMBRE_TRANSFORMATION_RINGING
Definition AgoraBase.h:6175
@ TIMBRE_TRANSFORMATION_RESOUNDING
Definition AgoraBase.h:6171
@ TIMBRE_TRANSFORMATION_VIGOROUS
Definition AgoraBase.h:6147
@ CHAT_BEAUTIFIER_FRESH
Definition AgoraBase.h:6127
@ TIMBRE_TRANSFORMATION_FALSETTO
Definition AgoraBase.h:6159
@ CHAT_BEAUTIFIER_VITALITY
Definition AgoraBase.h:6133
AUDIO_TRACK_TYPE
The type of the audio track.
Definition AgoraBase.h:6045
@ AUDIO_TRACK_MIXABLE
Definition AgoraBase.h:6055
@ AUDIO_TRACK_DIRECT
Definition AgoraBase.h:6065
@ AUDIO_TRACK_INVALID
Definition AgoraBase.h:6049
LOCAL_PROXY_MODE
Connection mode with the Agora Private Media Server.
Definition AgoraBase.h:7816
@ LocalOnly
Definition AgoraBase.h:7825
@ ConnectivityFirst
Definition AgoraBase.h:7821
FIT_MODE_TYPE
Definition AgoraBase.h:983
@ MODE_CONTAIN
Definition AgoraBase.h:995
@ MODE_COVER
Definition AgoraBase.h:988
AUDIO_FILE_RECORDING_TYPE
Recording content. Set in startAudioRecording [3/3].
Definition AgoraBase.h:6684
@ AUDIO_FILE_RECORDING_MIXED
Definition AgoraBase.h:6696
@ AUDIO_FILE_RECORDING_MIC
Definition AgoraBase.h:6688
@ AUDIO_FILE_RECORDING_PLAYBACK
Definition AgoraBase.h:6692
FRAME_HEIGHT
Definition AgoraBase.h:1059
@ FRAME_HEIGHT_540
Definition AgoraBase.h:1060
AUDIO_SCENARIO_TYPE
The audio scenarios.
Definition AgoraBase.h:3123
@ AUDIO_SCENARIO_NUM
Definition AgoraBase.h:3160
@ AUDIO_SCENARIO_GAME_STREAMING
Definition AgoraBase.h:3132
@ AUDIO_SCENARIO_MEETING
Definition AgoraBase.h:3146
@ AUDIO_SCENARIO_CHORUS
Definition AgoraBase.h:3142
@ AUDIO_SCENARIO_AI_CLIENT
Definition AgoraBase.h:3156
@ AUDIO_SCENARIO_AI_SERVER
Definition AgoraBase.h:3151
@ AUDIO_SCENARIO_CHATROOM
Definition AgoraBase.h:3137
@ AUDIO_SCENARIO_DEFAULT
Definition AgoraBase.h:3128
AUDIO_SOURCE_TYPE
The audio source type.
Definition AgoraMediaBase.h:151
VIDEO_QOE_PREFERENCE_TYPE
Definition AgoraBase.h:3322
@ VIDEO_QOE_PREFERENCE_FLUENCY_FIRST
Definition AgoraBase.h:3338
@ VIDEO_QOE_PREFERENCE_BALANCE
Definition AgoraBase.h:3326
@ VIDEO_QOE_PREFERENCE_PICTURE_QUALITY_FIRST
Definition AgoraBase.h:3334
@ VIDEO_QOE_PREFERENCE_DELAY_FIRST
Definition AgoraBase.h:3330
FRAME_WIDTH
Definition AgoraBase.h:1055
@ FRAME_WIDTH_960
Definition AgoraBase.h:1056
RecorderStreamType
Type of video stream to be recorded.
Definition AgoraBase.h:7927
@ PREVIEW
Definition AgoraBase.h:7935
@ RTC
Definition AgoraBase.h:7931
CONNECTION_CHANGED_REASON_TYPE
Reasons causing the change of the connection state.
Definition AgoraBase.h:5040
@ CONNECTION_CHANGED_STREAM_CHANNEL_NOT_AVAILABLE
Definition AgoraBase.h:5166
@ CONNECTION_CHANGED_INVALID_TOKEN
Definition AgoraBase.h:5097
@ CONNECTION_CHANGED_BANNED_BY_SERVER
Definition AgoraBase.h:5057
@ CONNECTION_CHANGED_SAME_UID_LOGIN
Definition AgoraBase.h:5149
@ CONNECTION_CHANGED_REJOIN_SUCCESS
Definition AgoraBase.h:5133
@ CONNECTION_CHANGED_ECHO_TEST
Definition AgoraBase.h:5141
@ CONNECTION_CHANGED_INCONSISTENT_APPID
Definition AgoraBase.h:5170
@ CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE
Definition AgoraBase.h:5162
@ CONNECTION_CHANGED_INVALID_CHANNEL_NAME
Definition AgoraBase.h:5082
@ CONNECTION_CHANGED_JOIN_SUCCESS
Definition AgoraBase.h:5048
@ CONNECTION_CHANGED_INTERRUPTED
Definition AgoraBase.h:5052
@ CONNECTION_CHANGED_LEAVE_CHANNEL
Definition AgoraBase.h:5067
@ CONNECTION_CHANGED_CONNECTING
Definition AgoraBase.h:5044
@ CONNECTION_CHANGED_SETTING_PROXY_SERVER
Definition AgoraBase.h:5115
@ CONNECTION_CHANGED_LOST
Definition AgoraBase.h:5137
@ CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED
Definition AgoraBase.h:5124
@ CONNECTION_CHANGED_TOO_MANY_BROADCASTERS
Definition AgoraBase.h:5153
@ CONNECTION_CHANGED_JOIN_FAILED
Definition AgoraBase.h:5063
@ CONNECTION_CHANGED_RENEW_TOKEN
Definition AgoraBase.h:5119
@ CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE
Definition AgoraBase.h:5158
@ CONNECTION_CHANGED_TOKEN_EXPIRED
Definition AgoraBase.h:5102
@ CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT
Definition AgoraBase.h:5129
@ CONNECTION_CHANGED_REJECTED_BY_SERVER
Definition AgoraBase.h:5111
@ CONNECTION_CHANGED_INVALID_APP_ID
Definition AgoraBase.h:5072
@ CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER
Definition AgoraBase.h:5145
ENCRYPTION_ERROR_TYPE
Encryption error type.
Definition AgoraBase.h:7349
@ ENCRYPTION_ERROR_ENCRYPTION_FAILURE
Definition AgoraBase.h:7362
@ ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE
Definition AgoraBase.h:7367
@ ENCRYPTION_ERROR_DECRYPTION_FAILURE
Definition AgoraBase.h:7358
@ ENCRYPTION_ERROR_INTERNAL_FAILURE
Definition AgoraBase.h:7353
@ ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE
Definition AgoraBase.h:7371
FRAME_RATE
The video frame rate.
Definition AgoraBase.h:1023
@ FRAME_RATE_FPS_24
Definition AgoraBase.h:1043
@ FRAME_RATE_FPS_15
Definition AgoraBase.h:1039
@ FRAME_RATE_FPS_1
Definition AgoraBase.h:1027
@ FRAME_RATE_FPS_10
Definition AgoraBase.h:1035
@ FRAME_RATE_FPS_30
Definition AgoraBase.h:1047
@ FRAME_RATE_FPS_7
Definition AgoraBase.h:1031
@ FRAME_RATE_FPS_60
Definition AgoraBase.h:1052
VIDEO_CONTENT_HINT
The content hint for screen sharing.
Definition AgoraBase.h:3209
@ CONTENT_HINT_MOTION
Definition AgoraBase.h:3218
@ CONTENT_HINT_DETAILS
Definition AgoraBase.h:3223
@ CONTENT_HINT_NONE
Definition AgoraBase.h:3213
CLIENT_ROLE_TYPE
The user role in the interactive live streaming.
Definition AgoraBase.h:2950
@ CLIENT_ROLE_AUDIENCE
Definition AgoraBase.h:2958
@ CLIENT_ROLE_BROADCASTER
Definition AgoraBase.h:2954
CONNECTION_STATE_TYPE
Connection states.
Definition AgoraBase.h:4432
@ CONNECTION_STATE_DISCONNECTED
Definition AgoraBase.h:4440
@ CONNECTION_STATE_RECONNECTING
Definition AgoraBase.h:4468
@ CONNECTION_STATE_CONNECTING
Definition AgoraBase.h:4450
@ CONNECTION_STATE_FAILED
Definition AgoraBase.h:4478
@ CONNECTION_STATE_CONNECTED
Definition AgoraBase.h:4458
VIDEO_VIEW_SETUP_MODE
Setting mode of the view.
Definition AgoraBase.h:5244
@ VIDEO_VIEW_SETUP_ADD
Definition AgoraBase.h:5252
@ VIDEO_VIEW_SETUP_REMOVE
Definition AgoraBase.h:5259
@ VIDEO_VIEW_SETUP_REPLACE
Definition AgoraBase.h:5248
AUDIO_SAMPLE_RATE_TYPE
The audio sampling rate of the stream to be pushed to the CDN.
Definition AgoraBase.h:4096
@ AUDIO_SAMPLE_RATE_32000
Definition AgoraBase.h:4100
@ AUDIO_SAMPLE_RATE_48000
Definition AgoraBase.h:4108
@ AUDIO_SAMPLE_RATE_44100
Definition AgoraBase.h:4104
PERMISSION_TYPE
The type of the device permission.
Definition AgoraBase.h:7429
@ RECORD_AUDIO
Definition AgoraBase.h:7433
@ SCREEN_CAPTURE
Definition AgoraBase.h:7442
@ CAMERA
Definition AgoraBase.h:7437
const int COMPATIBLE_BITRATE
Definition AgoraBase.h:1196
REMOTE_AUDIO_STATE_REASON
The reason for the remote audio state change.
Definition AgoraBase.h:3730
@ REMOTE_AUDIO_REASON_REMOTE_UNMUTED
Definition AgoraBase.h:3758
@ REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED
Definition AgoraBase.h:3770
@ REMOTE_AUDIO_REASON_REMOTE_MUTED
Definition AgoraBase.h:3754
@ REMOTE_AUDIO_REASON_LOCAL_MUTED
Definition AgoraBase.h:3746
@ REMOTE_AUDIO_REASON_REMOTE_OFFLINE
Definition AgoraBase.h:3762
@ REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE
Definition AgoraBase.h:3766
@ REMOTE_AUDIO_REASON_NETWORK_CONGESTION
Definition AgoraBase.h:3738
@ REMOTE_AUDIO_REASON_NETWORK_RECOVERY
Definition AgoraBase.h:3742
@ REMOTE_AUDIO_REASON_LOCAL_UNMUTED
Definition AgoraBase.h:3750
@ REMOTE_AUDIO_REASON_INTERNAL
Definition AgoraBase.h:3734
TCcMode
Definition AgoraBase.h:1328
@ CC_DISABLED
Definition AgoraBase.h:1336
@ CC_ENABLED
Definition AgoraBase.h:1332
USER_OFFLINE_REASON_TYPE
Reasons for a user being offline.
Definition AgoraBase.h:884
@ USER_OFFLINE_BECOME_AUDIENCE
Definition AgoraBase.h:899
@ USER_OFFLINE_QUIT
Definition AgoraBase.h:888
@ USER_OFFLINE_DROPPED
Definition AgoraBase.h:895
MultipathMode
The transmission mode of data over multiple network paths.
Definition AgoraBase.h:2631
@ Dynamic
Definition AgoraBase.h:2640
@ Duplicate
Definition AgoraBase.h:2635
STREAM_PUBLISH_STATE
The publishing state.
Definition AgoraBase.h:7482
@ PUB_STATE_IDLE
Definition AgoraBase.h:7486
@ PUB_STATE_PUBLISHED
Definition AgoraBase.h:7505
@ PUB_STATE_PUBLISHING
Definition AgoraBase.h:7501
@ PUB_STATE_NO_PUBLISHED
Definition AgoraBase.h:7497
VIDEO_STREAM_TYPE
The type of video streams.
Definition AgoraBase.h:1660
@ VIDEO_STREAM_HIGH
Definition AgoraBase.h:1664
@ VIDEO_STREAM_LAYER_1
Definition AgoraBase.h:1673
@ VIDEO_STREAM_LAYER_3
Definition AgoraBase.h:1683
@ VIDEO_STREAM_LOW
Definition AgoraBase.h:1668
@ VIDEO_STREAM_LAYER_5
Definition AgoraBase.h:1693
@ VIDEO_STREAM_LAYER_4
Definition AgoraBase.h:1688
@ VIDEO_STREAM_LAYER_6
Definition AgoraBase.h:1698
@ VIDEO_STREAM_LAYER_2
Definition AgoraBase.h:1678
const int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE
Definition AgoraBase.h:1206
LOCAL_AUDIO_STREAM_REASON
Reasons for local audio state changes.
Definition AgoraBase.h:3426
@ LOCAL_AUDIO_STREAM_REASON_FAILURE
Definition AgoraBase.h:3435
@ LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE
Definition AgoraBase.h:3460
@ LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY
Definition AgoraBase.h:3446
@ LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE
Definition AgoraBase.h:3466
@ LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID
Definition AgoraBase.h:3482
@ LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION
Definition AgoraBase.h:3439
@ LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID
Definition AgoraBase.h:3477
@ LOCAL_AUDIO_STREAM_REASON_INTERRUPTED
Definition AgoraBase.h:3472
@ LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE
Definition AgoraBase.h:3454
@ LOCAL_AUDIO_STREAM_REASON_OK
Definition AgoraBase.h:3430
@ LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE
Definition AgoraBase.h:3450
H264PacketizeMode
Definition AgoraBase.h:1646
@ SingleNalUnit
Definition AgoraBase.h:1654
@ NonInterleaved
Definition AgoraBase.h:1650
MultipathType
Network path types used in multipath transmission.
Definition AgoraBase.h:2648
@ WIFI
Definition AgoraBase.h:2656
@ LAN
Definition AgoraBase.h:2652
@ Unknown
Definition AgoraBase.h:2664
@ Mobile
Definition AgoraBase.h:2660
EAR_MONITORING_FILTER_TYPE
The audio filter types of in-ear monitoring.
Definition AgoraBase.h:7585
@ EAR_MONITORING_FILTER_NOISE_SUPPRESSION
Definition AgoraBase.h:7598
@ EAR_MONITORING_FILTER_NONE
Definition AgoraBase.h:7589
@ EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER
Definition AgoraBase.h:7604
@ EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS
Definition AgoraBase.h:7594
AUDIO_AINS_MODE
AI noise suppression modes.
Definition AgoraBase.h:3052
@ AINS_MODE_BALANCED
Definition AgoraBase.h:3057
@ AINS_MODE_ULTRALOWLATENCY
Definition AgoraBase.h:3069
@ AINS_MODE_AGGRESSIVE
Definition AgoraBase.h:3063
unsigned int track_id_t
Definition AgoraMediaBase.h:29
AUDIO_PROFILE_TYPE
The audio profile.
Definition AgoraBase.h:3075
@ AUDIO_PROFILE_MUSIC_STANDARD_STEREO
Definition AgoraBase.h:3099
@ AUDIO_PROFILE_IOT
Definition AgoraBase.h:3113
@ AUDIO_PROFILE_MUSIC_HIGH_QUALITY
Definition AgoraBase.h:3103
@ AUDIO_PROFILE_NUM
Definition AgoraBase.h:3117
@ AUDIO_PROFILE_DEFAULT
Definition AgoraBase.h:3085
@ AUDIO_PROFILE_MUSIC_STANDARD
Definition AgoraBase.h:3093
@ AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO
Definition AgoraBase.h:3109
@ AUDIO_PROFILE_SPEECH_STANDARD
Definition AgoraBase.h:3089
SCREEN_CAPTURE_FRAMERATE_CAPABILITY
The highest frame rate supported by the screen sharing device.
Definition AgoraBase.h:1211
@ SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS
Definition AgoraBase.h:1215
@ SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS
Definition AgoraBase.h:1219
@ SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS
Definition AgoraBase.h:1223
VIDEO_CODEC_TYPE
Video codec types.
Definition AgoraBase.h:1256
@ VIDEO_CODEC_GENERIC_H264
Definition AgoraBase.h:1284
@ VIDEO_CODEC_H265
Definition AgoraBase.h:1273
@ VIDEO_CODEC_GENERIC_JPEG
Definition AgoraBase.h:1297
@ VIDEO_CODEC_VP9
Definition AgoraBase.h:1293
@ VIDEO_CODEC_AV1
Definition AgoraBase.h:1289
@ VIDEO_CODEC_H264
Definition AgoraBase.h:1269
@ VIDEO_CODEC_GENERIC
Definition AgoraBase.h:1279
@ VIDEO_CODEC_NONE
Definition AgoraBase.h:1261
@ VIDEO_CODEC_VP8
Definition AgoraBase.h:1265
LOCAL_VIDEO_EVENT_TYPE
The local video event type.
Definition AgoraBase.h:3512
@ LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_STOPPED_BY_USER
Definition AgoraBase.h:3524
@ LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_HIDDEN
Definition AgoraBase.h:3516
@ LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_SYSTEM_INTERNAL_ERROR
Definition AgoraBase.h:3528
@ LOCAL_VIDEO_EVENT_TYPE_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN
Definition AgoraBase.h:3520
LOCAL_VIDEO_STREAM_STATE
Local video state types.
Definition AgoraBase.h:3488
@ LOCAL_VIDEO_STREAM_STATE_ENCODING
Definition AgoraBase.h:3501
@ LOCAL_VIDEO_STREAM_STATE_FAILED
Definition AgoraBase.h:3505
@ LOCAL_VIDEO_STREAM_STATE_STOPPED
Definition AgoraBase.h:3492
@ LOCAL_VIDEO_STREAM_STATE_CAPTURING
Definition AgoraBase.h:3497
AUDIO_ENCODING_TYPE
Audio encoding type.
Definition AgoraBase.h:1470
@ AUDIO_ENCODING_TYPE_AAC_32000_HIGH
Definition AgoraBase.h:1495
@ AUDIO_ENCODING_TYPE_AAC_16000_LOW
Definition AgoraBase.h:1475
@ AUDIO_ENCODING_TYPE_AAC_32000_LOW
Definition AgoraBase.h:1485
@ AUDIO_ENCODING_TYPE_AAC_48000_HIGH
Definition AgoraBase.h:1505
@ AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM
Definition AgoraBase.h:1520
@ AUDIO_ENCODING_TYPE_OPUS_16000_LOW
Definition AgoraBase.h:1510
@ AUDIO_ENCODING_TYPE_OPUS_48000_HIGH
Definition AgoraBase.h:1525
@ AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM
Definition AgoraBase.h:1480
@ AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM
Definition AgoraBase.h:1500
@ AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM
Definition AgoraBase.h:1515
@ AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM
Definition AgoraBase.h:1490
REMOTE_VIDEO_STATE
The state of the remote video stream.
Definition AgoraBase.h:3776
@ REMOTE_VIDEO_STATE_FAILED
Definition AgoraBase.h:3803
@ REMOTE_VIDEO_STATE_DECODING
Definition AgoraBase.h:3793
@ REMOTE_VIDEO_STATE_FROZEN
Definition AgoraBase.h:3798
@ REMOTE_VIDEO_STATE_STARTING
Definition AgoraBase.h:3786
@ REMOTE_VIDEO_STATE_STOPPED
Definition AgoraBase.h:3782
RTMP_STREAMING_EVENT
Events during the Media Push.
Definition AgoraBase.h:4330
@ RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN
Definition AgoraBase.h:4347
@ RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE
Definition AgoraBase.h:4334
@ RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT
Definition AgoraBase.h:4343
@ RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE
Definition AgoraBase.h:4339
EXPERIENCE_POOR_REASON
Reasons why the QoE of the local user when receiving a remote audio stream is poor.
Definition AgoraBase.h:3025
@ LOCAL_NETWORK_QUALITY_POOR
Definition AgoraBase.h:3037
@ EXPERIENCE_REASON_NONE
Definition AgoraBase.h:3029
@ WIRELESS_SIGNAL_POOR
Definition AgoraBase.h:3041
@ WIFI_BLUETOOTH_COEXIST
Definition AgoraBase.h:3046
@ REMOTE_NETWORK_QUALITY_POOR
Definition AgoraBase.h:3033
AREA_CODE
The region for connection, which is the region where the server the SDK connects to is located.
Definition AgoraBase.h:6882
@ AREA_CODE_NA
Definition AgoraBase.h:6890
@ AREA_CODE_AS
Definition AgoraBase.h:6898
@ AREA_CODE_EU
Definition AgoraBase.h:6894
@ AREA_CODE_JP
Definition AgoraBase.h:6902
@ AREA_CODE_GLOB
Definition AgoraBase.h:6910
@ AREA_CODE_IN
Definition AgoraBase.h:6906
@ AREA_CODE_CN
Definition AgoraBase.h:6886
MAX_USER_ACCOUNT_LENGTH_TYPE
The maximum length of the user account.
Definition AgoraBase.h:1725
@ MAX_USER_ACCOUNT_LENGTH
Definition AgoraBase.h:1729
SCREEN_SCENARIO_TYPE
The screen sharing scenario.
Definition AgoraBase.h:3228
@ SCREEN_SCENARIO_RDC
Definition AgoraBase.h:3250
@ SCREEN_SCENARIO_DOCUMENT
Definition AgoraBase.h:3234
@ SCREEN_SCENARIO_GAMING
Definition AgoraBase.h:3239
@ SCREEN_SCENARIO_VIDEO
Definition AgoraBase.h:3244
EXPERIENCE_QUALITY_TYPE
The Quality of Experience (QoE) of the local user when receiving a remote audio stream.
Definition AgoraBase.h:3011
@ EXPERIENCE_QUALITY_GOOD
Definition AgoraBase.h:3015
@ EXPERIENCE_QUALITY_BAD
Definition AgoraBase.h:3019
RENEW_TOKEN_ERROR_CODE
Represents the error codes after calling renewToken.
Definition AgoraBase.h:7385
@ RENEW_TOKEN_FAILURE
Definition AgoraBase.h:7394
@ RENEW_TOKEN_INCONSISTENT_APPID
Definition AgoraBase.h:7419
@ RENEW_TOKEN_INVALID_CHANNEL_NAME
Definition AgoraBase.h:7414
@ RENEW_TOKEN_CANCELED_BY_NEW_REQUEST
Definition AgoraBase.h:7423
@ RENEW_TOKEN_TOKEN_EXPIRED
Definition AgoraBase.h:7399
@ RENEW_TOKEN_SUCCESS
Definition AgoraBase.h:7389
@ RENEW_TOKEN_INVALID_TOKEN
Definition AgoraBase.h:7408
VIDEO_MIRROR_MODE_TYPE
Video mirror mode.
Definition AgoraBase.h:1912
@ VIDEO_MIRROR_MODE_AUTO
Definition AgoraBase.h:1919
@ VIDEO_MIRROR_MODE_ENABLED
Definition AgoraBase.h:1923
@ VIDEO_MIRROR_MODE_DISABLED
Definition AgoraBase.h:1927
ENCRYPTION_MODE
The built-in encryption mode.
Definition AgoraBase.h:7241
@ AES_256_GCM
Definition AgoraBase.h:7265
@ AES_256_XTS
Definition AgoraBase.h:7253
@ AES_256_GCM2
Definition AgoraBase.h:7275
@ AES_128_ECB
Definition AgoraBase.h:7249
@ AES_128_XTS
Definition AgoraBase.h:7245
@ MODE_END
Definition AgoraBase.h:7279
@ SM4_128_ECB
Definition AgoraBase.h:7257
@ AES_128_GCM2
Definition AgoraBase.h:7270
@ AES_128_GCM
Definition AgoraBase.h:7261
AUDIO_RECORDING_QUALITY_TYPE
Recording quality.
Definition AgoraBase.h:6658
@ AUDIO_RECORDING_QUALITY_HIGH
Definition AgoraBase.h:6673
@ AUDIO_RECORDING_QUALITY_MEDIUM
Definition AgoraBase.h:6668
@ AUDIO_RECORDING_QUALITY_LOW
Definition AgoraBase.h:6663
@ AUDIO_RECORDING_QUALITY_ULTRA_HIGH
Definition AgoraBase.h:6678
RdtState
Reliable Data Transmission tunnel state.
Definition AgoraBase.h:7990
@ RDT_STATE_CLOSED
Definition AgoraBase.h:7994
@ RDT_STATE_PENDING
Definition AgoraBase.h:8008
@ RDT_STATE_OPENED
Definition AgoraBase.h:7998
@ RDT_STATE_BLOCKED
Definition AgoraBase.h:8003
@ RDT_STATE_BROKEN
Definition AgoraBase.h:8015
RTMP_STREAM_PUBLISH_REASON
Reasons for changes in the status of RTMP or RTMPS streaming.
Definition AgoraBase.h:4248
@ RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN
Definition AgoraBase.h:4276
@ RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED
Definition AgoraBase.h:4260
@ RTMP_STREAM_PUBLISH_REASON_INVALID_APPID
Definition AgoraBase.h:4314
@ RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT
Definition AgoraBase.h:4256
@ RTMP_STREAM_PUBLISH_REASON_OK
Definition AgoraBase.h:4252
@ RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER
Definition AgoraBase.h:4299
@ RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT
Definition AgoraBase.h:4280
@ RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND
Definition AgoraBase.h:4289
@ RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE
Definition AgoraBase.h:4319
@ RTMP_STREAM_UNPUBLISH_REASON_OK
Definition AgoraBase.h:4324
@ RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT
Definition AgoraBase.h:4264
@ RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR
Definition AgoraBase.h:4268
@ RTMP_STREAM_PUBLISH_REASON_NET_DOWN
Definition AgoraBase.h:4310
@ RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM
Definition AgoraBase.h:4305
@ RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR
Definition AgoraBase.h:4272
@ RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED
Definition AgoraBase.h:4285
@ RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED
Definition AgoraBase.h:4294
REMOTE_VIDEO_DOWNSCALE_LEVEL
Definition AgoraBase.h:3947
@ REMOTE_VIDEO_DOWNSCALE_LEVEL_1
Definition AgoraBase.h:3955
@ REMOTE_VIDEO_DOWNSCALE_LEVEL_3
Definition AgoraBase.h:3963
@ REMOTE_VIDEO_DOWNSCALE_LEVEL_4
Definition AgoraBase.h:3967
@ REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE
Definition AgoraBase.h:3951
@ REMOTE_VIDEO_DOWNSCALE_LEVEL_2
Definition AgoraBase.h:3959
CONFIG_FETCH_TYPE
Definition AgoraBase.h:7802
@ CONFIG_FETCH_TYPE_INITIALIZE
Definition AgoraBase.h:7806
@ CONFIG_FETCH_TYPE_JOIN_CHANNEL
Definition AgoraBase.h:7810
CODEC_CAP_MASK
The bit mask of the codec type.
Definition AgoraBase.h:1969
@ CODEC_CAP_MASK_HW_ENC
Definition AgoraBase.h:1983
@ CODEC_CAP_MASK_SW_DEC
Definition AgoraBase.h:1988
@ CODEC_CAP_MASK_HW_DEC
Definition AgoraBase.h:1978
@ CODEC_CAP_MASK_SW_ENC
Definition AgoraBase.h:1993
@ CODEC_CAP_MASK_NONE
Definition AgoraBase.h:1973
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition AgoraBase.h:7966
@ RDT_STREAM_COUNT
Definition AgoraBase.h:7982
@ RDT_STREAM_DATA
Definition AgoraBase.h:7978
@ RDT_STREAM_CMD
Definition AgoraBase.h:7972
VIDEO_CODEC_CAPABILITY_LEVEL
The level of the codec capability.
Definition AgoraBase.h:1229
@ CODEC_CAPABILITY_LEVEL_1080P30FPS
Definition AgoraBase.h:1242
@ CODEC_CAPABILITY_LEVEL_UNSPECIFIED
Definition AgoraBase.h:1234
@ CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT
Definition AgoraBase.h:1238
@ CODEC_CAPABILITY_LEVEL_4K60FPS
Definition AgoraBase.h:1250
@ CODEC_CAPABILITY_LEVEL_1080P60FPS
Definition AgoraBase.h:1246
RTMP_STREAM_PUBLISH_STATE
States of the Media Push.
Definition AgoraBase.h:4209
@ RTMP_STREAM_PUBLISH_STATE_IDLE
Definition AgoraBase.h:4213
@ RTMP_STREAM_PUBLISH_STATE_RUNNING
Definition AgoraBase.h:4222
@ RTMP_STREAM_PUBLISH_STATE_FAILURE
Definition AgoraBase.h:4236
@ RTMP_STREAM_PUBLISH_STATE_DISCONNECTING
Definition AgoraBase.h:4242
@ RTMP_STREAM_PUBLISH_STATE_CONNECTING
Definition AgoraBase.h:4217
@ RTMP_STREAM_PUBLISH_STATE_RECOVERING
Definition AgoraBase.h:4231
LOCAL_VIDEO_STREAM_REASON
Reasons for local video state changes.
Definition AgoraBase.h:3534
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR
Definition AgoraBase.h:3604
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_CALL
Definition AgoraBase.h:3688
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED
Definition AgoraBase.h:3628
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND
Definition AgoraBase.h:3579
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED
Definition AgoraBase.h:3677
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK
Definition AgoraBase.h:3653
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED
Definition AgoraBase.h:3673
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN
Definition AgoraBase.h:3662
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_STOPPED_BY_USER
Definition AgoraBase.h:3684
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION
Definition AgoraBase.h:3547
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED
Definition AgoraBase.h:3614
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_INTERRUPTED_BY_OTHER
Definition AgoraBase.h:3686
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN
Definition AgoraBase.h:3658
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID
Definition AgoraBase.h:3589
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE
Definition AgoraBase.h:3639
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_EXCLUDE_WINDOW_FAILED
Definition AgoraBase.h:3690
@ LOCAL_VIDEO_STREAM_REASON_OK
Definition AgoraBase.h:3538
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE
Definition AgoraBase.h:3608
@ LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS
Definition AgoraBase.h:3573
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY
Definition AgoraBase.h:3552
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED
Definition AgoraBase.h:3633
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION
Definition AgoraBase.h:3643
@ LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE
Definition AgoraBase.h:3557
@ LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND
Definition AgoraBase.h:3566
@ LOCAL_VIDEO_STREAM_REASON_FAILURE
Definition AgoraBase.h:3542
@ LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT
Definition AgoraBase.h:3561
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED
Definition AgoraBase.h:3682
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT
Definition AgoraBase.h:3598
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED
Definition AgoraBase.h:3635
@ LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED
Definition AgoraBase.h:3584
@ LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED
Definition AgoraBase.h:3667
const int STANDARD_BITRATE
Definition AgoraBase.h:1187
CLIENT_ROLE_CHANGE_FAILED_REASON
The reason for a user role switch failure.
Definition AgoraBase.h:5176
@ CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS
Definition AgoraBase.h:5183
@ __deprecated
Definition AgoraBase.h:945
@ CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED
Definition AgoraBase.h:5188
VIDEO_MODULE_TYPE
Definition AgoraBase.h:1942
@ VIDEO_MODULE_HARDWARE_ENCODER
Definition AgoraBase.h:1948
@ VIDEO_MODULE_HARDWARE_DECODER
Definition AgoraBase.h:1952
@ VIDEO_MODULE_SOFTWARE_ENCODER
Definition AgoraBase.h:1946
@ VIDEO_MODULE_SOFTWARE_DECODER
Definition AgoraBase.h:1950
@ VIDEO_MODULE_RENDERER
Definition AgoraBase.h:1954
@ VIDEO_MODULE_CAPTURER
Definition AgoraBase.h:1944
LASTMILE_PROBE_RESULT_STATE
The status of the last-mile probe test.
Definition AgoraBase.h:4976
@ LASTMILE_PROBE_RESULT_COMPLETE
Definition AgoraBase.h:4980
@ LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE
Definition AgoraBase.h:4986
@ LASTMILE_PROBE_RESULT_UNAVAILABLE
Definition AgoraBase.h:4990
REMOTE_AUDIO_STATE
Remote audio states.
Definition AgoraBase.h:3696
@ REMOTE_AUDIO_STATE_FAILED
Definition AgoraBase.h:3724
@ REMOTE_AUDIO_STATE_STARTING
Definition AgoraBase.h:3707
@ REMOTE_AUDIO_STATE_STOPPED
Definition AgoraBase.h:3702
@ REMOTE_AUDIO_STATE_FROZEN
Definition AgoraBase.h:3719
@ REMOTE_AUDIO_STATE_DECODING
Definition AgoraBase.h:3713
struct agora::rtc::RtcImage RtcImage
Image properties.
HEADPHONE_EQUALIZER_PRESET
Preset headphone equalizer types.
Definition AgoraBase.h:6378
@ HEADPHONE_EQUALIZER_INEAR
Definition AgoraBase.h:6390
@ HEADPHONE_EQUALIZER_OFF
Definition AgoraBase.h:6382
@ HEADPHONE_EQUALIZER_OVEREAR
Definition AgoraBase.h:6386
CAMERA_FORMAT_TYPE
Definition AgoraBase.h:1934
@ CAMERA_FORMAT_NV12
Definition AgoraBase.h:1936
@ CAMERA_FORMAT_BGRA
Definition AgoraBase.h:1938
THREAD_PRIORITY_TYPE
Definition AgoraBase.h:7610
@ CRITICAL
Definition AgoraBase.h:7634
@ HIGH
Definition AgoraBase.h:7626
@ HIGHEST
Definition AgoraBase.h:7630
@ NORMAL
Definition AgoraBase.h:7622
@ LOW
Definition AgoraBase.h:7618
@ LOWEST
Definition AgoraBase.h:7614
NETWORK_TYPE
Network type.
Definition AgoraBase.h:5206
@ NETWORK_TYPE_DISCONNECTED
Definition AgoraBase.h:5214
@ NETWORK_TYPE_MOBILE_3G
Definition AgoraBase.h:5230
@ NETWORK_TYPE_MOBILE_4G
Definition AgoraBase.h:5234
@ NETWORK_TYPE_MOBILE_5G
Definition AgoraBase.h:5238
@ NETWORK_TYPE_UNKNOWN
Definition AgoraBase.h:5210
@ NETWORK_TYPE_LAN
Definition AgoraBase.h:5218
@ NETWORK_TYPE_WIFI
Definition AgoraBase.h:5222
@ NETWORK_TYPE_MOBILE_2G
Definition AgoraBase.h:5226
unsigned int uid_t
Definition AgoraMediaBase.h:28
QUALITY_ADAPT_INDICATION
Quality change of the local video in terms of target frame rate and target bit rate since last count.
Definition AgoraBase.h:2965
@ ADAPT_NONE
Definition AgoraBase.h:2969
@ ADAPT_UP_BANDWIDTH
Definition AgoraBase.h:2973
@ ADAPT_DOWN_BANDWIDTH
Definition AgoraBase.h:2977
VOICE_AI_TUNER_TYPE
Voice AI tuner sound types.
Definition AgoraBase.h:6396
@ VOICE_AI_TUNER_GENTLE_FEMALE_SINGING
Definition AgoraBase.h:6420
@ VOICE_AI_TUNER_HUSKY_MALE_SINGING
Definition AgoraBase.h:6424
@ VOICE_AI_TUNER_FRESH_MALE
Definition AgoraBase.h:6404
@ VOICE_AI_TUNER_WARM_ELEGANT_FEMALE_SINGING
Definition AgoraBase.h:6428
@ VOICE_AI_TUNER_WARM_MALE_SINGING
Definition AgoraBase.h:6416
@ VOICE_AI_TUNER_ELEGANT_FEMALE
Definition AgoraBase.h:6408
@ VOICE_AI_TUNER_MATURE_MALE
Definition AgoraBase.h:6400
@ VOICE_AI_TUNER_POWERFUL_MALE_SINGING
Definition AgoraBase.h:6432
@ VOICE_AI_TUNER_SWEET_FEMALE
Definition AgoraBase.h:6412
@ VOICE_AI_TUNER_DREAMY_FEMALE_SINGING
Definition AgoraBase.h:6436
HDR_CAPABILITY
Definition AgoraBase.h:1957
@ HDR_CAPABILITY_UNKNOWN
Definition AgoraBase.h:1959
@ HDR_CAPABILITY_SUPPORTED
Definition AgoraBase.h:1963
@ HDR_CAPABILITY_UNSUPPORTED
Definition AgoraBase.h:1961
REMOTE_USER_STATE
Definition AgoraBase.h:3872
@ USER_STATE_MUTE_VIDEO
Definition AgoraBase.h:3880
@ USER_STATE_ENABLE_LOCAL_VIDEO
Definition AgoraBase.h:3888
@ USER_STATE_MUTE_AUDIO
Definition AgoraBase.h:3876
@ USER_STATE_ENABLE_VIDEO
Definition AgoraBase.h:3884
VIDEO_APPLICATION_SCENARIO_TYPE
The video application scenarios.
Definition AgoraBase.h:3256
@ APPLICATION_SCENARIO_LIVESHOW
Definition AgoraBase.h:3316
@ APPLICATION_SCENARIO_MEETING
Definition AgoraBase.h:3296
@ APPLICATION_SCENARIO_GENERAL
Definition AgoraBase.h:3260
@ APPLICATION_SCENARIO_1V1
Definition AgoraBase.h:3305
CAMERA_STABILIZATION_MODE
Camera stabilization modes.
Definition AgoraBase.h:3373
@ CAMERA_STABILIZATION_MODE_OFF
Definition AgoraBase.h:3377
@ CAMERA_STABILIZATION_MODE_LEVEL_1
Definition AgoraBase.h:3387
@ CAMERA_STABILIZATION_MODE_AUTO
Definition AgoraBase.h:3383
@ CAMERA_STABILIZATION_MODE_LEVEL_2
Definition AgoraBase.h:3391
@ CAMERA_STABILIZATION_MODE_MAX_LEVEL
Definition AgoraBase.h:3398
@ CAMERA_STABILIZATION_MODE_LEVEL_3
Definition AgoraBase.h:3395
AUDIO_CODEC_TYPE
The codec type of audio.
Definition AgoraBase.h:1420
@ AUDIO_CODEC_G722
Definition AgoraBase.h:1437
@ AUDIO_CODEC_HEAAC
Definition AgoraBase.h:1448
@ AUDIO_CODEC_PCMU
Definition AgoraBase.h:1433
@ AUDIO_CODEC_OPUS
Definition AgoraBase.h:1424
@ AUDIO_CODEC_HEAAC2
Definition AgoraBase.h:1456
@ AUDIO_CODEC_AACLC
Definition AgoraBase.h:1444
@ AUDIO_CODEC_JC1
Definition AgoraBase.h:1452
@ AUDIO_CODEC_PCMA
Definition AgoraBase.h:1429
@ AUDIO_CODEC_LPCNET
Definition AgoraBase.h:1460
@ AUDIO_CODEC_OPUSMC
Definition AgoraBase.h:1464
STREAM_SUBSCRIBE_STATE
The subscribing state.
Definition AgoraBase.h:7448
@ SUB_STATE_IDLE
Definition AgoraBase.h:7452
@ SUB_STATE_NO_SUBSCRIBED
Definition AgoraBase.h:7468
@ SUB_STATE_SUBSCRIBING
Definition AgoraBase.h:7472
@ SUB_STATE_SUBSCRIBED
Definition AgoraBase.h:7476
VIDEO_SOURCE_TYPE
The type of the video source.
Definition AgoraMediaBase.h:67
@ VIDEO_SOURCE_CAMERA_PRIMARY
Definition AgoraMediaBase.h:71
WATERMARK_FIT_MODE
The adaptation mode of the watermark.
Definition AgoraBase.h:1531
@ FIT_MODE_USE_IMAGE_RATIO
Definition AgoraBase.h:1541
@ FIT_MODE_COVER_POSITION
Definition AgoraBase.h:1536
WATERMARK_SOURCE_TYPE
Type of watermark source.
Definition AgoraBase.h:2452
@ BUFFER
Definition AgoraBase.h:2460
@ TIMESTAMPS
Definition AgoraBase.h:2472
@ IMAGE
Definition AgoraBase.h:2456
@ LITERAL
Definition AgoraBase.h:2466
CAPTURE_BRIGHTNESS_LEVEL_TYPE
The brightness level of the video image captured by the local camera.
Definition AgoraBase.h:3345
@ CAPTURE_BRIGHTNESS_LEVEL_BRIGHT
Definition AgoraBase.h:3358
@ CAPTURE_BRIGHTNESS_LEVEL_NORMAL
Definition AgoraBase.h:3354
@ CAPTURE_BRIGHTNESS_LEVEL_INVALID
Definition AgoraBase.h:3350
@ CAPTURE_BRIGHTNESS_LEVEL_DARK
Definition AgoraBase.h:3362
UPLOAD_ERROR_REASON
Definition AgoraBase.h:7374
@ UPLOAD_SERVER_ERROR
Definition AgoraBase.h:7377
@ UPLOAD_NET_ERROR
Definition AgoraBase.h:7376
@ UPLOAD_SUCCESS
Definition AgoraBase.h:7375
VIDEO_TRANSCODER_ERROR
The error code of the local video mixing failure.
Definition AgoraBase.h:4831
@ VT_ERR_UNSUPPORT_IMAGE_FORMAT
Definition AgoraBase.h:4848
@ VT_ERR_INVALID_VIDEO_SOURCE_TYPE
Definition AgoraBase.h:4840
@ VT_ERR_INVALID_IMAGE_PATH
Definition AgoraBase.h:4844
@ VT_ERR_VIDEO_SOURCE_NOT_READY
Definition AgoraBase.h:4836
@ VT_ERR_INTERNAL
Definition AgoraBase.h:4856
@ VT_ERR_INVALID_LAYOUT
Definition AgoraBase.h:4852
COMPRESSION_PREFERENCE
Compression preference for video encoding.
Definition AgoraBase.h:1830
@ PREFER_COMPRESSION_AUTO
Definition AgoraBase.h:1835
@ PREFER_QUALITY
Definition AgoraBase.h:1845
@ PREFER_LOW_LATENCY
Definition AgoraBase.h:1840
VIDEO_CODEC_TYPE_FOR_STREAM
The codec type of the output video.
Definition AgoraBase.h:4113
@ VIDEO_CODEC_H265_FOR_STREAM
Definition AgoraBase.h:4121
@ VIDEO_CODEC_H264_FOR_STREAM
Definition AgoraBase.h:4117
DEGRADATION_PREFERENCE
Video degradation preferences when the bandwidth is a constraint.
Definition AgoraBase.h:1123
@ MAINTAIN_FRAMERATE
Definition AgoraBase.h:1141
@ MAINTAIN_AUTO
Definition AgoraBase.h:1129
@ DISABLED
Definition AgoraBase.h:1160
@ MAINTAIN_BALANCED
Definition AgoraBase.h:1150
@ MAINTAIN_QUALITY
Definition AgoraBase.h:1135
@ MAINTAIN_RESOLUTION
Definition AgoraBase.h:1156
AUDIO_CODEC_PROFILE_TYPE
Self-defined audio codec profile.
Definition AgoraBase.h:4147
@ AUDIO_CODEC_PROFILE_HE_AAC_V2
Definition AgoraBase.h:4159
@ AUDIO_CODEC_PROFILE_HE_AAC
Definition AgoraBase.h:4155
@ AUDIO_CODEC_PROFILE_LC_AAC
Definition AgoraBase.h:4151
REMOTE_VIDEO_STATE_REASON
The reason for the remote video state change.
Definition AgoraBase.h:3808
@ REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION
Definition AgoraBase.h:3816
@ REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED
Definition AgoraBase.h:3836
@ REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND
Definition AgoraBase.h:3860
@ REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED
Definition AgoraBase.h:3832
@ REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED
Definition AgoraBase.h:3828
@ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK
Definition AgoraBase.h:3845
@ REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT
Definition AgoraBase.h:3865
@ REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY
Definition AgoraBase.h:3820
@ REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE
Definition AgoraBase.h:3840
@ REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_LOW
Definition AgoraBase.h:3853
@ REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY
Definition AgoraBase.h:3850
@ REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED
Definition AgoraBase.h:3824
@ REMOTE_VIDEO_STATE_REASON_INTERNAL
Definition AgoraBase.h:3812
@ REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_HIGH
Definition AgoraBase.h:3856
AREA_CODE_EX
Definition AgoraBase.h:6917
@ AREA_CODE_OVS
Definition AgoraBase.h:6949
@ AREA_CODE_OC
Definition AgoraBase.h:6921
@ AREA_CODE_RU
Definition AgoraBase.h:6945
@ AREA_CODE_HKMC
Definition AgoraBase.h:6937
@ AREA_CODE_KR
Definition AgoraBase.h:6933
@ AREA_CODE_SA
Definition AgoraBase.h:6925
@ AREA_CODE_AF
Definition AgoraBase.h:6929
@ AREA_CODE_US
Definition AgoraBase.h:6941
INTERFACE_ID_TYPE
The interface class.
Definition AgoraBase.h:905
@ AGORA_IID_META_SERVICE
Definition AgoraBase.h:932
@ AGORA_IID_STATE_SYNC
Definition AgoraBase.h:931
@ AGORA_IID_SIGNALING_ENGINE
Definition AgoraBase.h:928
@ AGORA_IID_MUSIC_CONTENT_CENTER
Definition AgoraBase.h:933
@ AGORA_IID_AUDIO_ENGINE
Definition AgoraBase.h:922
@ AGORA_IID_MEDIA_ENGINE_REGULATOR
Definition AgoraBase.h:929
@ AGORA_IID_PARAMETER_ENGINE
Definition AgoraBase.h:917
@ AGORA_IID_MEDIA_ENGINE
Definition AgoraBase.h:921
@ AGORA_IID_LOCAL_SPATIAL_AUDIO
Definition AgoraBase.h:930
@ AGORA_IID_VIDEO_ENGINE
Definition AgoraBase.h:923
@ AGORA_IID_RTC_CONNECTION
Definition AgoraBase.h:924
@ AGORA_IID_H265_TRANSCODER
Definition AgoraBase.h:934
@ AGORA_IID_AUDIO_DEVICE_MANAGER
Definition AgoraBase.h:909
@ AGORA_IID_VIDEO_DEVICE_MANAGER
Definition AgoraBase.h:913
CHANNEL_MEDIA_RELAY_ERROR
The error code of the channel media relay.
Definition AgoraBase.h:6955
@ RELAY_ERROR_INTERNAL_ERROR
Definition AgoraBase.h:7001
@ RELAY_ERROR_SERVER_NO_RESPONSE
Definition AgoraBase.h:6972
@ RELAY_ERROR_SERVER_CONNECTION_LOST
Definition AgoraBase.h:6997
@ RELAY_ERROR_FAILED_JOIN_DEST
Definition AgoraBase.h:6984
@ RELAY_ERROR_DEST_TOKEN_EXPIRED
Definition AgoraBase.h:7009
@ RELAY_OK
Definition AgoraBase.h:6959
@ RELAY_ERROR_FAILED_JOIN_SRC
Definition AgoraBase.h:6980
@ RELAY_ERROR_NO_RESOURCE_AVAILABLE
Definition AgoraBase.h:6976
@ RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC
Definition AgoraBase.h:6988
@ RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST
Definition AgoraBase.h:6992
@ RELAY_ERROR_SERVER_ERROR_RESPONSE
Definition AgoraBase.h:6963
@ RELAY_ERROR_SRC_TOKEN_EXPIRED
Definition AgoraBase.h:7005
ENCODING_PREFERENCE
Video encoder preference.
Definition AgoraBase.h:1851
@ PREFER_HARDWARE
Definition AgoraBase.h:1867
@ PREFER_AUTO
Definition AgoraBase.h:1856
@ PREFER_SOFTWARE
Definition AgoraBase.h:1860
AUDIO_ENCODED_FRAME_OBSERVER_POSITION
Audio profile.
Definition AgoraBase.h:6702
@ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD
Definition AgoraBase.h:6706
@ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK
Definition AgoraBase.h:6710
@ AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED
Definition AgoraBase.h:6714
QUALITY_TYPE
Network quality types.
Definition AgoraBase.h:940
@ QUALITY_BAD
Definition AgoraBase.h:961
@ QUALITY_POOR
Definition AgoraBase.h:957
@ QUALITY_GOOD
Definition AgoraBase.h:953
@ QUALITY_UNSUPPORTED
Definition AgoraBase.h:973
@ QUALITY_DETECTING
Definition AgoraBase.h:977
@ QUALITY_VBAD
Definition AgoraBase.h:965
@ QUALITY_EXCELLENT
Definition AgoraBase.h:949
@ QUALITY_DOWN
Definition AgoraBase.h:969
VIDEO_FRAME_TYPE
The video frame type.
Definition AgoraBase.h:1066
@ VIDEO_FRAME_TYPE_B_FRAME
Definition AgoraBase.h:1082
@ VIDEO_FRAME_TYPE_DROPPABLE_FRAME
Definition AgoraBase.h:1086
@ VIDEO_FRAME_TYPE_UNKNOW
Definition AgoraBase.h:1090
@ VIDEO_FRAME_TYPE_KEY_FRAME
Definition AgoraBase.h:1074
@ VIDEO_FRAME_TYPE_BLANK_FRAME
Definition AgoraBase.h:1070
@ VIDEO_FRAME_TYPE_DELTA_FRAME
Definition AgoraBase.h:1078
VIDEO_ORIENTATION
The clockwise rotation of the video.
Definition AgoraBase.h:1001
@ VIDEO_ORIENTATION_270
Definition AgoraBase.h:1017
@ VIDEO_ORIENTATION_0
Definition AgoraBase.h:1005
@ VIDEO_ORIENTATION_90
Definition AgoraBase.h:1009
@ VIDEO_ORIENTATION_180
Definition AgoraBase.h:1013
VOICE_CONVERSION_PRESET
The options for SDK preset voice conversion effects.
Definition AgoraBase.h:6314
@ VOICE_CHANGER_SOLID
Definition AgoraBase.h:6333
@ VOICE_CHANGER_SWEET
Definition AgoraBase.h:6328
@ VOICE_CHANGER_SHIN_CHAN
Definition AgoraBase.h:6365
@ VOICE_CONVERSION_OFF
Definition AgoraBase.h:6318
@ VOICE_CHANGER_CARTOON
Definition AgoraBase.h:6341
@ VOICE_CHANGER_PHONE_OPERATOR
Definition AgoraBase.h:6347
@ VOICE_CHANGER_GIRLISH_MAN
Definition AgoraBase.h:6368
@ VOICE_CHANGER_GROOT
Definition AgoraBase.h:6356
@ VOICE_CHANGER_BASS
Definition AgoraBase.h:6338
@ VOICE_CHANGER_MONSTER
Definition AgoraBase.h:6350
@ VOICE_CHANGER_TRANSFORMERS
Definition AgoraBase.h:6353
@ VOICE_CHANGER_NEUTRAL
Definition AgoraBase.h:6323
@ VOICE_CHANGER_CHIPMUNK
Definition AgoraBase.h:6371
@ VOICE_CHANGER_IRON_LADY
Definition AgoraBase.h:6362
@ VOICE_CHANGER_CHILDLIKE
Definition AgoraBase.h:6344
@ VOICE_CHANGER_DARTH_VADER
Definition AgoraBase.h:6359
ORIENTATION_MODE
Video output orientation mode.
Definition AgoraBase.h:1096
@ ORIENTATION_MODE_FIXED_PORTRAIT
Definition AgoraBase.h:1117
@ ORIENTATION_MODE_ADAPTIVE
Definition AgoraBase.h:1104
@ ORIENTATION_MODE_FIXED_LANDSCAPE
Definition AgoraBase.h:1111
CHANNEL_MEDIA_RELAY_STATE
The state code of the channel media relay.
Definition AgoraBase.h:7015
@ RELAY_STATE_FAILURE
Definition AgoraBase.h:7032
@ RELAY_STATE_IDLE
Definition AgoraBase.h:7020
@ RELAY_STATE_RUNNING
Definition AgoraBase.h:7028
@ RELAY_STATE_CONNECTING
Definition AgoraBase.h:7024
Definition AgoraBase.h:97
CopyableAutoPtr< IString > AString
Definition AgoraBase.h:182
Definition AgoraAtomicOps.h:21
AUDIO_SESSION_OPERATION_RESTRICTION
The operation permissions of the SDK on the audio session.
Definition AgoraBase.h:824
@ AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION
Definition AgoraBase.h:836
@ AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY
Definition AgoraBase.h:832
@ AUDIO_SESSION_OPERATION_RESTRICTION_ALL
Definition AgoraBase.h:846
@ AUDIO_SESSION_OPERATION_RESTRICTION_NONE
Definition AgoraBase.h:828
@ AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION
Definition AgoraBase.h:841
void * view_t
Definition AgoraBase.h:850
WARN_CODE_TYPE
Definition AgoraBase.h:298
@ WARN_ADM_POP_STATE
Definition AgoraBase.h:429
@ WARN_CHANNEL_CONNECTION_PORT_CHANGED
Definition AgoraBase.h:370
@ WARN_INIT_VIDEO
Definition AgoraBase.h:308
@ WARN_CHANNEL_CONNECTION_IP_CHANGED
Definition AgoraBase.h:366
@ WARN_OPEN_CHANNEL_INVALID_TICKET
Definition AgoraBase.h:354
@ WARN_APM_HOWLING
Definition AgoraBase.h:417
@ WARN_PENDING
Definition AgoraBase.h:313
@ WARN_CHANNEL_SOCKET_ERROR
Definition AgoraBase.h:373
@ WARN_OPEN_CHANNEL_TIMEOUT
Definition AgoraBase.h:335
@ WARN_SET_CLIENT_ROLE_TIMEOUT
Definition AgoraBase.h:350
@ WARN_CHANNEL_CONNECTION_UNRECOVERABLE
Definition AgoraBase.h:362
@ WARN_AUDIO_MIXING_OPEN_ERROR
Definition AgoraBase.h:377
@ WARN_ADM_RUNTIME_PLAYOUT_WARNING
Definition AgoraBase.h:381
@ WARN_ADM_RUNTIME_RECORDING_WARNING
Definition AgoraBase.h:385
@ WARN_ADM_RECORD_AUDIO_SILENCE
Definition AgoraBase.h:389
@ WARN_OPEN_CHANNEL_TRY_NEXT_VOS
Definition AgoraBase.h:358
@ WARN_LOOKUP_CHANNEL_TIMEOUT
Definition AgoraBase.h:324
@ WARN_OPEN_CHANNEL_REJECTED
Definition AgoraBase.h:340
@ WARN_NO_AVAILABLE_CHANNEL
Definition AgoraBase.h:318
@ WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE
Definition AgoraBase.h:446
@ WARN_ADM_PLAYOUT_MALFUNCTION
Definition AgoraBase.h:393
@ WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE
Definition AgoraBase.h:438
@ WARN_ADM_GLITCH_STATE
Definition AgoraBase.h:421
@ WARN_ADM_IMPROPER_SETTINGS
Definition AgoraBase.h:425
@ WARN_SWITCH_LIVE_VIDEO_TIMEOUT
Definition AgoraBase.h:346
@ WARN_LOOKUP_CHANNEL_REJECTED
Definition AgoraBase.h:329
@ WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL
Definition AgoraBase.h:405
@ WARN_INVALID_VIEW
Definition AgoraBase.h:303
@ WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE
Definition AgoraBase.h:433
@ WARN_ADM_RECORD_MALFUNCTION
Definition AgoraBase.h:397
@ WARN_ADM_RECORD_AUDIO_LOWLEVEL
Definition AgoraBase.h:401
@ WARN_ADM_WINDOWS_NO_DATA_READY_EVENT
Definition AgoraBase.h:413
util::AList< UserInfo > UserList
Definition AgoraBase.h:876
const char * user_id_t
Definition AgoraBase.h:849
ERROR_CODE_TYPE
Error codes.
Definition AgoraBase.h:458
@ ERR_ADM_START_PLAYOUT
Definition AgoraBase.h:769
@ ERR_CERT_SIGN
Definition AgoraBase.h:695
@ ERR_BIND_SOCKET
Definition AgoraBase.h:537
@ ERR_CERT_NULL
Definition AgoraBase.h:698
@ ERR_NOT_READY
Definition AgoraBase.h:482
@ ERR_BUFFER_TOO_SMALL
Definition AgoraBase.h:501
@ ERR_TOO_OFTEN
Definition AgoraBase.h:531
@ ERR_INVALID_APP_ID
Definition AgoraBase.h:590
@ ERR_TIMEDOUT
Definition AgoraBase.h:520
@ ERR_CERT_CREDENTIAL
Definition AgoraBase.h:694
@ ERR_NO_PERMISSION
Definition AgoraBase.h:515
@ ERR_INVALID_USER_ACCOUNT
Definition AgoraBase.h:678
@ ERR_INVALID_USER_ID
Definition AgoraBase.h:655
@ ERR_CERT_JSON_PART
Definition AgoraBase.h:690
@ ERR_LICENSE_CREDENTIAL_INVALID
Definition AgoraBase.h:673
@ ERR_MODULE_NOT_FOUND
Definition AgoraBase.h:686
@ ERR_LOAD_MEDIA_ENGINE
Definition AgoraBase.h:755
@ ERR_OK
Definition AgoraBase.h:462
@ ERR_BITRATE_LIMIT
Definition AgoraBase.h:633
@ ERR_INVALID_TOKEN
Definition AgoraBase.h:611
@ ERR_NO_SERVER_RESOURCES
Definition AgoraBase.h:600
@ ERR_TOKEN_EXPIRED
Definition AgoraBase.h:604
@ ERR_DATASTREAM_DECRYPTION_FAILED
Definition AgoraBase.h:660
@ ERR_INIT_NET_ENGINE
Definition AgoraBase.h:576
@ ERR_ADM_STOP_PLAYOUT
Definition AgoraBase.h:773
@ ERR_INVALID_ARGUMENT
Definition AgoraBase.h:472
@ ERR_JOIN_CHANNEL_REJECTED
Definition AgoraBase.h:552
@ ERR_ADM_INIT_PLAYOUT
Definition AgoraBase.h:765
@ ERR_ADM_GENERAL_ERROR
Definition AgoraBase.h:760
@ ERR_ADM_START_RECORDING
Definition AgoraBase.h:782
@ ERR_STREAM_MESSAGE_TIMEOUT
Definition AgoraBase.h:642
@ ERR_TOO_MANY_DATA_STREAMS
Definition AgoraBase.h:638
@ ERR_FAILED
Definition AgoraBase.h:467
@ ERR_CERT_CUSTOM
Definition AgoraBase.h:693
@ ERR_INVALID_CHANNEL_NAME
Definition AgoraBase.h:595
@ ERR_SIZE_TOO_LARGE
Definition AgoraBase.h:629
@ ERR_ABORTED
Definition AgoraBase.h:571
@ ERR_CERT_DUEDATE
Definition AgoraBase.h:699
@ ERR_NET_DOWN
Definition AgoraBase.h:542
@ ERR_ADM_STOP_RECORDING
Definition AgoraBase.h:786
@ ERR_ADM_INIT_RECORDING
Definition AgoraBase.h:778
@ ERR_CANCELED
Definition AgoraBase.h:525
@ ERR_CLIENT_IS_BANNED_BY_SERVER
Definition AgoraBase.h:664
@ ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED
Definition AgoraBase.h:646
@ ERR_RESOURCE_LIMITED
Definition AgoraBase.h:581
@ ERR_PCMSEND_BUFFEROVERFLOW
Definition AgoraBase.h:710
@ ERR_CERT_FAIL
Definition AgoraBase.h:696
@ ERR_DECRYPTION_FAILED
Definition AgoraBase.h:651
@ ERR_CERT_JSON_INVAL
Definition AgoraBase.h:691
@ ERR_CONNECTION_LOST
Definition AgoraBase.h:621
@ ERR_CERT_BUF
Definition AgoraBase.h:697
@ ERR_CERT_JSON_NOMEM
Definition AgoraBase.h:692
@ ERR_VDM_CAMERA_NOT_AUTHORIZED
Definition AgoraBase.h:791
@ ERR_ALREADY_IN_USE
Definition AgoraBase.h:566
@ ERR_NOT_INITIALIZED
Definition AgoraBase.h:506
@ ERR_CERT_RAW
Definition AgoraBase.h:689
@ ERR_LEAVE_CHANNEL_REJECTED
Definition AgoraBase.h:562
@ ERR_CERT_REQUEST
Definition AgoraBase.h:700
@ ERR_REFUSED
Definition AgoraBase.h:497
@ ERR_FUNC_IS_PROHIBITED
Definition AgoraBase.h:586
@ ERR_NOT_SUPPORTED
Definition AgoraBase.h:488
@ ERR_CONNECTION_INTERRUPTED
Definition AgoraBase.h:616
@ ERR_PCMSEND_FORMAT
Definition AgoraBase.h:706
@ ERR_NOT_IN_CHANNEL
Definition AgoraBase.h:625
@ ERR_INVALID_STATE
Definition AgoraBase.h:510
@ ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH
Definition AgoraBase.h:668
CHANNEL_PROFILE_TYPE
The channel profile.
Definition AgoraBase.h:267
@ __deprecated
Definition AgoraBase.h:280
@ CHANNEL_PROFILE_COMMUNICATION
Definition AgoraBase.h:271
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition AgoraBase.h:275
LICENSE_ERROR_TYPE
Definition AgoraBase.h:794
@ LICENSE_ERR_MINUTES_EXCEED
Definition AgoraBase.h:806
@ LICENSE_ERR_EXPIRE
Definition AgoraBase.h:802
@ LICENSE_ERR_LIMITED_PERIOD
Definition AgoraBase.h:810
@ LICENSE_ERR_INVALID
Definition AgoraBase.h:798
@ LICENSE_ERR_INTERNAL
Definition AgoraBase.h:818
@ LICENSE_ERR_DIFF_DEVICES
Definition AgoraBase.h:814
Definition video_node_i.h:28
The spatial audio parameters.
Definition AgoraBase.h:8055
Optional< int > speaker_orientation
Definition AgoraBase.h:8085
Optional< double > speaker_azimuth
Definition AgoraBase.h:8065
Optional< double > speaker_elevation
Definition AgoraBase.h:8073
Optional< bool > enable_air_absorb
Definition AgoraBase.h:8100
Optional< bool > enable_blur
Definition AgoraBase.h:8091
Optional< double > speaker_distance
Definition AgoraBase.h:8078
Optional< double > speaker_attenuation
Definition AgoraBase.h:8114
Optional< bool > enable_doppler
Definition AgoraBase.h:8131
UserInfo()
Definition AgoraBase.h:873
bool hasAudio
Definition AgoraBase.h:865
bool hasVideo
Definition AgoraBase.h:871
util::AString userId
Definition AgoraBase.h:859
uint32_t x
Definition AgoraBase.h:8154
uint32_t width
Definition AgoraBase.h:8164
uint32_t videoState
Definition AgoraBase.h:8176
uint32_t height
Definition AgoraBase.h:8168
uint32_t y
Definition AgoraBase.h:8160
VideoLayout()
Definition AgoraBase.h:8178
user_id_t strUid
Definition AgoraBase.h:8148
const char * channelId
Definition AgoraBase.h:8140
rtc::uid_t uid
Definition AgoraBase.h:8144
Advanced options for video encoding.
Definition AgoraBase.h:1873
AdvanceOptions()
Definition AgoraBase.h:1891
ENCODING_PREFERENCE encodingPreference
Definition AgoraBase.h:1877
AdvanceOptions(ENCODING_PREFERENCE encoding_preference, COMPRESSION_PREFERENCE compression_preference, bool encode_alpha)
Definition AgoraBase.h:1895
bool operator==(const AdvanceOptions &rhs) const
Definition AgoraBase.h:1902
COMPRESSION_PREFERENCE compressionPreference
Definition AgoraBase.h:1882
bool encodeAlpha
Definition AgoraBase.h:1889
Advanced options for the Local Access Point.
Definition AgoraBase.h:7860
LogUploadServerInfo logUploadServer
Definition AgoraBase.h:7865
AUDIO_ENCODED_FRAME_OBSERVER_POSITION postionType
Definition AgoraBase.h:6812
AUDIO_ENCODING_TYPE encodingType
Definition AgoraBase.h:6816
AudioEncodedFrameObserverConfig()
Definition AgoraBase.h:6818
int16_t channelNum
Definition AgoraBase.h:1627
AudioPcmDataInfo()
Definition AgoraBase.h:1612
size_t samplesPerChannel
Definition AgoraBase.h:1625
int64_t elapsedTimeMs
Definition AgoraBase.h:1637
size_t samplesOut
Definition AgoraBase.h:1633
AudioPcmDataInfo(const AudioPcmDataInfo &rhs)
Definition AgoraBase.h:1615
int64_t ntpTimeMs
Definition AgoraBase.h:1641
AudioRecordingConfiguration(const char *file_path, bool enc, int sample_rate, AUDIO_FILE_RECORDING_TYPE type, AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
Definition AgoraBase.h:6786
const char * filePath
Definition AgoraBase.h:6726
int recordingChannel
Definition AgoraBase.h:6767
AudioRecordingConfiguration(const AudioRecordingConfiguration &rhs)
Definition AgoraBase.h:6796
AudioRecordingConfiguration()
Definition AgoraBase.h:6769
AUDIO_FILE_RECORDING_TYPE fileRecordingType
Definition AgoraBase.h:6747
AudioRecordingConfiguration(const char *file_path, int sample_rate, AUDIO_RECORDING_QUALITY_TYPE quality_type, int channel)
Definition AgoraBase.h:6777
bool encode
Definition AgoraBase.h:6732
int sampleRate
Definition AgoraBase.h:6743
AUDIO_RECORDING_QUALITY_TYPE quality
Definition AgoraBase.h:6752
bool enableLocalPlayback
Definition AgoraBase.h:6077
bool enableAudioProcessing
Definition AgoraBase.h:6085
AudioTrackConfig()
Definition AgoraBase.h:6087
unsigned int vad
Definition AgoraBase.h:4000
uid_t uid
Definition AgoraBase.h:3980
unsigned int volume
Definition AgoraBase.h:3989
double voicePitch
Definition AgoraBase.h:4006
AudioVolumeInfo()
Definition AgoraBase.h:4008
float rednessLevel
Definition AgoraBase.h:5436
LIGHTENING_CONTRAST_LEVEL lighteningContrastLevel
Definition AgoraBase.h:5418
BeautyOptions()
Definition AgoraBase.h:5452
float smoothnessLevel
Definition AgoraBase.h:5430
float sharpnessLevel
Definition AgoraBase.h:5442
LIGHTENING_CONTRAST_LEVEL
The contrast level.
Definition AgoraBase.h:5399
@ LIGHTENING_CONTRAST_NORMAL
Definition AgoraBase.h:5407
@ LIGHTENING_CONTRAST_LOW
Definition AgoraBase.h:5403
@ LIGHTENING_CONTRAST_HIGH
Definition AgoraBase.h:5411
BeautyOptions(LIGHTENING_CONTRAST_LEVEL contrastLevel, float lightening, float smoothness, float redness, float sharpness)
Definition AgoraBase.h:5444
float lighteningLevel
Definition AgoraBase.h:5424
Channel media information.
Definition AgoraBase.h:7038
ChannelMediaInfo()
Definition AgoraBase.h:7052
uid_t uid
Definition AgoraBase.h:7042
ChannelMediaInfo(const char *c, const char *t, uid_t u)
Definition AgoraBase.h:7053
const char * token
Definition AgoraBase.h:7050
const char * channelName
Definition AgoraBase.h:7046
ChannelMediaRelayConfiguration()
Definition AgoraBase.h:7098
int destCount
Definition AgoraBase.h:7096
ChannelMediaInfo * destInfos
Definition AgoraBase.h:7090
ChannelMediaInfo * srcInfo
Definition AgoraBase.h:7073
ClientRoleOptions()
Definition AgoraBase.h:3005
AUDIENCE_LATENCY_LEVEL_TYPE audienceLatencyLevel
Definition AgoraBase.h:3003
int codecCapMask
Definition AgoraBase.h:2027
CodecCapInfo()
Definition AgoraBase.h:2033
CodecCapLevels codecLevels
Definition AgoraBase.h:2031
VIDEO_CODEC_TYPE codecType
Definition AgoraBase.h:2023
The level of the codec capability.
Definition AgoraBase.h:1999
CodecCapLevels()
Definition AgoraBase.h:2011
VIDEO_CODEC_CAPABILITY_LEVEL swDecodingLevel
Definition AgoraBase.h:2009
VIDEO_CODEC_CAPABILITY_LEVEL hwDecodingLevel
Definition AgoraBase.h:2004
float strengthLevel
Definition AgoraBase.h:5867
ColorEnhanceOptions()
Definition AgoraBase.h:5885
ColorEnhanceOptions(float stength, float skinProtect)
Definition AgoraBase.h:5882
float skinProtectLevel
Definition AgoraBase.h:5880
The configurations for the data stream.
Definition AgoraBase.h:2185
bool syncWithAudio
Definition AgoraBase.h:2196
bool ordered
Definition AgoraBase.h:2204
bool isLowLatencyAudioSupported
Definition AgoraBase.h:4023
DeviceInfo()
Definition AgoraBase.h:4025
EchoTestConfiguration()
Definition AgoraBase.h:7557
view_t view
Definition AgoraBase.h:7516
const char * channelId
Definition AgoraBase.h:7544
bool enableVideo
Definition AgoraBase.h:7530
bool enableAudio
Definition AgoraBase.h:7523
EchoTestConfiguration(view_t v, bool ea, bool ev, const char *t, const char *c, const int is)
Definition AgoraBase.h:7554
int intervalInSeconds
Definition AgoraBase.h:7552
const char * token
Definition AgoraBase.h:7538
bool sendEvenIfEmpty
Definition AgoraBase.h:1561
bool speech
Definition AgoraBase.h:1555
EncodedAudioFrameAdvancedSettings()
Definition AgoraBase.h:1548
Audio information after encoding.
Definition AgoraBase.h:1567
int sampleRateHz
Definition AgoraBase.h:1589
EncodedAudioFrameInfo(const EncodedAudioFrameInfo &rhs)
Definition AgoraBase.h:1575
EncodedAudioFrameAdvancedSettings advancedSettings
Definition AgoraBase.h:1601
EncodedAudioFrameInfo()
Definition AgoraBase.h:1568
int samplesPerChannel
Definition AgoraBase.h:1593
AUDIO_CODEC_TYPE codec
Definition AgoraBase.h:1585
int numberOfChannels
Definition AgoraBase.h:1597
int64_t captureTimeMs
Definition AgoraBase.h:1606
int64_t presentationMs
Definition AgoraBase.h:1824
VIDEO_STREAM_TYPE streamType
Definition AgoraBase.h:1821
int height
Definition AgoraBase.h:1790
int64_t captureTimeMs
Definition AgoraBase.h:1813
VIDEO_CODEC_TYPE codecType
Definition AgoraBase.h:1782
int trackId
Definition AgoraBase.h:1808
int framesPerSecond
Definition AgoraBase.h:1796
EncodedVideoFrameInfo & operator=(const EncodedVideoFrameInfo &rhs)
Definition AgoraBase.h:1762
int64_t decodeTimeMs
Definition AgoraBase.h:1817
EncodedVideoFrameInfo(const EncodedVideoFrameInfo &rhs)
Definition AgoraBase.h:1749
VIDEO_FRAME_TYPE frameType
Definition AgoraBase.h:1800
int width
Definition AgoraBase.h:1786
EncodedVideoFrameInfo()
Definition AgoraBase.h:1736
VIDEO_ORIENTATION rotation
Definition AgoraBase.h:1804
bool datastreamEncryptionEnabled
Definition AgoraBase.h:7310
const char * encryptionKey
Definition AgoraBase.h:7296
EncryptionConfig()
Definition AgoraBase.h:7312
uint8_t encryptionKdfSalt[32]
Definition AgoraBase.h:7303
ENCRYPTION_MODE encryptionMode
Definition AgoraBase.h:7290
FACE_SHAPE_AREA shapeArea
Definition AgoraBase.h:5656
FaceShapeAreaOptions(FACE_SHAPE_AREA shapeArea, int areaIntensity)
Definition AgoraBase.h:5664
FACE_SHAPE_AREA
Chooses the specific facial areas that need to be adjusted.
Definition AgoraBase.h:5471
@ FACE_SHAPE_AREA_MANDIBLE
Definition AgoraBase.h:5518
@ FACE_SHAPE_AREA_CHIN
Definition AgoraBase.h:5524
@ FACE_SHAPE_AREA_FACECONTOUR
Definition AgoraBase.h:5490
@ FACE_SHAPE_AREA_MOUTHPOSITION
Definition AgoraBase.h:5624
@ FACE_SHAPE_AREA_NOSEROOT
Definition AgoraBase.h:5592
@ FACE_SHAPE_AREA_EYEDISTANCE
Definition AgoraBase.h:5536
@ FACE_SHAPE_AREA_EYEPOSITION
Definition AgoraBase.h:5543
@ FACE_SHAPE_AREA_MOUTHLIP
Definition AgoraBase.h:5637
@ FACE_SHAPE_AREA_EYESCALE
Definition AgoraBase.h:5529
@ FACE_SHAPE_AREA_EYEINNERCORNER
Definition AgoraBase.h:5562
@ FACE_SHAPE_AREA_NOSELENGTH
Definition AgoraBase.h:5574
@ FACE_SHAPE_AREA_FOREHEAD
Definition AgoraBase.h:5485
@ FACE_SHAPE_AREA_MOUTHSMILE
Definition AgoraBase.h:5630
@ FACE_SHAPE_AREA_NOSEWING
Definition AgoraBase.h:5586
@ FACE_SHAPE_AREA_NOSEWIDTH
Definition AgoraBase.h:5580
@ FACE_SHAPE_AREA_EYEPUPILS
Definition AgoraBase.h:5555
@ FACE_SHAPE_AREA_CHEEK
Definition AgoraBase.h:5512
@ FACE_SHAPE_AREA_LOWEREYELID
Definition AgoraBase.h:5549
@ FACE_SHAPE_AREA_EYEBROWPOSITION
Definition AgoraBase.h:5644
@ FACE_SHAPE_AREA_NOSEGENERAL
Definition AgoraBase.h:5611
@ FACE_SHAPE_AREA_EYEBROWTHICKNESS
Definition AgoraBase.h:5650
@ FACE_SHAPE_AREA_MOUTHSCALE
Definition AgoraBase.h:5618
@ FACE_SHAPE_AREA_HEADSCALE
Definition AgoraBase.h:5480
@ FACE_SHAPE_AREA_CHEEKBONE
Definition AgoraBase.h:5507
@ FACE_SHAPE_AREA_NOSEBRIDGE
Definition AgoraBase.h:5598
@ FACE_SHAPE_AREA_FACELENGTH
Definition AgoraBase.h:5496
@ FACE_SHAPE_AREA_NONE
Definition AgoraBase.h:5475
@ FACE_SHAPE_AREA_FACEWIDTH
Definition AgoraBase.h:5501
@ FACE_SHAPE_AREA_NOSETIP
Definition AgoraBase.h:5604
@ FACE_SHAPE_AREA_EYEOUTERCORNER
Definition AgoraBase.h:5569
FaceShapeAreaOptions()
Definition AgoraBase.h:5666
int shapeIntensity
Definition AgoraBase.h:5662
FACE_SHAPE_BEAUTY_STYLE shapeStyle
Definition AgoraBase.h:5699
FACE_SHAPE_BEAUTY_STYLE
The facial enhancement style options.
Definition AgoraBase.h:5680
@ FACE_SHAPE_BEAUTY_STYLE_NATURAL
Definition AgoraBase.h:5693
@ FACE_SHAPE_BEAUTY_STYLE_FEMALE
Definition AgoraBase.h:5684
@ FACE_SHAPE_BEAUTY_STYLE_MALE
Definition AgoraBase.h:5688
int styleIntensity
Definition AgoraBase.h:5706
FaceShapeBeautyOptions(FACE_SHAPE_BEAUTY_STYLE shapeStyle, int styleIntensity)
Definition AgoraBase.h:5708
FaceShapeBeautyOptions()
Definition AgoraBase.h:5710
const char * path
Definition AgoraBase.h:5736
FilterEffectOptions()
Definition AgoraBase.h:5746
float strength
Definition AgoraBase.h:5742
FilterEffectOptions(const char *lut3dPath, float filterStrength)
Definition AgoraBase.h:5744
Focal length information supported by the camera, including the camera direction and focal length typ...
Definition AgoraBase.h:2043
CAMERA_FOCAL_LENGTH_TYPE focalLengthType
Definition AgoraBase.h:2051
int cameraDirection
Definition AgoraBase.h:2047
Configurations for the Packet instance.
Definition AgoraBase.h:4037
const unsigned char * buffer
Definition AgoraBase.h:4043
unsigned int size
Definition AgoraBase.h:4047
Packet()
Definition AgoraBase.h:4049
Configurations of the last-mile network test.
Definition AgoraBase.h:4947
bool probeUplink
Definition AgoraBase.h:4954
bool probeDownlink
Definition AgoraBase.h:4960
unsigned int expectedUplinkBitrate
Definition AgoraBase.h:4965
unsigned int expectedDownlinkBitrate
Definition AgoraBase.h:4970
Results of the uplink or downlink last-mile network test.
Definition AgoraBase.h:4996
LastmileProbeOneWayResult()
Definition AgoraBase.h:5010
unsigned int packetLossRate
Definition AgoraBase.h:5000
unsigned int availableBandwidth
Definition AgoraBase.h:5008
unsigned int jitter
Definition AgoraBase.h:5004
LastmileProbeOneWayResult downlinkReport
Definition AgoraBase.h:5028
unsigned int rtt
Definition AgoraBase.h:5032
LastmileProbeOneWayResult uplinkReport
Definition AgoraBase.h:5024
LastmileProbeResult()
Definition AgoraBase.h:5034
LASTMILE_PROBE_RESULT_STATE state
Definition AgoraBase.h:5020
The configuration for advanced features of the RTMP or RTMPS streaming with transcoding.
Definition AgoraBase.h:4406
const char * featureName
Definition AgoraBase.h:4419
bool opened
Definition AgoraBase.h:4426
LiveStreamAdvancedFeature(const char *feat_name, bool open)
Definition AgoraBase.h:4408
LiveStreamAdvancedFeature()
Definition AgoraBase.h:4407
bool lowLatency
Definition AgoraBase.h:4590
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition AgoraBase.h:4661
unsigned int backgroundImageCount
Definition AgoraBase.h:4656
int audioChannels
Definition AgoraBase.h:4676
int height
Definition AgoraBase.h:4568
int audioBitrate
Definition AgoraBase.h:4666
LiveStreamAdvancedFeature * advancedFeatures
Definition AgoraBase.h:4684
LiveTranscoding()
Definition AgoraBase.h:4691
unsigned int backgroundColor
Definition AgoraBase.h:4606
RtcImage * backgroundImage
Definition AgoraBase.h:4651
VIDEO_CODEC_PROFILE_TYPE videoCodecProfile
Definition AgoraBase.h:4601
AUDIO_CODEC_PROFILE_TYPE audioCodecProfile
Definition AgoraBase.h:4680
int videoFramerate
Definition AgoraBase.h:4581
const char * metadata
Definition AgoraBase.h:4632
unsigned int watermarkCount
Definition AgoraBase.h:4643
unsigned int userCount
Definition AgoraBase.h:4614
int videoBitrate
Definition AgoraBase.h:4575
RtcImage * watermark
Definition AgoraBase.h:4638
int width
Definition AgoraBase.h:4560
int videoGop
Definition AgoraBase.h:4595
VIDEO_CODEC_TYPE_FOR_STREAM videoCodecType
Definition AgoraBase.h:4610
unsigned int advancedFeatureCount
Definition AgoraBase.h:4689
TranscodingUser * transcodingUsers
Definition AgoraBase.h:4619
const char * transcodingExtraInfo
Definition AgoraBase.h:4625
bool disableAut
Definition AgoraBase.h:7913
AdvancedConfigInfo advancedConfig
Definition AgoraBase.h:7907
LocalAccessPointConfiguration()
Definition AgoraBase.h:7914
const char * verifyDomainName
Definition AgoraBase.h:7899
const char ** ipList
Definition AgoraBase.h:7876
const char ** domainList
Definition AgoraBase.h:7889
int domainListSize
Definition AgoraBase.h:7894
int ipListSize
Definition AgoraBase.h:7881
LOCAL_PROXY_MODE mode
Definition AgoraBase.h:7903
unsigned int streamCount
Definition AgoraBase.h:4926
MixedAudioStream * audioInputStreams
Definition AgoraBase.h:4930
bool syncWithLocalMic
Definition AgoraBase.h:4939
LocalAudioMixerConfiguration()
Definition AgoraBase.h:4941
Local audio statistics.
Definition AgoraBase.h:4165
unsigned short txPacketLossRate
Definition AgoraBase.h:4186
int earMonitorDelay
Definition AgoraBase.h:4198
int audioPlayoutDelay
Definition AgoraBase.h:4194
int audioDeviceDelay
Definition AgoraBase.h:4190
int sentSampleRate
Definition AgoraBase.h:4173
int numChannels
Definition AgoraBase.h:4169
int aecEstimatedDelay
Definition AgoraBase.h:4203
int sentBitrate
Definition AgoraBase.h:4177
int internalCodec
Definition AgoraBase.h:4181
unsigned int streamCount
Definition AgoraBase.h:4801
LocalTranscoderConfiguration()
Definition AgoraBase.h:4821
VideoEncoderConfiguration videoOutputConfiguration
Definition AgoraBase.h:4810
bool syncWithPrimaryCamera
Definition AgoraBase.h:4819
TranscodingVideoStream * videoInputStreams
Definition AgoraBase.h:4805
Configuration information for the log server.
Definition AgoraBase.h:7831
bool serverHttps
Definition AgoraBase.h:7849
LogUploadServerInfo(const char *domain, const char *path, int port, bool https)
Definition AgoraBase.h:7853
const char * serverDomain
Definition AgoraBase.h:7835
const char * serverPath
Definition AgoraBase.h:7839
int serverPort
Definition AgoraBase.h:7843
LogUploadServerInfo()
Definition AgoraBase.h:7851
LowlightEnhanceOptions()
Definition AgoraBase.h:5798
LowlightEnhanceOptions(LOW_LIGHT_ENHANCE_MODE lowlightMode, LOW_LIGHT_ENHANCE_LEVEL lowlightLevel)
Definition AgoraBase.h:5795
LOW_LIGHT_ENHANCE_MODE mode
Definition AgoraBase.h:5788
LOW_LIGHT_ENHANCE_LEVEL
The low-light enhancement level.
Definition AgoraBase.h:5771
@ LOW_LIGHT_ENHANCE_LEVEL_HIGH_QUALITY
Definition AgoraBase.h:5777
@ LOW_LIGHT_ENHANCE_LEVEL_FAST
Definition AgoraBase.h:5782
LOW_LIGHT_ENHANCE_LEVEL level
Definition AgoraBase.h:5793
LOW_LIGHT_ENHANCE_MODE
The low-light enhancement mode.
Definition AgoraBase.h:5756
@ LOW_LIGHT_ENHANCE_AUTO
Definition AgoraBase.h:5762
@ LOW_LIGHT_ENHANCE_MANUAL
Definition AgoraBase.h:5766
The source of the audio streams that are mixed locally.
Definition AgoraBase.h:4863
MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char *channel)
Definition AgoraBase.h:4906
track_id_t trackId
Definition AgoraBase.h:4894
const char * channelId
Definition AgoraBase.h:4887
MixedAudioStream(AUDIO_SOURCE_TYPE source, track_id_t track)
Definition AgoraBase.h:4902
AUDIO_SOURCE_TYPE sourceType
Definition AgoraBase.h:4867
MixedAudioStream(AUDIO_SOURCE_TYPE source)
Definition AgoraBase.h:4896
MixedAudioStream(AUDIO_SOURCE_TYPE source, uid_t uid, const char *channel, track_id_t track)
Definition AgoraBase.h:4911
uid_t remoteUserUid
Definition AgoraBase.h:4873
uint32_t wifiTxBytes
Definition AgoraBase.h:2706
const PathStats * pathStats
Definition AgoraBase.h:2726
uint32_t lanRxBytes
Definition AgoraBase.h:2702
uint32_t wifiRxBytes
Definition AgoraBase.h:2710
uint32_t mobileRxBytes
Definition AgoraBase.h:2718
uint32_t mobileTxBytes
Definition AgoraBase.h:2714
uint32_t lanTxBytes
Definition AgoraBase.h:2698
MultipathStats()
Definition AgoraBase.h:2727
int activePathNum
Definition AgoraBase.h:2722
Statistical information about a specific network path.
Definition AgoraBase.h:2672
MultipathType type
Definition AgoraBase.h:2676
PathStats(MultipathType t, int tx, int rx)
Definition AgoraBase.h:2686
int rxKBitRate
Definition AgoraBase.h:2684
PathStats()
Definition AgoraBase.h:2685
int txKBitRate
Definition AgoraBase.h:2680
uid_t uid
Definition AgoraBase.h:7949
RecorderStreamInfo()
Definition AgoraBase.h:7954
RecorderStreamInfo(const char *channelId, uid_t uid)
Definition AgoraBase.h:7955
RecorderStreamInfo(const char *channelId, uid_t uid, RecorderStreamType type)
Definition AgoraBase.h:7957
RecorderStreamType type
Definition AgoraBase.h:7953
const char * channelId
Definition AgoraBase.h:7945
The location of the target area relative to the screen or window. If you do not set this parameter,...
Definition AgoraBase.h:2342
int x
Definition AgoraBase.h:2346
Rectangle(int xx, int yy, int ww, int hh)
Definition AgoraBase.h:2361
int height
Definition AgoraBase.h:2358
Rectangle()
Definition AgoraBase.h:2360
int y
Definition AgoraBase.h:2350
int width
Definition AgoraBase.h:2354
Image properties.
Definition AgoraBase.h:4357
RtcImage()
Definition AgoraBase.h:4396
int height
Definition AgoraBase.h:4380
double alpha
Definition AgoraBase.h:4394
int x
Definition AgoraBase.h:4367
int width
Definition AgoraBase.h:4376
const char * url
Definition AgoraBase.h:4362
int y
Definition AgoraBase.h:4372
int zOrder
Definition AgoraBase.h:4388
unsigned short rxVideoKBitRate
Definition AgoraBase.h:2789
int firstVideoPacketDurationAfterUnmute
Definition AgoraBase.h:2877
int firstVideoKeyFrameDecodedDurationAfterUnmute
Definition AgoraBase.h:2887
unsigned short rxAudioKBitRate
Definition AgoraBase.h:2781
int memoryAppUsageInKbytes
Definition AgoraBase.h:2842
unsigned int rxBytes
Definition AgoraBase.h:2753
unsigned short txAudioKBitRate
Definition AgoraBase.h:2785
unsigned short lastmileDelay
Definition AgoraBase.h:2797
unsigned int userCount
Definition AgoraBase.h:2801
unsigned int txVideoBytes
Definition AgoraBase.h:2761
unsigned short rxKBitRate
Definition AgoraBase.h:2777
int gatewayRtt
Definition AgoraBase.h:2827
unsigned int duration
Definition AgoraBase.h:2745
int firstVideoPacketDuration
Definition AgoraBase.h:2857
int lanAccelerateState
Definition AgoraBase.h:2908
unsigned int rxAudioBytes
Definition AgoraBase.h:2765
unsigned short txKBitRate
Definition AgoraBase.h:2773
int packetsBeforeFirstKeyFramePacket
Definition AgoraBase.h:2867
int rxPacketLossRate
Definition AgoraBase.h:2902
int firstAudioPacketDuration
Definition AgoraBase.h:2852
int firstAudioPacketDurationAfterUnmute
Definition AgoraBase.h:2872
int firstVideoKeyFramePacketDurationAfterUnmute
Definition AgoraBase.h:2882
int txPacketLossRate
Definition AgoraBase.h:2897
RtcStats()
Definition AgoraBase.h:2910
double cpuTotalUsage
Definition AgoraBase.h:2817
int firstVideoKeyFrameRenderedDurationAfterUnmute
Definition AgoraBase.h:2892
double memoryAppUsageRatio
Definition AgoraBase.h:2832
int connectTimeMs
Definition AgoraBase.h:2847
double memoryTotalUsageRatio
Definition AgoraBase.h:2837
unsigned short txVideoKBitRate
Definition AgoraBase.h:2793
unsigned int txAudioBytes
Definition AgoraBase.h:2757
unsigned int txBytes
Definition AgoraBase.h:2749
unsigned int rxVideoBytes
Definition AgoraBase.h:2769
int firstVideoKeyFramePacketDuration
Definition AgoraBase.h:2862
double cpuAppUsage
Definition AgoraBase.h:2808
The audio configuration for the shared screen stream.
Definition AgoraBase.h:6446
int channels
Definition AgoraBase.h:6454
int sampleRate
Definition AgoraBase.h:6450
bool excludeCurrentProcessAudio
Definition AgoraBase.h:6464
int captureSignalVolume
Definition AgoraBase.h:6458
ScreenAudioParameters()
Definition AgoraBase.h:6465
Screen sharing configurations.
Definition AgoraBase.h:7666
bool captureAudio
Definition AgoraBase.h:7678
bool captureVideo
Definition AgoraBase.h:7691
ScreenVideoParameters videoParams
Definition AgoraBase.h:7696
ScreenAudioParameters audioParams
Definition AgoraBase.h:7683
ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs, view_t *ex, int cnt)
Definition AgoraBase.h:6640
bool captureAudio
Definition AgoraBase.h:6485
int excludeWindowCount
Definition AgoraBase.h:6558
unsigned int highLightColor
Definition AgoraBase.h:6571
int frameRate
Definition AgoraBase.h:6522
ScreenCaptureParameters(int width, int height, int f, int b, bool cur, bool fcs)
Definition AgoraBase.h:6616
ScreenCaptureParameters(const VideoDimensions &d, int f, int b)
Definition AgoraBase.h:6593
int bitrate
Definition AgoraBase.h:6528
ScreenAudioParameters audioParams
Definition AgoraBase.h:6491
ScreenCaptureParameters(int width, int height, int f, int b)
Definition AgoraBase.h:6604
ScreenCaptureParameters()
Definition AgoraBase.h:6581
int highLightWidth
Definition AgoraBase.h:6565
view_t * excludeWindowList
Definition AgoraBase.h:6552
VideoDimensions dimensions
Definition AgoraBase.h:6516
ScreenCaptureParameters(int width, int height, int f, int b, view_t *ex, int cnt)
Definition AgoraBase.h:6628
bool captureMouseCursor
Definition AgoraBase.h:6536
bool windowFocus
Definition AgoraBase.h:6545
bool enableHighLight
Definition AgoraBase.h:6579
The video configuration for the shared screen stream.
Definition AgoraBase.h:7642
int bitrate
Definition AgoraBase.h:7654
VIDEO_CONTENT_HINT contentHint
Definition AgoraBase.h:7658
int frameRate
Definition AgoraBase.h:7650
VideoDimensions dimensions
Definition AgoraBase.h:7646
ScreenVideoParameters()
Definition AgoraBase.h:7660
SCREEN_COLOR_TYPE screenColorType
Definition AgoraBase.h:6037
SEG_MODEL_TYPE
The type of algorithms to user for background processing.
Definition AgoraBase.h:5990
@ SEG_MODEL_AI
Definition AgoraBase.h:5994
@ SEG_MODEL_GREEN
Definition AgoraBase.h:5998
float greenCapacity
Definition AgoraBase.h:6032
SegmentationProperty()
Definition AgoraBase.h:6039
SCREEN_COLOR_TYPE
Screen color type.
Definition AgoraBase.h:6004
@ SCREEN_COLOR_GREEN
Definition AgoraBase.h:6012
@ SCREEN_COLOR_AUTO
Definition AgoraBase.h:6008
@ SCREEN_COLOR_BLUE
Definition AgoraBase.h:6016
SEG_MODEL_TYPE modelType
Definition AgoraBase.h:6022
SenderOptions()
Definition AgoraBase.h:1414
VIDEO_CODEC_TYPE codecType
Definition AgoraBase.h:1351
TCcMode ccMode
Definition AgoraBase.h:1346
int targetBitrate
Definition AgoraBase.h:1412
Configures the parameters of a specific layer in multi-quality video streams.
Definition AgoraBase.h:2304
int framerate
Definition AgoraBase.h:2312
bool enable
Definition AgoraBase.h:2318
VideoDimensions dimensions
Definition AgoraBase.h:2308
StreamLayerConfig()
Definition AgoraBase.h:2319
StreamLayerIndex
Index of video streams of different quality levels.
Definition AgoraBase.h:2262
@ STREAM_LAYER_4
Definition AgoraBase.h:2278
@ STREAM_LAYER_COUNT_MAX
Definition AgoraBase.h:2294
@ STREAM_LOW
Definition AgoraBase.h:2290
@ STREAM_LAYER_5
Definition AgoraBase.h:2282
@ STREAM_LAYER_3
Definition AgoraBase.h:2274
@ STREAM_LAYER_1
Definition AgoraBase.h:2266
@ STREAM_LAYER_2
Definition AgoraBase.h:2270
@ STREAM_LAYER_6
Definition AgoraBase.h:2286
SimulcastConfig()
Definition AgoraBase.h:2336
StreamLayerConfig configs[STREAM_LAYER_COUNT_MAX]
Definition AgoraBase.h:2325
bool publish_fallback_enable
Definition AgoraBase.h:2334
int kBitrate
Definition AgoraBase.h:2241
bool operator==(const SimulcastStreamConfig &rhs) const
Definition AgoraBase.h:2248
SimulcastStreamConfig(const SimulcastStreamConfig &other)
Definition AgoraBase.h:2247
SimulcastStreamConfig()
Definition AgoraBase.h:2246
int framerate
Definition AgoraBase.h:2245
VideoDimensions dimensions
Definition AgoraBase.h:2235
Transcoding configurations of each host.
Definition AgoraBase.h:4484
int y
Definition AgoraBase.h:4500
uid_t uid
Definition AgoraBase.h:4488
double alpha
Definition AgoraBase.h:4523
int x
Definition AgoraBase.h:4494
int zOrder
Definition AgoraBase.h:4517
TranscodingUser()
Definition AgoraBase.h:4545
int height
Definition AgoraBase.h:4508
int audioChannel
Definition AgoraBase.h:4543
int width
Definition AgoraBase.h:4504
The video streams for local video mixing.
Definition AgoraBase.h:4720
int zOrder
Definition AgoraBase.h:4767
uid_t remoteUserUid
Definition AgoraBase.h:4730
int height
Definition AgoraBase.h:4760
int y
Definition AgoraBase.h:4752
double alpha
Definition AgoraBase.h:4772
int width
Definition AgoraBase.h:4756
TranscodingVideoStream()
Definition AgoraBase.h:4781
int x
Definition AgoraBase.h:4747
int mediaPlayerId
Definition AgoraBase.h:4742
const char * imageUrl
Definition AgoraBase.h:4737
bool mirror
Definition AgoraBase.h:4779
VIDEO_SOURCE_TYPE sourceType
Definition AgoraBase.h:4724
char userAccount[MAX_USER_ACCOUNT_LENGTH]
Definition AgoraBase.h:7577
UserInfo()
Definition AgoraBase.h:7579
uid_t uid
Definition AgoraBase.h:7573
uid_t subviewUid
Definition AgoraBase.h:5274
VIDEO_VIEW_SETUP_MODE setupMode
Definition AgoraBase.h:5301
bool enableAlphaMask
Definition AgoraBase.h:5328
media::base::VIDEO_MODULE_POSITION position
Definition AgoraBase.h:5332
VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt)
Definition AgoraBase.h:5348
Rectangle cropArea
Definition AgoraBase.h:5315
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition AgoraBase.h:5297
uint32_t backgroundColor
Definition AgoraBase.h:5285
uid_t uid
Definition AgoraBase.h:5269
VIDEO_SOURCE_TYPE sourceType
Definition AgoraBase.h:5305
VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
Definition AgoraBase.h:5362
int mediaPlayerId
Definition AgoraBase.h:5309
VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u, uid_t subu)
Definition AgoraBase.h:5376
media::base::RENDER_MODE_TYPE renderMode
Definition AgoraBase.h:5289
VideoCanvas()
Definition AgoraBase.h:5334
view_t view
Definition AgoraBase.h:5280
VideoDenoiserOptions(VIDEO_DENOISER_MODE denoiserMode, VIDEO_DENOISER_LEVEL denoiserLevel)
Definition AgoraBase.h:5850
VIDEO_DENOISER_LEVEL level
Definition AgoraBase.h:5848
VIDEO_DENOISER_LEVEL
Video noise reduction level.
Definition AgoraBase.h:5824
@ VIDEO_DENOISER_LEVEL_FAST
Definition AgoraBase.h:5838
@ VIDEO_DENOISER_LEVEL_HIGH_QUALITY
Definition AgoraBase.h:5830
VIDEO_DENOISER_MODE mode
Definition AgoraBase.h:5843
VideoDenoiserOptions()
Definition AgoraBase.h:5853
VIDEO_DENOISER_MODE
Video noise reduction mode.
Definition AgoraBase.h:5810
@ VIDEO_DENOISER_AUTO
Definition AgoraBase.h:5815
@ VIDEO_DENOISER_MANUAL
Definition AgoraBase.h:5819
The video dimension.
Definition AgoraBase.h:1166
VideoDimensions()
Definition AgoraBase.h:1175
bool operator==(const VideoDimensions &rhs) const
Definition AgoraBase.h:1177
int height
Definition AgoraBase.h:1174
int width
Definition AgoraBase.h:1170
VideoDimensions(int w, int h)
Definition AgoraBase.h:1176
Video encoder configurations.
Definition AgoraBase.h:2057
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition AgoraBase.h:2109
DEGRADATION_PREFERENCE degradationPreference
Definition AgoraBase.h:2102
AdvanceOptions advanceOptions
Definition AgoraBase.h:2114
VideoEncoderConfiguration & operator=(const VideoEncoderConfiguration &rhs)
Definition AgoraBase.h:2157
VIDEO_CODEC_TYPE codecType
Definition AgoraBase.h:2061
VideoEncoderConfiguration()
Definition AgoraBase.h:2146
int minBitrate
Definition AgoraBase.h:2091
VideoEncoderConfiguration(int width, int height, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror=VIDEO_MIRROR_MODE_DISABLED)
Definition AgoraBase.h:2126
VideoEncoderConfiguration(const VideoDimensions &d, int f, int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror=VIDEO_MIRROR_MODE_DISABLED)
Definition AgoraBase.h:2116
ORIENTATION_MODE orientationMode
Definition AgoraBase.h:2095
int frameRate
Definition AgoraBase.h:2071
VideoEncoderConfiguration(const VideoEncoderConfiguration &config)
Definition AgoraBase.h:2136
int bitrate
Definition AgoraBase.h:2081
VideoDimensions dimensions
Definition AgoraBase.h:2067
OPTIONAL_ENUM_SIZE_T
Definition AgoraBase.h:3167
bool operator!=(const VideoFormat &fmt) const
Definition AgoraBase.h:3203
int width
Definition AgoraBase.h:3179
VideoFormat()
Definition AgoraBase.h:3188
bool operator==(const VideoFormat &fmt) const
Definition AgoraBase.h:3200
int height
Definition AgoraBase.h:3183
int fps
Definition AgoraBase.h:3187
bool operator<(const VideoFormat &fmt) const
Definition AgoraBase.h:3191
VideoFormat(int w, int h, int f)
Definition AgoraBase.h:3189
Indicators during video frame rendering progress.
Definition AgoraBase.h:7717
int remoteJoined2PacketReceived
Definition AgoraBase.h:7799
int joinSuccess2RemoteJoined
Definition AgoraBase.h:7754
int remoteJoined2UnmuteVideo
Definition AgoraBase.h:7784
int start2JoinChannel
Definition AgoraBase.h:7732
int remoteJoined2SetView
Definition AgoraBase.h:7769
int elapsedTime
Definition AgoraBase.h:7723
int join2JoinSuccess
Definition AgoraBase.h:7739
Optional< bool > encodedFrameOnly
Definition AgoraBase.h:1717
Optional< VIDEO_STREAM_TYPE > type
Definition AgoraBase.h:1710
VideoSubscriptionOptions()
Definition AgoraBase.h:1719
VIDEO_CODEC_TYPE codecType
Definition AgoraBase.h:3926
uint32_t observationPosition
Definition AgoraBase.h:3940
uid_t ownerUid
Definition AgoraBase.h:3914
track_id_t trackId
Definition AgoraBase.h:3918
VIDEO_SOURCE_TYPE sourceType
Definition AgoraBase.h:3936
bool isLocal
Definition AgoraBase.h:3910
bool encodedFrameOnly
Definition AgoraBase.h:3932
VideoTrackInfo()
Definition AgoraBase.h:3896
const char * channelId
Definition AgoraBase.h:3922
BACKGROUND_SOURCE_TYPE
The custom background.
Definition AgoraBase.h:5895
@ BACKGROUND_IMG
Definition AgoraBase.h:5909
@ BACKGROUND_NONE
Definition AgoraBase.h:5901
@ BACKGROUND_BLUR
Definition AgoraBase.h:5913
@ BACKGROUND_COLOR
Definition AgoraBase.h:5905
@ BACKGROUND_VIDEO
Definition AgoraBase.h:5917
BACKGROUND_BLUR_DEGREE blur_degree
Definition AgoraBase.h:5974
const char * source
Definition AgoraBase.h:5967
unsigned int color
Definition AgoraBase.h:5958
VirtualBackgroundSource()
Definition AgoraBase.h:5976
BACKGROUND_SOURCE_TYPE background_source_type
Definition AgoraBase.h:5944
BACKGROUND_BLUR_DEGREE
The degree of blurring applied to the custom background image.
Definition AgoraBase.h:5923
@ BLUR_DEGREE_MEDIUM
Definition AgoraBase.h:5933
@ BLUR_DEGREE_HIGH
Definition AgoraBase.h:5938
@ BLUR_DEGREE_LOW
Definition AgoraBase.h:5928
Configures the format, size, and pixel buffer of the watermark image.
Definition AgoraBase.h:2552
media::base::VIDEO_PIXEL_FORMAT format
Definition AgoraBase.h:2571
int width
Definition AgoraBase.h:2557
int height
Definition AgoraBase.h:2561
WatermarkBuffer()
Definition AgoraBase.h:2578
const uint8_t * buffer
Definition AgoraBase.h:2576
int length
Definition AgoraBase.h:2565
WatermarkConfig()
Definition AgoraBase.h:2623
WatermarkBuffer buffer
Definition AgoraBase.h:2599
const char * id
Definition AgoraBase.h:2590
WATERMARK_SOURCE_TYPE type
Definition AgoraBase.h:2594
WatermarkTimestamp timestamp
Definition AgoraBase.h:2605
WatermarkLiteral literal
Definition AgoraBase.h:2611
WatermarkOptions options
Definition AgoraBase.h:2621
const char * imageUrl
Definition AgoraBase.h:2615
The definition of the WatermarkLiteral struct.
Definition AgoraBase.h:2515
const char * fontFilePath
Definition AgoraBase.h:2537
WatermarkLiteral()
Definition AgoraBase.h:2539
int fontSize
Definition AgoraBase.h:2520
const char * wmLiteral
Definition AgoraBase.h:2530
int strokeWidth
Definition AgoraBase.h:2524
Watermark image configurations.
Definition AgoraBase.h:2408
int zOrder
Definition AgoraBase.h:2437
bool visibleInPreview
Definition AgoraBase.h:2414
WATERMARK_FIT_MODE mode
Definition AgoraBase.h:2433
Rectangle positionInLandscapeMode
Definition AgoraBase.h:2419
Rectangle positionInPortraitMode
Definition AgoraBase.h:2424
WatermarkOptions()
Definition AgoraBase.h:2439
WatermarkRatio watermarkRatio
Definition AgoraBase.h:2429
The position and size of the watermark on the screen.
Definition AgoraBase.h:2376
float widthRatio
Definition AgoraBase.h:2395
float xRatio
Definition AgoraBase.h:2382
float yRatio
Definition AgoraBase.h:2388
WatermarkRatio(float x, float y, float width)
Definition AgoraBase.h:2398
WatermarkRatio()
Definition AgoraBase.h:2397
The definition of the WatermarkTimestamp struct.
Definition AgoraBase.h:2481
WatermarkTimestamp()
Definition AgoraBase.h:2506
int strokeWidth
Definition AgoraBase.h:2496
const char * fontFilePath
Definition AgoraBase.h:2492
int fontSize
Definition AgoraBase.h:2485
const char * format
Definition AgoraBase.h:2504