9 #pragma once // NOLINT(build/header_guard)
17 #include "IAgoraParameter.h"
18 #include "AgoraMediaBase.h"
19 #include "AgoraRefPtr.h"
20 #include "AgoraOptional.h"
22 #define MAX_PATH_260 (260)
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>
34 #if defined(AGORARTC_EXPORT)
35 #define AGORA_API extern "C" __declspec(dllexport)
37 #define AGORA_API extern "C" __declspec(dllimport)
38 #endif // AGORARTC_EXPORT
40 #define AGORA_CALL __cdecl
44 #elif defined(__APPLE__)
46 #include <TargetConditionals.h>
48 #define AGORA_API extern "C" __attribute__((visibility("default")))
51 #elif defined(__ANDROID__) || defined(__linux__)
53 #define AGORA_API extern "C" __attribute__((visibility("default")))
58 #else // !_WIN32 && !__APPLE__ && !(__ANDROID__ || __linux__)
60 #define AGORA_API extern "C"
67 #ifndef OPTIONAL_ENUM_SIZE_T
68 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
69 #define OPTIONAL_ENUM_SIZE_T enum : size_t
71 #define OPTIONAL_ENUM_SIZE_T enum
75 #ifndef OPTIONAL_NULLPTR
76 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
77 #define OPTIONAL_NULLPTR nullptr
79 #define OPTIONAL_NULLPTR NULL
83 #define INVALID_DISPLAY_ID 0xffff
92 typedef commons::cjson::JsonWrapper any_document_t;
100 typedef T* pointer_type;
103 explicit AutoPtr(pointer_type p = NULL) : ptr_(p) {}
112 operator bool()
const {
return (ptr_ != NULL); }
114 value_type& operator*()
const {
return *get(); }
116 pointer_type operator->()
const {
return get(); }
118 pointer_type get()
const {
return ptr_; }
120 pointer_type release() {
121 pointer_type ret = ptr_;
126 void reset(pointer_type ptr = NULL) {
127 if (ptr != ptr_ && ptr_) {
134 template <
class C1,
class C2>
135 bool queryInterface(C1* c, C2 iid) {
136 pointer_type p = NULL;
137 if (c && !c->queryInterface(iid,
reinterpret_cast<void**
>(&p))) {
154 typedef typename AutoPtr<T>::pointer_type pointer_type;
160 if (
this != &rhs) this->reset(rhs.clone());
163 pointer_type clone()
const {
164 if (!this->get())
return NULL;
165 return this->get()->clone();
171 virtual bool empty()
const = 0;
172 virtual const char* c_str() = 0;
173 virtual const char* data() = 0;
174 virtual size_t length() = 0;
176 virtual void release() = 0;
183 virtual void* current() = 0;
184 virtual const void* const_current()
const = 0;
185 virtual bool next() = 0;
186 virtual void release() = 0;
193 virtual size_t size()
const = 0;
194 virtual void release() = 0;
203 typedef T value_type;
204 typedef value_type& reference;
205 typedef const value_type& const_reference;
206 typedef value_type* pointer;
207 typedef const value_type* const_pointer;
219 return p->current() == rhs.p->current();
221 return valid() == rhs.valid();
223 bool operator!=(
const AOutputIterator& rhs)
const {
return !this->operator==(rhs); }
224 reference operator*() {
return *
reinterpret_cast<pointer
>(p->current()); }
225 const_reference operator*()
const {
return *
reinterpret_cast<const_pointer
>(p->const_current()); }
226 bool valid()
const {
return p && p->current() != NULL; }
235 typedef T value_type;
236 typedef value_type& reference;
237 typedef const value_type& const_reference;
238 typedef value_type* pointer;
239 typedef const value_type* const_pointer;
240 typedef size_t size_type;
245 AList() : container(NULL), owner(
false) {}
246 AList(
IContainer* c,
bool take_ownership) : container(c), owner(take_ownership) {}
247 ~
AList() { reset(); }
248 void reset(
IContainer* c = NULL,
bool take_ownership =
false) {
249 if (owner && container) container->release();
251 owner = take_ownership;
255 size_type size()
const {
return container ? container->size() : 0; }
256 bool empty()
const {
return size() == 0; }
264 enum CHANNEL_PROFILE_TYPE {
270 CHANNEL_PROFILE_COMMUNICATION = 0,
276 CHANNEL_PROFILE_LIVE_BROADCASTING = 1,
281 CHANNEL_PROFILE_GAME __deprecated = 2,
287 CHANNEL_PROFILE_CLOUD_GAMING __deprecated = 3,
293 CHANNEL_PROFILE_COMMUNICATION_1v1 __deprecated = 4,
299 enum WARN_CODE_TYPE {
304 WARN_INVALID_VIEW = 8,
309 WARN_INIT_VIDEO = 16,
319 WARN_NO_AVAILABLE_CHANNEL = 103,
325 WARN_LOOKUP_CHANNEL_TIMEOUT = 104,
330 WARN_LOOKUP_CHANNEL_REJECTED = 105,
336 WARN_OPEN_CHANNEL_TIMEOUT = 106,
341 WARN_OPEN_CHANNEL_REJECTED = 107,
347 WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111,
351 WARN_SET_CLIENT_ROLE_TIMEOUT = 118,
355 WARN_OPEN_CHANNEL_INVALID_TICKET = 121,
359 WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122,
363 WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131,
367 WARN_CHANNEL_CONNECTION_IP_CHANGED = 132,
371 WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133,
374 WARN_CHANNEL_SOCKET_ERROR = 134,
378 WARN_AUDIO_MIXING_OPEN_ERROR = 701,
382 WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014,
386 WARN_ADM_RUNTIME_RECORDING_WARNING = 1016,
390 WARN_ADM_RECORD_AUDIO_SILENCE = 1019,
394 WARN_ADM_PLAYOUT_MALFUNCTION = 1020,
398 WARN_ADM_RECORD_MALFUNCTION = 1021,
402 WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031,
406 WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032,
414 WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040,
418 WARN_APM_HOWLING = 1051,
422 WARN_ADM_GLITCH_STATE = 1052,
426 WARN_ADM_IMPROPER_SETTINGS = 1053,
430 WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322,
435 WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323,
443 WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324,
449 enum ERROR_CODE_TYPE {
463 ERR_INVALID_ARGUMENT = 2,
474 ERR_NOT_SUPPORTED = 4,
482 ERR_BUFFER_TOO_SMALL = 6,
486 ERR_NOT_INITIALIZED = 7,
490 ERR_INVALID_STATE = 8,
495 ERR_NO_PERMISSION = 9,
518 ERR_BIND_SOCKET = 13,
529 ERR_JOIN_CHANNEL_REJECTED = 17,
536 ERR_LEAVE_CHANNEL_REJECTED = 18,
540 ERR_ALREADY_IN_USE = 19,
550 ERR_INIT_NET_ENGINE = 21,
555 ERR_RESOURCE_LIMITED = 22,
561 ERR_INVALID_APP_ID = 101,
566 ERR_INVALID_CHANNEL_NAME = 102,
572 ERR_NO_SERVER_RESOURCES = 103,
585 ERR_TOKEN_EXPIRED = 109,
602 ERR_INVALID_TOKEN = 110,
607 ERR_CONNECTION_INTERRUPTED = 111,
612 ERR_CONNECTION_LOST = 112,
617 ERR_NOT_IN_CHANNEL = 113,
622 ERR_SIZE_TOO_LARGE = 114,
627 ERR_BITRATE_LIMIT = 115,
632 ERR_TOO_MANY_DATA_STREAMS = 116,
636 ERR_STREAM_MESSAGE_TIMEOUT = 117,
640 ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119,
645 ERR_DECRYPTION_FAILED = 120,
649 ERR_INVALID_USER_ID = 121,
653 ERR_CLIENT_IS_BANNED_BY_SERVER = 123,
659 ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130,
664 ERR_LICENSE_CREDENTIAL_INVALID = 131,
669 ERR_INVALID_USER_ACCOUNT = 134,
676 ERR_MODULE_NOT_FOUND = 157,
680 ERR_CERT_JSON_PART = 158,
681 ERR_CERT_JSON_INVAL = 159,
682 ERR_CERT_JSON_NOMEM = 160,
683 ERR_CERT_CUSTOM = 161,
684 ERR_CERT_CREDENTIAL = 162,
689 ERR_CERT_DUEDATE = 167,
690 ERR_CERT_REQUEST = 168,
693 ERR_PCMSEND_FORMAT = 200,
694 ERR_PCMSEND_BUFFEROVERFLOW = 201,
698 ERR_LOGIN_ALREADY_LOGIN = 428,
705 ERR_LOAD_MEDIA_ENGINE = 1001,
711 ERR_ADM_GENERAL_ERROR = 1005,
716 ERR_ADM_INIT_PLAYOUT = 1008,
720 ERR_ADM_START_PLAYOUT = 1009,
724 ERR_ADM_STOP_PLAYOUT = 1010,
729 ERR_ADM_INIT_RECORDING = 1011,
733 ERR_ADM_START_RECORDING = 1012,
737 ERR_ADM_STOP_RECORDING = 1013,
741 ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501,
744 enum LICENSE_ERROR_TYPE {
748 LICENSE_ERR_INVALID = 1,
752 LICENSE_ERR_EXPIRE = 2,
756 LICENSE_ERR_MINUTES_EXCEED = 3,
760 LICENSE_ERR_LIMITED_PERIOD = 4,
764 LICENSE_ERR_DIFF_DEVICES = 5,
768 LICENSE_ERR_INTERNAL = 99,
774 enum AUDIO_SESSION_OPERATION_RESTRICTION {
778 AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0,
782 AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1,
786 AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1,
791 AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2,
796 AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7,
799 typedef const char* user_id_t;
800 typedef void* view_t;
826 typedef util::AList<UserInfo> UserList;
834 enum USER_OFFLINE_REASON_TYPE {
838 USER_OFFLINE_QUIT = 0,
844 USER_OFFLINE_DROPPED = 1,
848 USER_OFFLINE_BECOME_AUDIENCE = 2,
851 enum INTERFACE_ID_TYPE {
852 AGORA_IID_AUDIO_DEVICE_MANAGER = 1,
853 AGORA_IID_VIDEO_DEVICE_MANAGER = 2,
854 AGORA_IID_PARAMETER_ENGINE = 3,
855 AGORA_IID_MEDIA_ENGINE = 4,
856 AGORA_IID_AUDIO_ENGINE = 5,
857 AGORA_IID_VIDEO_ENGINE = 6,
858 AGORA_IID_RTC_CONNECTION = 7,
859 AGORA_IID_SIGNALING_ENGINE = 8,
860 AGORA_IID_MEDIA_ENGINE_REGULATOR = 9,
861 AGORA_IID_CLOUD_SPATIAL_AUDIO = 10,
862 AGORA_IID_LOCAL_SPATIAL_AUDIO = 11,
863 AGORA_IID_MEDIA_RECORDER = 12,
864 AGORA_IID_STATE_SYNC = 13,
865 AGORA_IID_METACHAT_SERVICE = 14,
866 AGORA_IID_MUSIC_CONTENT_CENTER = 15,
877 QUALITY_UNKNOWN __deprecated = 0,
881 QUALITY_EXCELLENT = 1,
906 QUALITY_UNSUPPORTED = 7,
910 QUALITY_DETECTING = 8,
934 enum VIDEO_ORIENTATION {
938 VIDEO_ORIENTATION_0 = 0,
942 VIDEO_ORIENTATION_90 = 90,
946 VIDEO_ORIENTATION_180 = 180,
950 VIDEO_ORIENTATION_270 = 270
960 FRAME_RATE_FPS_1 = 1,
964 FRAME_RATE_FPS_7 = 7,
968 FRAME_RATE_FPS_10 = 10,
972 FRAME_RATE_FPS_15 = 15,
976 FRAME_RATE_FPS_24 = 24,
980 FRAME_RATE_FPS_30 = 30,
984 FRAME_RATE_FPS_60 = 60,
988 FRAME_WIDTH_640 = 640,
992 FRAME_HEIGHT_360 = 360,
999 enum VIDEO_FRAME_TYPE {
1001 VIDEO_FRAME_TYPE_BLANK_FRAME = 0,
1003 VIDEO_FRAME_TYPE_KEY_FRAME = 3,
1005 VIDEO_FRAME_TYPE_DELTA_FRAME = 4,
1007 VIDEO_FRAME_TYPE_B_FRAME = 5,
1009 VIDEO_FRAME_TYPE_DROPPABLE_FRAME = 6,
1011 VIDEO_FRAME_TYPE_UNKNOW
1017 enum ORIENTATION_MODE {
1025 ORIENTATION_MODE_ADAPTIVE = 0,
1033 ORIENTATION_MODE_FIXED_LANDSCAPE = 1,
1041 ORIENTATION_MODE_FIXED_PORTRAIT = 2,
1047 enum DEGRADATION_PREFERENCE {
1051 MAINTAIN_QUALITY = 0,
1055 MAINTAIN_FRAMERATE = 1,
1059 MAINTAIN_BALANCED = 2,
1063 MAINTAIN_RESOLUTION = 3,
1084 bool operator==(
const VideoDimensions& rhs)
const {
1085 return width == rhs.width &&
height == rhs.height;
1098 const int STANDARD_BITRATE = 0;
1107 const int COMPATIBLE_BITRATE = -1;
1112 const int DEFAULT_MIN_BITRATE = -1;
1117 const int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
1122 enum VIDEO_CODEC_TYPE {
1123 VIDEO_CODEC_NONE = 0,
1127 VIDEO_CODEC_VP8 = 1,
1131 VIDEO_CODEC_H264 = 2,
1135 VIDEO_CODEC_H265 = 3,
1139 VIDEO_CODEC_GENERIC = 6,
1143 VIDEO_CODEC_GENERIC_H264 = 7,
1147 VIDEO_CODEC_AV1 = 12,
1151 VIDEO_CODEC_VP9 = 13,
1155 VIDEO_CODEC_GENERIC_JPEG = 20,
1252 enum AUDIO_CODEC_TYPE {
1256 AUDIO_CODEC_OPUS = 1,
1261 AUDIO_CODEC_PCMA = 3,
1265 AUDIO_CODEC_PCMU = 4,
1269 AUDIO_CODEC_G722 = 5,
1276 AUDIO_CODEC_AACLC = 8,
1280 AUDIO_CODEC_HEAAC = 9,
1284 AUDIO_CODEC_JC1 = 10,
1285 AUDIO_CODEC_HEAAC2 = 11,
1289 AUDIO_CODEC_LPCNET = 12,
1295 enum AUDIO_ENCODING_TYPE {
1299 AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101,
1303 AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102,
1307 AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201,
1311 AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202,
1315 AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203,
1319 AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302,
1323 AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303,
1328 AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101,
1332 AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102,
1336 AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302,
1340 AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303,
1346 enum WATERMARK_FIT_MODE {
1351 FIT_MODE_COVER_POSITION,
1356 FIT_MODE_USE_IMAGE_RATIO
1386 :
codec(AUDIO_CODEC_AACLC),
1435 channelNum(rhs.channelNum),
1464 enum H264PacketizeMode {
1478 enum VIDEO_STREAM_TYPE {
1482 VIDEO_STREAM_HIGH = 0,
1486 VIDEO_STREAM_LOW = 1,
1516 frameType(VIDEO_FRAME_TYPE_BLANK_FRAME),
1538 if (
this == &rhs)
return *
this;
1605 enum VIDEO_MIRROR_MODE_TYPE {
1609 VIDEO_MIRROR_MODE_AUTO = 0,
1613 VIDEO_MIRROR_MODE_ENABLED = 1,
1617 VIDEO_MIRROR_MODE_DISABLED = 2,
1622 enum CODEC_CAP_MASK {
1624 CODEC_CAP_MASK_NONE = 0,
1627 CODEC_CAP_MASK_HW_DEC = 1 << 0,
1630 CODEC_CAP_MASK_HW_ENC = 1 << 1,
1633 CODEC_CAP_MASK_SW_DEC = 1 << 2,
1636 CODEC_CAP_MASK_SW_ENC = 1 << 3,
1759 VideoEncoderConfiguration(
int width,
int height,
int f,
int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror = VIDEO_MIRROR_MODE_DISABLED)
1768 VideoEncoderConfiguration(
const VideoEncoderConfiguration& config)
1777 VideoEncoderConfiguration()
1779 dimensions(FRAME_WIDTH_640, FRAME_HEIGHT_360),
1787 VideoEncoderConfiguration& operator=(
const VideoEncoderConfiguration& rhs) {
1788 if (
this == &rhs)
return *
this;
1815 enum SIMULCAST_STREAM_MODE {
1819 AUTO_SIMULCAST_STREAM = -1,
1823 DISABLE_SIMULCAST_STREAM = 0,
1827 ENABLE_SIMULCAST_STREAM = 1,
1926 mode(FIT_MODE_COVER_POSITION) {}
2114 enum VIDEO_SOURCE_TYPE {
2117 VIDEO_SOURCE_CAMERA_PRIMARY = 0,
2118 VIDEO_SOURCE_CAMERA = VIDEO_SOURCE_CAMERA_PRIMARY,
2121 VIDEO_SOURCE_CAMERA_SECONDARY = 1,
2124 VIDEO_SOURCE_SCREEN_PRIMARY = 2,
2125 VIDEO_SOURCE_SCREEN = VIDEO_SOURCE_SCREEN_PRIMARY,
2128 VIDEO_SOURCE_SCREEN_SECONDARY = 3,
2131 VIDEO_SOURCE_CUSTOM = 4,
2134 VIDEO_SOURCE_MEDIA_PLAYER = 5,
2137 VIDEO_SOURCE_RTC_IMAGE_PNG = 6,
2140 VIDEO_SOURCE_RTC_IMAGE_JPEG = 7,
2143 VIDEO_SOURCE_RTC_IMAGE_GIF = 8,
2146 VIDEO_SOURCE_REMOTE = 9,
2149 VIDEO_SOURCE_TRANSCODED = 10,
2151 VIDEO_SOURCE_UNKNOWN = 100
2157 enum CLIENT_ROLE_TYPE {
2161 CLIENT_ROLE_BROADCASTER = 1,
2165 CLIENT_ROLE_AUDIENCE = 2,
2170 enum QUALITY_ADAPT_INDICATION {
2174 ADAPT_UP_BANDWIDTH = 1,
2176 ADAPT_DOWN_BANDWIDTH = 2,
2180 enum AUDIENCE_LATENCY_LEVEL_TYPE
2183 AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1,
2185 AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2,
2204 enum EXPERIENCE_QUALITY_TYPE {
2206 EXPERIENCE_QUALITY_GOOD = 0,
2208 EXPERIENCE_QUALITY_BAD = 1,
2215 enum EXPERIENCE_POOR_REASON {
2218 EXPERIENCE_REASON_NONE = 0,
2221 REMOTE_NETWORK_QUALITY_POOR = 1,
2224 LOCAL_NETWORK_QUALITY_POOR = 2,
2227 WIRELESS_SIGNAL_POOR = 4,
2231 WIFI_BLUETOOTH_COEXIST = 8,
2341 enum AUDIO_PROFILE_TYPE {
2349 AUDIO_PROFILE_DEFAULT = 0,
2353 AUDIO_PROFILE_SPEECH_STANDARD = 1,
2357 AUDIO_PROFILE_MUSIC_STANDARD = 2,
2362 AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3,
2366 AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4,
2370 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5,
2374 AUDIO_PROFILE_IOT = 6,
2375 AUDIO_PROFILE_NUM = 7
2381 enum AUDIO_SCENARIO_TYPE {
2385 AUDIO_SCENARIO_DEFAULT = 0,
2391 AUDIO_SCENARIO_GAME_STREAMING = 3,
2397 AUDIO_SCENARIO_CHATROOM = 5,
2401 AUDIO_SCENARIO_CHORUS = 7,
2405 AUDIO_SCENARIO_MEETING = 8,
2409 AUDIO_SCENARIO_NUM = 9,
2416 OPTIONAL_ENUM_SIZE_T {
2418 kMaxWidthInPixels = 3840,
2420 kMaxHeightInPixels = 2160,
2440 bool operator<(
const VideoFormat& fmt)
const {
2441 if (
height != fmt.height) {
2442 return height < fmt.height;
2443 }
else if (
width != fmt.width) {
2444 return width < fmt.width;
2446 return fps < fmt.fps;
2449 bool operator==(
const VideoFormat& fmt)
const {
2450 return width == fmt.width &&
height == fmt.height &&
fps == fmt.fps;
2452 bool operator!=(
const VideoFormat& fmt)
const {
2453 return !operator==(fmt);
2460 enum VIDEO_CONTENT_HINT {
2471 CONTENT_HINT_MOTION,
2477 CONTENT_HINT_DETAILS
2480 enum SCREEN_SCENARIO_TYPE {
2481 SCREEN_SCENARIO_DOCUMENT = 1,
2482 SCREEN_SCENARIO_GAMING = 2,
2483 SCREEN_SCENARIO_VIDEO = 3,
2484 SCREEN_SCENARIO_RDC = 4,
2490 enum CAPTURE_BRIGHTNESS_LEVEL_TYPE {
2494 CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1,
2497 CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0,
2500 CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1,
2503 CAPTURE_BRIGHTNESS_LEVEL_DARK = 2,
2509 enum LOCAL_AUDIO_STREAM_STATE {
2513 LOCAL_AUDIO_STREAM_STATE_STOPPED = 0,
2517 LOCAL_AUDIO_STREAM_STATE_RECORDING = 1,
2521 LOCAL_AUDIO_STREAM_STATE_ENCODING = 2,
2525 LOCAL_AUDIO_STREAM_STATE_FAILED = 3
2531 enum LOCAL_AUDIO_STREAM_ERROR {
2535 LOCAL_AUDIO_STREAM_ERROR_OK = 0,
2539 LOCAL_AUDIO_STREAM_ERROR_FAILURE = 1,
2543 LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2,
2547 LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY = 3,
2552 LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE = 4,
2556 LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5,
2559 LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE = 6,
2562 LOCAL_AUDIO_STREAM_ERROR_NO_PLAYOUT_DEVICE = 7,
2566 LOCAL_AUDIO_STREAM_ERROR_INTERRUPTED = 8,
2569 LOCAL_AUDIO_STREAM_ERROR_RECORD_INVALID_ID = 9,
2572 LOCAL_AUDIO_STREAM_ERROR_PLAYOUT_INVALID_ID = 10,
2577 enum LOCAL_VIDEO_STREAM_STATE {
2581 LOCAL_VIDEO_STREAM_STATE_STOPPED = 0,
2585 LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1,
2589 LOCAL_VIDEO_STREAM_STATE_ENCODING = 2,
2593 LOCAL_VIDEO_STREAM_STATE_FAILED = 3
2599 enum LOCAL_VIDEO_STREAM_ERROR {
2601 LOCAL_VIDEO_STREAM_ERROR_OK = 0,
2603 LOCAL_VIDEO_STREAM_ERROR_FAILURE = 1,
2605 LOCAL_VIDEO_STREAM_ERROR_DEVICE_NO_PERMISSION = 2,
2607 LOCAL_VIDEO_STREAM_ERROR_DEVICE_BUSY = 3,
2609 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE = 4,
2611 LOCAL_VIDEO_STREAM_ERROR_CODEC_NOT_SUPPORT = 5,
2613 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_INBACKGROUND = 6,
2615 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7,
2617 LOCAL_VIDEO_STREAM_ERROR_DEVICE_NOT_FOUND = 8,
2619 LOCAL_VIDEO_STREAM_ERROR_DEVICE_DISCONNECTED = 9,
2621 LOCAL_VIDEO_STREAM_ERROR_DEVICE_INVALID_ID = 10,
2623 LOCAL_VIDEO_STREAM_ERROR_DEVICE_SYSTEM_PRESSURE = 101,
2625 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11,
2627 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_CLOSED = 12,
2629 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_OCCLUDED = 13,
2631 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20,
2633 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_FAILURE = 21,
2635 LOCAL_VIDEO_STREAM_ERROR_SCREEN_CAPTURE_NO_PERMISSION = 22,
2641 enum REMOTE_AUDIO_STATE
2649 REMOTE_AUDIO_STATE_STOPPED = 0,
2653 REMOTE_AUDIO_STATE_STARTING = 1,
2660 REMOTE_AUDIO_STATE_DECODING = 2,
2665 REMOTE_AUDIO_STATE_FROZEN = 3,
2670 REMOTE_AUDIO_STATE_FAILED = 4,
2676 enum REMOTE_AUDIO_STATE_REASON
2681 REMOTE_AUDIO_REASON_INTERNAL = 0,
2685 REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1,
2689 REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2,
2694 REMOTE_AUDIO_REASON_LOCAL_MUTED = 3,
2699 REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4,
2704 REMOTE_AUDIO_REASON_REMOTE_MUTED = 5,
2709 REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6,
2713 REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7,
2717 enum REMOTE_VIDEO_STATE {
2724 REMOTE_VIDEO_STATE_STOPPED = 0,
2727 REMOTE_VIDEO_STATE_STARTING = 1,
2734 REMOTE_VIDEO_STATE_DECODING = 2,
2738 REMOTE_VIDEO_STATE_FROZEN = 3,
2742 REMOTE_VIDEO_STATE_FAILED = 4,
2745 enum REMOTE_VIDEO_STATE_REASON {
2749 REMOTE_VIDEO_STATE_REASON_INTERNAL = 0,
2754 REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1,
2759 REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2,
2764 REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3,
2769 REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4,
2774 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5,
2779 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6,
2784 REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7,
2789 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8,
2794 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9,
2799 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_LOW = 10,
2803 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_HIGH = 11,
2806 REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND = 12,
2810 REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT = 13,
2817 enum REMOTE_USER_STATE {
2821 USER_STATE_MUTE_AUDIO = (1 << 0),
2825 USER_STATE_MUTE_VIDEO = (1 << 1),
2829 USER_STATE_ENABLE_VIDEO = (1 << 4),
2833 USER_STATE_ENABLE_LOCAL_VIDEO = (1 << 8),
2893 enum REMOTE_VIDEO_DOWNSCALE_LEVEL {
2897 REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE,
2901 REMOTE_VIDEO_DOWNSCALE_LEVEL_1,
2905 REMOTE_VIDEO_DOWNSCALE_LEVEL_2,
2909 REMOTE_VIDEO_DOWNSCALE_LEVEL_3,
2913 REMOTE_VIDEO_DOWNSCALE_LEVEL_4,
2950 bool isLowLatencyAudioSupported;
2952 DeviceInfo() : isLowLatencyAudioSupported(
false) {}
3013 enum AUDIO_SAMPLE_RATE_TYPE {
3017 AUDIO_SAMPLE_RATE_32000 = 32000,
3021 AUDIO_SAMPLE_RATE_44100 = 44100,
3025 AUDIO_SAMPLE_RATE_48000 = 48000,
3027 enum VIDEO_CODEC_TYPE_FOR_STREAM {
3031 VIDEO_CODEC_H264_FOR_STREAM = 1,
3035 VIDEO_CODEC_H265_FOR_STREAM = 2,
3041 enum VIDEO_CODEC_PROFILE_TYPE {
3045 VIDEO_CODEC_PROFILE_BASELINE = 66,
3049 VIDEO_CODEC_PROFILE_MAIN = 77,
3053 VIDEO_CODEC_PROFILE_HIGH = 100,
3060 enum AUDIO_CODEC_PROFILE_TYPE {
3064 AUDIO_CODEC_PROFILE_LC_AAC = 0,
3068 AUDIO_CODEC_PROFILE_HE_AAC = 1,
3072 AUDIO_CODEC_PROFILE_HE_AAC_V2 = 2,
3111 enum RTMP_STREAM_PUBLISH_STATE {
3114 RTMP_STREAM_PUBLISH_STATE_IDLE = 0,
3117 RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1,
3120 RTMP_STREAM_PUBLISH_STATE_RUNNING = 2,
3126 RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3,
3129 RTMP_STREAM_PUBLISH_STATE_FAILURE = 4,
3132 RTMP_STREAM_PUBLISH_STATE_DISCONNECTING = 5,
3138 enum RTMP_STREAM_PUBLISH_ERROR_TYPE {
3140 RTMP_STREAM_PUBLISH_ERROR_OK = 0,
3142 RTMP_STREAM_PUBLISH_ERROR_INVALID_ARGUMENT = 1,
3144 RTMP_STREAM_PUBLISH_ERROR_ENCRYPTED_STREAM_NOT_ALLOWED = 2,
3146 RTMP_STREAM_PUBLISH_ERROR_CONNECTION_TIMEOUT = 3,
3148 RTMP_STREAM_PUBLISH_ERROR_INTERNAL_SERVER_ERROR = 4,
3150 RTMP_STREAM_PUBLISH_ERROR_RTMP_SERVER_ERROR = 5,
3152 RTMP_STREAM_PUBLISH_ERROR_TOO_OFTEN = 6,
3154 RTMP_STREAM_PUBLISH_ERROR_REACH_LIMIT = 7,
3156 RTMP_STREAM_PUBLISH_ERROR_NOT_AUTHORIZED = 8,
3158 RTMP_STREAM_PUBLISH_ERROR_STREAM_NOT_FOUND = 9,
3160 RTMP_STREAM_PUBLISH_ERROR_FORMAT_NOT_SUPPORTED = 10,
3162 RTMP_STREAM_PUBLISH_ERROR_NOT_BROADCASTER = 11,
3164 RTMP_STREAM_PUBLISH_ERROR_TRANSCODING_NO_MIX_STREAM = 13,
3166 RTMP_STREAM_PUBLISH_ERROR_NET_DOWN = 14,
3168 RTMP_STREAM_PUBLISH_ERROR_INVALID_APPID = 15,
3170 RTMP_STREAM_PUBLISH_ERROR_INVALID_PRIVILEGE = 16,
3178 RTMP_STREAM_UNPUBLISH_ERROR_OK = 100,
3182 enum RTMP_STREAMING_EVENT {
3185 RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1,
3190 RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2,
3193 RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT = 3,
3196 RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN = 4,
3262 enum CONNECTION_STATE_TYPE
3267 CONNECTION_STATE_DISCONNECTED = 1,
3271 CONNECTION_STATE_CONNECTING = 2,
3276 CONNECTION_STATE_CONNECTED = 3,
3281 CONNECTION_STATE_RECONNECTING = 4,
3285 CONNECTION_STATE_FAILED = 5,
3472 unsigned int advancedFeatureCount;
3474 LiveTranscoding() :
width(360),
height(640),
videoBitrate(400),
videoFramerate(15),
lowLatency(false),
videoGop(30),
videoCodecProfile(VIDEO_CODEC_PROFILE_HIGH),
backgroundColor(0x000000),
videoCodecType(VIDEO_CODEC_H264_FOR_STREAM),
userCount(0),
transcodingUsers(NULL),
transcodingExtraInfo(NULL),
metadata(NULL),
watermark(NULL),
watermarkCount(0),
backgroundImage(NULL),
backgroundImageCount(0),
audioSampleRate(AUDIO_SAMPLE_RATE_48000),
audioBitrate(48),
audioChannels(1),
audioCodecProfile(AUDIO_CODEC_PROFILE_LC_AAC), advancedFeatures(NULL), advancedFeatureCount(0) {}
3529 :
sourceType(agora::media::PRIMARY_CAMERA_SOURCE),
3571 enum VIDEO_TRANSCODER_ERROR {
3579 VT_ERR_VIDEO_SOURCE_NOT_READY = 1,
3583 VT_ERR_INVALID_MEDIA_SOURCE_TYPE = 2,
3587 VT_ERR_INVALID_IMAGE_PATH = 3,
3591 VT_ERR_UNSUPPORT_IMAGE_FORMAT = 4,
3595 VT_ERR_INVALID_LAYOUT = 5,
3599 VT_ERR_INTERNAL = 20
3635 enum LASTMILE_PROBE_RESULT_STATE {
3639 LASTMILE_PROBE_RESULT_COMPLETE = 1,
3644 LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2,
3649 LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
3698 :
state(LASTMILE_PROBE_RESULT_UNAVAILABLE),
3705 enum CONNECTION_CHANGED_REASON_TYPE
3710 CONNECTION_CHANGED_CONNECTING = 0,
3714 CONNECTION_CHANGED_JOIN_SUCCESS = 1,
3718 CONNECTION_CHANGED_INTERRUPTED = 2,
3722 CONNECTION_CHANGED_BANNED_BY_SERVER = 3,
3726 CONNECTION_CHANGED_JOIN_FAILED = 4,
3730 CONNECTION_CHANGED_LEAVE_CHANNEL = 5,
3734 CONNECTION_CHANGED_INVALID_APP_ID = 6,
3738 CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7,
3742 CONNECTION_CHANGED_INVALID_TOKEN = 8,
3746 CONNECTION_CHANGED_TOKEN_EXPIRED = 9,
3750 CONNECTION_CHANGED_REJECTED_BY_SERVER = 10,
3754 CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11,
3758 CONNECTION_CHANGED_RENEW_TOKEN = 12,
3763 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13,
3767 CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14,
3771 CONNECTION_CHANGED_REJOIN_SUCCESS = 15,
3775 CONNECTION_CHANGED_LOST = 16,
3779 CONNECTION_CHANGED_ECHO_TEST = 17,
3783 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER = 18,
3787 CONNECTION_CHANGED_SAME_UID_LOGIN = 19,
3791 CONNECTION_CHANGED_TOO_MANY_BROADCASTERS = 20,
3796 CONNECTION_CHANGED_LICENSE_VERIFY_FAILED = 21,
3802 enum CLIENT_ROLE_CHANGE_FAILED_REASON {
3806 CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1,
3810 CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED = 2,
3814 CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT = 3,
3818 CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED = 4,
3824 enum WLACC_MESSAGE_REASON {
3828 WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0,
3832 WLACC_MESSAGE_REASON_CHANNEL_CONGESTION = 1,
3838 enum WLACC_SUGGEST_ACTION {
3842 WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI = 0,
3846 WLACC_SUGGEST_ACTION_CONNECT_SSID = 1,
3850 WLACC_SUGGEST_ACTION_CHECK_5G = 2,
3854 WLACC_SUGGEST_ACTION_MODIFY_SSID = 3,
3882 NETWORK_TYPE_UNKNOWN = -1,
3886 NETWORK_TYPE_DISCONNECTED = 0,
3890 NETWORK_TYPE_LAN = 1,
3894 NETWORK_TYPE_WIFI = 2,
3898 NETWORK_TYPE_MOBILE_2G = 3,
3902 NETWORK_TYPE_MOBILE_3G = 4,
3906 NETWORK_TYPE_MOBILE_4G = 5,
3912 enum VIDEO_VIEW_SETUP_MODE {
3916 VIDEO_VIEW_SETUP_REPLACE = 0,
3920 VIDEO_VIEW_SETUP_ADD = 1,
3924 VIDEO_VIEW_SETUP_REMOVE = 2,
3953 VIDEO_SOURCE_TYPE sourceType;
3957 VIDEO_VIEW_SETUP_MODE setupMode;
3960 uid(0), isScreenView(false), priv(NULL), priv_size(0), sourceType(VIDEO_SOURCE_CAMERA_PRIMARY), setupMode(VIDEO_VIEW_SETUP_REPLACE) {}
3961 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
3963 sourceType(VIDEO_SOURCE_CAMERA_PRIMARY), setupMode(VIDEO_VIEW_SETUP_REPLACE) {}
3964 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, user_id_t)
3966 sourceType(VIDEO_SOURCE_CAMERA_PRIMARY), setupMode(VIDEO_VIEW_SETUP_REPLACE) {}
4169 enum SEG_MODEL_TYPE {
4175 SEG_MODEL_TYPE modelType;
4177 float greenCapacity;
4203 enum VOICE_BEAUTIFIER_PRESET {
4206 VOICE_BEAUTIFIER_OFF = 0x00000000,
4212 CHAT_BEAUTIFIER_MAGNETIC = 0x01010100,
4218 CHAT_BEAUTIFIER_FRESH = 0x01010200,
4224 CHAT_BEAUTIFIER_VITALITY = 0x01010300,
4238 SINGING_BEAUTIFIER = 0x01020100,
4241 TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100,
4244 TIMBRE_TRANSFORMATION_DEEP = 0x01030200,
4247 TIMBRE_TRANSFORMATION_MELLOW = 0x01030300,
4250 TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400,
4253 TIMBRE_TRANSFORMATION_FULL = 0x01030500,
4256 TIMBRE_TRANSFORMATION_CLEAR = 0x01030600,
4259 TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700,
4262 TIMBRE_TRANSFORMATION_RINGING = 0x01030800,
4264 ULTRA_HIGH_QUALITY_VOICE = 0x01040100
4269 enum AUDIO_EFFECT_PRESET {
4272 AUDIO_EFFECT_OFF = 0x00000000,
4280 ROOM_ACOUSTICS_KTV = 0x02010100,
4288 ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200,
4296 ROOM_ACOUSTICS_STUDIO = 0x02010300,
4304 ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400,
4311 ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500,
4319 ROOM_ACOUSTICS_SPACIAL = 0x02010600,
4327 ROOM_ACOUSTICS_ETHEREAL = 0x02010700,
4339 ROOM_ACOUSTICS_3D_VOICE = 0x02010800,
4350 ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND = 0x02010900,
4361 VOICE_CHANGER_EFFECT_UNCLE = 0x02020100,
4372 VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200,
4383 VOICE_CHANGER_EFFECT_BOY = 0x02020300,
4394 VOICE_CHANGER_EFFECT_SISTER = 0x02020400,
4405 VOICE_CHANGER_EFFECT_GIRL = 0x02020500,
4414 VOICE_CHANGER_EFFECT_PIGKING = 0x02020600,
4422 VOICE_CHANGER_EFFECT_HULK = 0x02020700,
4430 STYLE_TRANSFORMATION_RNB = 0x02030100,
4438 STYLE_TRANSFORMATION_POPULAR = 0x02030200,
4448 PITCH_CORRECTION = 0x02040100,
4457 enum VOICE_CONVERSION_PRESET {
4460 VOICE_CONVERSION_OFF = 0x00000000,
4463 VOICE_CHANGER_NEUTRAL = 0x03010100,
4466 VOICE_CHANGER_SWEET = 0x03010200,
4469 VOICE_CHANGER_SOLID = 0x03010300,
4472 VOICE_CHANGER_BASS = 0x03010400
4477 enum HEADPHONE_EQUALIZER_PRESET {
4480 HEADPHONE_EQUALIZER_OFF = 0x00000000,
4483 HEADPHONE_EQUALIZER_OVEREAR = 0x04000001,
4486 HEADPHONE_EQUALIZER_INEAR = 0x04000002
4546 :
dimensions(1920, 1080),
frameRate(5),
bitrate(STANDARD_BITRATE),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4549 ScreenCaptureParameters(
int width,
int height,
int f,
int b)
4550 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false){}
4551 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs)
4552 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4553 ScreenCaptureParameters(
int width,
int height,
int f,
int b, view_t *ex,
int cnt)
4554 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4555 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs, view_t *ex,
int cnt)
4556 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4562 enum AUDIO_RECORDING_QUALITY_TYPE {
4566 AUDIO_RECORDING_QUALITY_LOW = 0,
4570 AUDIO_RECORDING_QUALITY_MEDIUM = 1,
4574 AUDIO_RECORDING_QUALITY_HIGH = 2,
4578 AUDIO_RECORDING_QUALITY_ULTRA_HIGH = 3,
4584 enum AUDIO_FILE_RECORDING_TYPE {
4588 AUDIO_FILE_RECORDING_MIC = 1,
4592 AUDIO_FILE_RECORDING_PLAYBACK = 2,
4596 AUDIO_FILE_RECORDING_MIXED = 3,
4602 enum AUDIO_ENCODED_FRAME_OBSERVER_POSITION {
4606 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1,
4610 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2,
4614 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3,
4658 quality(AUDIO_RECORDING_QUALITY_LOW),
4669 AudioRecordingConfiguration(
const char* file_path,
bool enc,
int sample_rate, AUDIO_FILE_RECORDING_TYPE type, AUDIO_RECORDING_QUALITY_TYPE quality_type,
int channel)
4677 AudioRecordingConfiguration(
const AudioRecordingConfiguration &rhs)
4701 :
postionType(AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK),
4744 AREA_CODE_CN = 0x00000001,
4748 AREA_CODE_NA = 0x00000002,
4752 AREA_CODE_EU = 0x00000004,
4756 AREA_CODE_AS = 0x00000008,
4760 AREA_CODE_JP = 0x00000010,
4764 AREA_CODE_IN = 0x00000020,
4768 AREA_CODE_GLOB = (0xFFFFFFFF)
4775 AREA_CODE_OC = 0x00000040,
4779 AREA_CODE_SA = 0x00000080,
4783 AREA_CODE_AF = 0x00000100,
4787 AREA_CODE_KR = 0x00000200,
4791 AREA_CODE_HKMC = 0x00000400,
4795 AREA_CODE_US = 0x00000800,
4799 AREA_CODE_OVS = 0xFFFFFFFE
4802 enum CHANNEL_MEDIA_RELAY_ERROR {
4808 RELAY_ERROR_SERVER_ERROR_RESPONSE = 1,
4813 RELAY_ERROR_SERVER_NO_RESPONSE = 2,
4817 RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3,
4820 RELAY_ERROR_FAILED_JOIN_SRC = 4,
4823 RELAY_ERROR_FAILED_JOIN_DEST = 5,
4826 RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6,
4829 RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7,
4834 RELAY_ERROR_SERVER_CONNECTION_LOST = 8,
4837 RELAY_ERROR_INTERNAL_ERROR = 9,
4840 RELAY_ERROR_SRC_TOKEN_EXPIRED = 10,
4843 RELAY_ERROR_DEST_TOKEN_EXPIRED = 11,
4847 enum CHANNEL_MEDIA_RELAY_EVENT {
4851 RELAY_EVENT_NETWORK_DISCONNECTED = 0,
4854 RELAY_EVENT_NETWORK_CONNECTED = 1,
4857 RELAY_EVENT_PACKET_JOINED_SRC_CHANNEL = 2,
4860 RELAY_EVENT_PACKET_JOINED_DEST_CHANNEL = 3,
4863 RELAY_EVENT_PACKET_SENT_TO_DEST_CHANNEL = 4,
4866 RELAY_EVENT_PACKET_RECEIVED_VIDEO_FROM_SRC = 5,
4869 RELAY_EVENT_PACKET_RECEIVED_AUDIO_FROM_SRC = 6,
4872 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL = 7,
4875 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_REFUSED = 8,
4879 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_NOT_CHANGE = 9,
4882 RELAY_EVENT_PACKET_UPDATE_DEST_CHANNEL_IS_NULL = 10,
4885 RELAY_EVENT_VIDEO_PROFILE_UPDATE = 11,
4888 RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS = 12,
4891 RELAY_EVENT_PAUSE_SEND_PACKET_TO_DEST_CHANNEL_FAILED = 13,
4894 RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_SUCCESS = 14,
4897 RELAY_EVENT_RESUME_SEND_PACKET_TO_DEST_CHANNEL_FAILED = 15,
4900 enum CHANNEL_MEDIA_RELAY_STATE {
4903 RELAY_STATE_IDLE = 0,
4906 RELAY_STATE_CONNECTING = 1,
4910 RELAY_STATE_RUNNING = 2,
4913 RELAY_STATE_FAILURE = 3,
5007 :
uid(OPTIONAL_NULLPTR),
5013 if (
this == &rhs)
return *
this;
5014 uid = OPTIONAL_NULLPTR;
5018 if (rhs.
uid != OPTIONAL_NULLPTR) {
5019 char* temp =
new char[strlen(rhs.
uid) + 1];
5020 strcpy(temp, rhs.
uid);
5026 ~PeerDownlinkInfo() {
5027 if (
uid) {
delete []
uid; }
5071 DownlinkNetworkInfo& operator=(
const DownlinkNetworkInfo& rhs) {
5072 if (
this == &rhs)
return *
this;
5086 ~DownlinkNetworkInfo() {
5093 enum ENCRYPTION_MODE {
5135 uint8_t encryptionKdfSalt[32];
5141 memset(encryptionKdfSalt, 0,
sizeof(encryptionKdfSalt));
5145 const char* getEncryptionString()
const {
5148 return "aes-128-xts";
5150 return "aes-128-ecb";
5152 return "aes-256-xts";
5154 return "sm4-128-ecb";
5156 return "aes-128-gcm";
5158 return "aes-256-gcm";
5160 return "aes-128-gcm-2";
5162 return "aes-256-gcm-2";
5164 return "aes-128-gcm-2";
5166 return "aes-128-gcm-2";
5173 enum ENCRYPTION_ERROR_TYPE {
5174 ENCRYPTION_ERROR_INTERNAL_FAILURE = 0,
5175 ENCRYPTION_ERROR_DECRYPTION_FAILURE = 1,
5176 ENCRYPTION_ERROR_ENCRYPTION_FAILURE = 2,
5179 enum UPLOAD_ERROR_REASON
5182 UPLOAD_NET_ERROR = 1,
5183 UPLOAD_SERVER_ERROR = 2,
5188 enum PERMISSION_TYPE {
5196 enum MAX_USER_ACCOUNT_LENGTH_TYPE
5200 MAX_USER_ACCOUNT_LENGTH = 256
5206 enum STREAM_SUBSCRIBE_STATE {
5208 SUB_STATE_NO_SUBSCRIBED = 1,
5209 SUB_STATE_SUBSCRIBING = 2,
5210 SUB_STATE_SUBSCRIBED = 3
5216 enum STREAM_PUBLISH_STATE {
5218 PUB_STATE_NO_PUBLISHED = 1,
5219 PUB_STATE_PUBLISHING = 2,
5220 PUB_STATE_PUBLISHED = 3
5231 const char* channelId;
5234 : view(v), enableAudio(ea), enableVideo(ev), token(t), channelId(c) {}
5237 : view(OPTIONAL_NULLPTR), enableAudio(
true), enableVideo(
true), token(OPTIONAL_NULLPTR), channelId(OPTIONAL_NULLPTR) {}
5261 enum EAR_MONITORING_FILTER_TYPE {
5265 EAR_MONITORING_FILTER_NONE = (1<<0),
5269 EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1<<1),
5273 EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1<<2)
5279 enum THREAD_PRIORITY_TYPE {
5306 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
5311 struct ScreenVideoParameters {
5338 VideoDimensions dimensions;
5353 VIDEO_CONTENT_HINT contentHint = VIDEO_CONTENT_HINT::CONTENT_HINT_MOTION;
5355 ScreenVideoParameters() : dimensions(1280, 720) {}
5361 struct ScreenAudioParameters {
5365 int sampleRate = 16000;
5374 int captureSignalVolume = 100;
5380 struct ScreenCaptureParameters2 {
5390 bool captureAudio =
false;
5394 ScreenAudioParameters audioParams;
5404 bool captureVideo =
true;
5408 ScreenVideoParameters videoParams;
5418 virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid,
void** inter) = 0;
5431 if (engine && !engine->queryInterface(rtc::AGORA_IID_PARAMETER_ENGINE, (
void**)&p)) reset(p);
5439 virtual void onCertificateRequired() = 0;
5440 virtual void onLicenseRequest() = 0;
5441 virtual void onLicenseValidated() = 0;
5442 virtual void onLicenseError(
int result) = 0;
5492 AGORA_API
const char* AGORA_CALL getAgoraSdkVersion(
int* build);
5499 AGORA_API
const char* AGORA_CALL getAgoraSdkErrorDescription(
int err);
5501 AGORA_API
int AGORA_CALL setAgoraSdkExternalSymbolLoader(
void* (*func)(
const char* symname));
5525 AGORA_API
int AGORA_CALL getAgoraCertificateVerifyResult(
const char *credential_buf,
int credential_len,
5526 const char *certificate_buf,
int certificate_len);
5569 AGORA_API int64_t AGORA_CALL getAgoraCurrentMonotonicTimeInMs();