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)
36 #define AGORA_CPP_API __declspec(dllexport)
38 #define AGORA_API extern "C" __declspec(dllimport)
39 #define AGORA_CPP_API __declspec(dllimport)
40 #endif // AGORARTC_EXPORT
42 #define AGORA_CALL __cdecl
46 #elif defined(__APPLE__)
48 #include <TargetConditionals.h>
50 #define AGORA_API extern "C" __attribute__((visibility("default")))
51 #define AGORA_CPP_API __attribute__((visibility("default")))
54 #elif defined(__ANDROID__) || defined(__linux__)
56 #define AGORA_API extern "C" __attribute__((visibility("default")))
57 #define AGORA_CPP_API __attribute__((visibility("default")))
62 #else // !_WIN32 && !__APPLE__ && !(__ANDROID__ || __linux__)
64 #define AGORA_API extern "C"
72 #ifndef OPTIONAL_ENUM_SIZE_T
73 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
74 #define OPTIONAL_ENUM_SIZE_T enum : size_t
76 #define OPTIONAL_ENUM_SIZE_T enum
80 #ifndef OPTIONAL_NULLPTR
81 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
82 #define OPTIONAL_NULLPTR nullptr
84 #define OPTIONAL_NULLPTR NULL
88 #define INVALID_DISPLAY_ID (-2)
97 typedef T* pointer_type;
100 explicit AutoPtr(pointer_type p = OPTIONAL_NULLPTR) : ptr_(p) {}
105 ptr_ = OPTIONAL_NULLPTR;
109 operator bool()
const {
return (ptr_ != OPTIONAL_NULLPTR); }
111 value_type& operator*()
const {
return *get(); }
113 pointer_type operator->()
const {
return get(); }
115 pointer_type get()
const {
return ptr_; }
117 pointer_type release() {
118 pointer_type ret = ptr_;
123 void reset(pointer_type ptr = OPTIONAL_NULLPTR) {
124 if (ptr != ptr_ && ptr_) {
131 template <
class C1,
class C2>
132 bool queryInterface(C1* c, C2 iid) {
133 pointer_type p = OPTIONAL_NULLPTR;
134 if (c && !c->queryInterface(iid,
reinterpret_cast<void**
>(&p))) {
138 return (p != OPTIONAL_NULLPTR);
151 typedef typename AutoPtr<T>::pointer_type pointer_type;
157 if (
this != &rhs) this->reset(rhs.clone());
160 pointer_type clone()
const {
161 if (!this->get())
return OPTIONAL_NULLPTR;
162 return this->get()->clone();
168 virtual bool empty()
const = 0;
169 virtual const char* c_str() = 0;
170 virtual const char* data() = 0;
171 virtual size_t length() = 0;
173 virtual void release() = 0;
180 virtual void* current() = 0;
181 virtual const void* const_current()
const = 0;
182 virtual bool next() = 0;
183 virtual void release() = 0;
190 virtual size_t size()
const = 0;
191 virtual void release() = 0;
200 typedef T value_type;
201 typedef value_type& reference;
202 typedef const value_type& const_reference;
203 typedef value_type* pointer;
204 typedef const value_type* const_pointer;
216 return p->current() == rhs.p->current();
218 return valid() == rhs.valid();
220 bool operator!=(
const AOutputIterator& rhs)
const {
return !this->operator==(rhs); }
221 reference operator*() {
return *
reinterpret_cast<pointer
>(p->current()); }
222 const_reference operator*()
const {
return *
reinterpret_cast<const_pointer
>(p->const_current()); }
223 bool valid()
const {
return p && p->current() != OPTIONAL_NULLPTR; }
232 typedef T value_type;
233 typedef value_type& reference;
234 typedef const value_type& const_reference;
235 typedef value_type* pointer;
236 typedef const value_type* const_pointer;
237 typedef size_t size_type;
242 AList() : container(OPTIONAL_NULLPTR), owner(
false) {}
243 AList(
IContainer* c,
bool take_ownership) : container(c), owner(take_ownership) {}
244 ~
AList() { reset(); }
245 void reset(
IContainer* c = OPTIONAL_NULLPTR,
bool take_ownership =
false) {
246 if (owner && container) container->release();
248 owner = take_ownership;
252 size_type size()
const {
return container ? container->size() : 0; }
253 bool empty()
const {
return size() == 0; }
261 enum CHANNEL_PROFILE_TYPE {
267 CHANNEL_PROFILE_COMMUNICATION = 0,
273 CHANNEL_PROFILE_LIVE_BROADCASTING = 1,
278 CHANNEL_PROFILE_GAME __deprecated = 2,
284 CHANNEL_PROFILE_CLOUD_GAMING __deprecated = 3,
290 CHANNEL_PROFILE_COMMUNICATION_1v1 __deprecated = 4,
296 enum WARN_CODE_TYPE {
301 WARN_INVALID_VIEW = 8,
306 WARN_INIT_VIDEO = 16,
316 WARN_NO_AVAILABLE_CHANNEL = 103,
322 WARN_LOOKUP_CHANNEL_TIMEOUT = 104,
327 WARN_LOOKUP_CHANNEL_REJECTED = 105,
333 WARN_OPEN_CHANNEL_TIMEOUT = 106,
338 WARN_OPEN_CHANNEL_REJECTED = 107,
344 WARN_SWITCH_LIVE_VIDEO_TIMEOUT = 111,
348 WARN_SET_CLIENT_ROLE_TIMEOUT = 118,
352 WARN_OPEN_CHANNEL_INVALID_TICKET = 121,
356 WARN_OPEN_CHANNEL_TRY_NEXT_VOS = 122,
360 WARN_CHANNEL_CONNECTION_UNRECOVERABLE = 131,
364 WARN_CHANNEL_CONNECTION_IP_CHANGED = 132,
368 WARN_CHANNEL_CONNECTION_PORT_CHANGED = 133,
371 WARN_CHANNEL_SOCKET_ERROR = 134,
375 WARN_AUDIO_MIXING_OPEN_ERROR = 701,
379 WARN_ADM_RUNTIME_PLAYOUT_WARNING = 1014,
383 WARN_ADM_RUNTIME_RECORDING_WARNING = 1016,
387 WARN_ADM_RECORD_AUDIO_SILENCE = 1019,
391 WARN_ADM_PLAYOUT_MALFUNCTION = 1020,
395 WARN_ADM_RECORD_MALFUNCTION = 1021,
399 WARN_ADM_RECORD_AUDIO_LOWLEVEL = 1031,
403 WARN_ADM_PLAYOUT_AUDIO_LOWLEVEL = 1032,
411 WARN_ADM_WINDOWS_NO_DATA_READY_EVENT = 1040,
415 WARN_APM_HOWLING = 1051,
419 WARN_ADM_GLITCH_STATE = 1052,
423 WARN_ADM_IMPROPER_SETTINGS = 1053,
427 WARN_ADM_WIN_CORE_NO_RECORDING_DEVICE = 1322,
432 WARN_ADM_WIN_CORE_NO_PLAYOUT_DEVICE = 1323,
440 WARN_ADM_WIN_CORE_IMPROPER_CAPTURE_RELEASE = 1324,
446 enum ERROR_CODE_TYPE {
460 ERR_INVALID_ARGUMENT = 2,
471 ERR_NOT_SUPPORTED = 4,
479 ERR_BUFFER_TOO_SMALL = 6,
483 ERR_NOT_INITIALIZED = 7,
487 ERR_INVALID_STATE = 8,
492 ERR_NO_PERMISSION = 9,
515 ERR_BIND_SOCKET = 13,
526 ERR_JOIN_CHANNEL_REJECTED = 17,
533 ERR_LEAVE_CHANNEL_REJECTED = 18,
537 ERR_ALREADY_IN_USE = 19,
547 ERR_INIT_NET_ENGINE = 21,
552 ERR_RESOURCE_LIMITED = 22,
558 ERR_INVALID_APP_ID = 101,
563 ERR_INVALID_CHANNEL_NAME = 102,
569 ERR_NO_SERVER_RESOURCES = 103,
582 ERR_TOKEN_EXPIRED = 109,
599 ERR_INVALID_TOKEN = 110,
604 ERR_CONNECTION_INTERRUPTED = 111,
609 ERR_CONNECTION_LOST = 112,
614 ERR_NOT_IN_CHANNEL = 113,
619 ERR_SIZE_TOO_LARGE = 114,
624 ERR_BITRATE_LIMIT = 115,
629 ERR_TOO_MANY_DATA_STREAMS = 116,
633 ERR_STREAM_MESSAGE_TIMEOUT = 117,
637 ERR_SET_CLIENT_ROLE_NOT_AUTHORIZED = 119,
642 ERR_DECRYPTION_FAILED = 120,
646 ERR_INVALID_USER_ID = 121,
651 ERR_DATASTREAM_DECRYPTION_FAILED = 122,
655 ERR_CLIENT_IS_BANNED_BY_SERVER = 123,
661 ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130,
666 ERR_LICENSE_CREDENTIAL_INVALID = 131,
671 ERR_INVALID_USER_ACCOUNT = 134,
678 ERR_MODULE_NOT_FOUND = 157,
682 ERR_CERT_JSON_PART = 158,
683 ERR_CERT_JSON_INVAL = 159,
684 ERR_CERT_JSON_NOMEM = 160,
685 ERR_CERT_CUSTOM = 161,
686 ERR_CERT_CREDENTIAL = 162,
691 ERR_CERT_DUEDATE = 167,
692 ERR_CERT_REQUEST = 168,
695 ERR_PCMSEND_FORMAT = 200,
696 ERR_PCMSEND_BUFFEROVERFLOW = 201,
700 ERR_LOGIN_ALREADY_LOGIN = 428,
707 ERR_LOAD_MEDIA_ENGINE = 1001,
713 ERR_ADM_GENERAL_ERROR = 1005,
718 ERR_ADM_INIT_PLAYOUT = 1008,
722 ERR_ADM_START_PLAYOUT = 1009,
726 ERR_ADM_STOP_PLAYOUT = 1010,
731 ERR_ADM_INIT_RECORDING = 1011,
735 ERR_ADM_START_RECORDING = 1012,
739 ERR_ADM_STOP_RECORDING = 1013,
743 ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501,
746 enum LICENSE_ERROR_TYPE {
750 LICENSE_ERR_INVALID = 1,
754 LICENSE_ERR_EXPIRE = 2,
758 LICENSE_ERR_MINUTES_EXCEED = 3,
762 LICENSE_ERR_LIMITED_PERIOD = 4,
766 LICENSE_ERR_DIFF_DEVICES = 5,
770 LICENSE_ERR_INTERNAL = 99,
776 enum AUDIO_SESSION_OPERATION_RESTRICTION {
780 AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0,
784 AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1,
788 AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1,
793 AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2,
798 AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7,
801 typedef const char* user_id_t;
802 typedef void* view_t;
828 typedef util::AList<UserInfo> UserList;
836 enum USER_OFFLINE_REASON_TYPE {
840 USER_OFFLINE_QUIT = 0,
846 USER_OFFLINE_DROPPED = 1,
850 USER_OFFLINE_BECOME_AUDIENCE = 2,
853 enum INTERFACE_ID_TYPE {
854 AGORA_IID_AUDIO_DEVICE_MANAGER = 1,
855 AGORA_IID_VIDEO_DEVICE_MANAGER = 2,
856 AGORA_IID_PARAMETER_ENGINE = 3,
857 AGORA_IID_MEDIA_ENGINE = 4,
858 AGORA_IID_AUDIO_ENGINE = 5,
859 AGORA_IID_VIDEO_ENGINE = 6,
860 AGORA_IID_RTC_CONNECTION = 7,
861 AGORA_IID_SIGNALING_ENGINE = 8,
862 AGORA_IID_MEDIA_ENGINE_REGULATOR = 9,
863 AGORA_IID_LOCAL_SPATIAL_AUDIO = 11,
864 AGORA_IID_STATE_SYNC = 13,
865 AGORA_IID_META_SERVICE = 14,
866 AGORA_IID_MUSIC_CONTENT_CENTER = 15,
867 AGORA_IID_H265_TRANSCODER = 16,
878 QUALITY_UNKNOWN __deprecated = 0,
882 QUALITY_EXCELLENT = 1,
907 QUALITY_UNSUPPORTED = 7,
911 QUALITY_DETECTING = 8,
935 enum VIDEO_ORIENTATION {
939 VIDEO_ORIENTATION_0 = 0,
943 VIDEO_ORIENTATION_90 = 90,
947 VIDEO_ORIENTATION_180 = 180,
951 VIDEO_ORIENTATION_270 = 270
961 FRAME_RATE_FPS_1 = 1,
965 FRAME_RATE_FPS_7 = 7,
969 FRAME_RATE_FPS_10 = 10,
973 FRAME_RATE_FPS_15 = 15,
977 FRAME_RATE_FPS_24 = 24,
981 FRAME_RATE_FPS_30 = 30,
985 FRAME_RATE_FPS_60 = 60,
989 FRAME_WIDTH_960 = 960,
993 FRAME_HEIGHT_540 = 540,
1000 enum VIDEO_FRAME_TYPE {
1002 VIDEO_FRAME_TYPE_BLANK_FRAME = 0,
1004 VIDEO_FRAME_TYPE_KEY_FRAME = 3,
1006 VIDEO_FRAME_TYPE_DELTA_FRAME = 4,
1008 VIDEO_FRAME_TYPE_B_FRAME = 5,
1010 VIDEO_FRAME_TYPE_DROPPABLE_FRAME = 6,
1012 VIDEO_FRAME_TYPE_UNKNOW
1018 enum ORIENTATION_MODE {
1026 ORIENTATION_MODE_ADAPTIVE = 0,
1033 ORIENTATION_MODE_FIXED_LANDSCAPE = 1,
1040 ORIENTATION_MODE_FIXED_PORTRAIT = 2,
1046 enum DEGRADATION_PREFERENCE {
1054 MAINTAIN_QUALITY = 0,
1060 MAINTAIN_FRAMERATE = 1,
1067 MAINTAIN_BALANCED = 2,
1071 MAINTAIN_RESOLUTION = 3,
1092 bool operator==(
const VideoDimensions& rhs)
const {
1093 return width == rhs.width &&
height == rhs.height;
1102 const int STANDARD_BITRATE = 0;
1111 const int COMPATIBLE_BITRATE = -1;
1116 const int DEFAULT_MIN_BITRATE = -1;
1121 const int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
1126 enum SCREEN_CAPTURE_FRAMERATE_CAPABILITY {
1127 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS = 0,
1128 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS = 1,
1129 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS = 2,
1135 enum VIDEO_CODEC_CAPABILITY_LEVEL {
1137 CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1,
1139 CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT = 5,
1141 CODEC_CAPABILITY_LEVEL_1080P30FPS = 10,
1143 CODEC_CAPABILITY_LEVEL_1080P60FPS = 20,
1145 CODEC_CAPABILITY_LEVEL_4K60FPS = 30,
1151 enum VIDEO_CODEC_TYPE {
1152 VIDEO_CODEC_NONE = 0,
1156 VIDEO_CODEC_VP8 = 1,
1160 VIDEO_CODEC_H264 = 2,
1164 VIDEO_CODEC_H265 = 3,
1169 VIDEO_CODEC_GENERIC = 6,
1173 VIDEO_CODEC_GENERIC_H264 = 7,
1178 VIDEO_CODEC_AV1 = 12,
1182 VIDEO_CODEC_VP9 = 13,
1186 VIDEO_CODEC_GENERIC_JPEG = 20,
1192 enum CAMERA_FOCAL_LENGTH_TYPE {
1196 CAMERA_FOCAL_LENGTH_DEFAULT = 0,
1200 CAMERA_FOCAL_LENGTH_WIDE_ANGLE = 1,
1204 CAMERA_FOCAL_LENGTH_ULTRA_WIDE = 2,
1208 CAMERA_FOCAL_LENGTH_TELEPHOTO = 3,
1305 enum AUDIO_CODEC_TYPE {
1309 AUDIO_CODEC_OPUS = 1,
1314 AUDIO_CODEC_PCMA = 3,
1318 AUDIO_CODEC_PCMU = 4,
1322 AUDIO_CODEC_G722 = 5,
1329 AUDIO_CODEC_AACLC = 8,
1333 AUDIO_CODEC_HEAAC = 9,
1337 AUDIO_CODEC_JC1 = 10,
1341 AUDIO_CODEC_HEAAC2 = 11,
1345 AUDIO_CODEC_LPCNET = 12,
1351 enum AUDIO_ENCODING_TYPE {
1356 AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101,
1361 AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102,
1366 AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201,
1371 AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202,
1376 AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203,
1381 AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302,
1386 AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303,
1391 AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101,
1396 AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102,
1401 AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302,
1406 AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303,
1412 enum WATERMARK_FIT_MODE {
1417 FIT_MODE_COVER_POSITION,
1422 FIT_MODE_USE_IMAGE_RATIO
1452 :
codec(AUDIO_CODEC_AACLC),
1501 channelNum(rhs.channelNum),
1530 enum H264PacketizeMode {
1544 enum VIDEO_STREAM_TYPE {
1548 VIDEO_STREAM_HIGH = 0,
1552 VIDEO_STREAM_LOW = 1,
1556 VIDEO_STREAM_LAYER_1 = 4,
1560 VIDEO_STREAM_LAYER_2 = 5,
1564 VIDEO_STREAM_LAYER_3 = 6,
1568 VIDEO_STREAM_LAYER_4 = 7,
1572 VIDEO_STREAM_LAYER_5 = 8,
1576 VIDEO_STREAM_LAYER_6 = 9,
1601 enum MAX_USER_ACCOUNT_LENGTH_TYPE
1605 MAX_USER_ACCOUNT_LENGTH = 256
1618 frameType(VIDEO_FRAME_TYPE_BLANK_FRAME),
1624 presentationMs(-1) {}
1638 presentationMs(rhs.presentationMs) {}
1641 if (
this == &rhs)
return *
this;
1653 presentationMs = rhs.presentationMs;
1706 int64_t presentationMs;
1712 enum COMPRESSION_PREFERENCE {
1726 enum ENCODING_PREFERENCE {
1734 PREFER_SOFTWARE = 0,
1738 PREFER_HARDWARE = 1,
1760 COMPRESSION_PREFERENCE compression_preference) :
1764 bool operator==(
const AdvanceOptions& rhs)
const {
1774 enum VIDEO_MIRROR_MODE_TYPE {
1778 VIDEO_MIRROR_MODE_AUTO = 0,
1782 VIDEO_MIRROR_MODE_ENABLED = 1,
1786 VIDEO_MIRROR_MODE_DISABLED = 2,
1789 #if defined(__APPLE__) && TARGET_OS_IOS
1793 enum CAMERA_FORMAT_TYPE {
1802 enum CODEC_CAP_MASK {
1804 CODEC_CAP_MASK_NONE = 0,
1807 CODEC_CAP_MASK_HW_DEC = 1 << 0,
1810 CODEC_CAP_MASK_HW_ENC = 1 << 1,
1813 CODEC_CAP_MASK_SW_DEC = 1 << 2,
1816 CODEC_CAP_MASK_SW_ENC = 1 << 3,
1820 VIDEO_CODEC_CAPABILITY_LEVEL hwDecodingLevel;
1821 VIDEO_CODEC_CAPABILITY_LEVEL swDecodingLevel;
1823 CodecCapLevels(): hwDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED), swDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED) {}
1966 VideoEncoderConfiguration(
int width,
int height,
int f,
int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror = VIDEO_MIRROR_MODE_DISABLED)
1976 VideoEncoderConfiguration(
const VideoEncoderConfiguration& config)
1986 VideoEncoderConfiguration()
1988 dimensions(FRAME_WIDTH_960, FRAME_HEIGHT_540),
1997 VideoEncoderConfiguration& operator=(
const VideoEncoderConfiguration& rhs) {
1998 if (
this == &rhs)
return *
this;
2041 enum SIMULCAST_STREAM_MODE {
2045 AUTO_SIMULCAST_STREAM = -1,
2049 DISABLE_SIMULCAST_STREAM = 0,
2053 ENABLE_SIMULCAST_STREAM = 1,
2074 bool operator==(
const SimulcastStreamConfig& rhs)
const {
2233 mode(FIT_MODE_COVER_POSITION) {}
2435 enum CLIENT_ROLE_TYPE {
2439 CLIENT_ROLE_BROADCASTER = 1,
2443 CLIENT_ROLE_AUDIENCE = 2,
2449 enum QUALITY_ADAPT_INDICATION {
2457 ADAPT_UP_BANDWIDTH = 1,
2461 ADAPT_DOWN_BANDWIDTH = 2,
2468 enum AUDIENCE_LATENCY_LEVEL_TYPE
2473 AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1,
2477 AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2,
2497 enum EXPERIENCE_QUALITY_TYPE {
2499 EXPERIENCE_QUALITY_GOOD = 0,
2501 EXPERIENCE_QUALITY_BAD = 1,
2507 enum EXPERIENCE_POOR_REASON {
2511 EXPERIENCE_REASON_NONE = 0,
2515 REMOTE_NETWORK_QUALITY_POOR = 1,
2519 LOCAL_NETWORK_QUALITY_POOR = 2,
2523 WIRELESS_SIGNAL_POOR = 4,
2528 WIFI_BLUETOOTH_COEXIST = 8,
2534 enum AUDIO_AINS_MODE {
2538 AINS_MODE_BALANCED = 0,
2542 AINS_MODE_AGGRESSIVE = 1,
2546 AINS_MODE_ULTRALOWLATENCY = 2
2552 enum AUDIO_PROFILE_TYPE {
2561 AUDIO_PROFILE_DEFAULT = 0,
2565 AUDIO_PROFILE_SPEECH_STANDARD = 1,
2569 AUDIO_PROFILE_MUSIC_STANDARD = 2,
2576 AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3,
2580 AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4,
2587 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5,
2591 AUDIO_PROFILE_IOT = 6,
2592 AUDIO_PROFILE_NUM = 7
2598 enum AUDIO_SCENARIO_TYPE {
2603 AUDIO_SCENARIO_DEFAULT = 0,
2609 AUDIO_SCENARIO_GAME_STREAMING = 3,
2615 AUDIO_SCENARIO_CHATROOM = 5,
2619 AUDIO_SCENARIO_CHORUS = 7,
2623 AUDIO_SCENARIO_MEETING = 8,
2627 AUDIO_SCENARIO_NUM = 9,
2634 OPTIONAL_ENUM_SIZE_T {
2636 kMaxWidthInPixels = 3840,
2638 kMaxHeightInPixels = 2160,
2658 bool operator<(
const VideoFormat& fmt)
const {
2659 if (
height != fmt.height) {
2660 return height < fmt.height;
2661 }
else if (
width != fmt.width) {
2662 return width < fmt.width;
2664 return fps < fmt.fps;
2667 bool operator==(
const VideoFormat& fmt)
const {
2668 return width == fmt.width &&
height == fmt.height &&
fps == fmt.fps;
2670 bool operator!=(
const VideoFormat& fmt)
const {
2671 return !operator==(fmt);
2678 enum VIDEO_CONTENT_HINT {
2689 CONTENT_HINT_MOTION,
2695 CONTENT_HINT_DETAILS
2700 enum SCREEN_SCENARIO_TYPE {
2706 SCREEN_SCENARIO_DOCUMENT = 1,
2711 SCREEN_SCENARIO_GAMING = 2,
2716 SCREEN_SCENARIO_VIDEO = 3,
2722 SCREEN_SCENARIO_RDC = 4,
2729 enum VIDEO_APPLICATION_SCENARIO_TYPE {
2733 APPLICATION_SCENARIO_GENERAL = 0,
2737 APPLICATION_SCENARIO_MEETING = 1,
2743 enum VIDEO_QOE_PREFERENCE_TYPE {
2747 VIDEO_QOE_PREFERENCE_BALANCE = 1,
2751 VIDEO_QOE_PREFERENCE_DELAY_FIRST = 2,
2755 VIDEO_QOE_PREFERENCE_PICTURE_QUALITY_FIRST = 3,
2759 VIDEO_QOE_PREFERENCE_FLUENCY_FIRST = 4,
2766 enum CAPTURE_BRIGHTNESS_LEVEL_TYPE {
2770 CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1,
2773 CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0,
2776 CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1,
2779 CAPTURE_BRIGHTNESS_LEVEL_DARK = 2,
2782 enum CAMERA_STABILIZATION_MODE {
2785 CAMERA_STABILIZATION_MODE_OFF = -1,
2788 CAMERA_STABILIZATION_MODE_AUTO = 0,
2791 CAMERA_STABILIZATION_MODE_LEVEL_1 = 1,
2794 CAMERA_STABILIZATION_MODE_LEVEL_2 = 2,
2797 CAMERA_STABILIZATION_MODE_LEVEL_3 = 3,
2800 CAMERA_STABILIZATION_MODE_MAX_LEVEL = CAMERA_STABILIZATION_MODE_LEVEL_3,
2806 enum LOCAL_AUDIO_STREAM_STATE {
2810 LOCAL_AUDIO_STREAM_STATE_STOPPED = 0,
2814 LOCAL_AUDIO_STREAM_STATE_RECORDING = 1,
2818 LOCAL_AUDIO_STREAM_STATE_ENCODING = 2,
2822 LOCAL_AUDIO_STREAM_STATE_FAILED = 3
2828 enum LOCAL_AUDIO_STREAM_REASON {
2832 LOCAL_AUDIO_STREAM_REASON_OK = 0,
2836 LOCAL_AUDIO_STREAM_REASON_FAILURE = 1,
2840 LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
2847 LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY = 3,
2851 LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE = 4,
2855 LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE = 5,
2858 LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE = 6,
2861 LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE = 7,
2865 LOCAL_AUDIO_STREAM_REASON_INTERRUPTED = 8,
2868 LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID = 9,
2871 LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID = 10,
2876 enum LOCAL_VIDEO_STREAM_STATE {
2880 LOCAL_VIDEO_STREAM_STATE_STOPPED = 0,
2885 LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1,
2889 LOCAL_VIDEO_STREAM_STATE_ENCODING = 2,
2893 LOCAL_VIDEO_STREAM_STATE_FAILED = 3
2899 enum LOCAL_VIDEO_STREAM_REASON {
2903 LOCAL_VIDEO_STREAM_REASON_OK = 0,
2907 LOCAL_VIDEO_STREAM_REASON_FAILURE = 1,
2912 LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
2917 LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY = 3,
2923 LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE = 4,
2927 LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT = 5,
2932 LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND = 6,
2939 LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7,
2945 LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND = 8,
2950 LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED = 9,
2955 LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID = 10,
2960 LOCAL_VIDEO_STREAM_REASON_DEVICE_INTERRUPT = 14,
2965 LOCAL_VIDEO_STREAM_REASON_DEVICE_FATAL_ERROR = 15,
2969 LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE = 101,
2975 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11,
2990 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED = 12,
2992 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED = 13,
2994 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20,
2996 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE = 21,
2998 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION = 22,
3004 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK = 24,
3006 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN = 25,
3008 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN = 26,
3010 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED = 27,
3018 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED = 28,
3020 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED = 29,
3022 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_DISPLAY_DISCONNECTED = 30,
3029 enum REMOTE_AUDIO_STATE
3036 REMOTE_AUDIO_STATE_STOPPED = 0,
3040 REMOTE_AUDIO_STATE_STARTING = 1,
3046 REMOTE_AUDIO_STATE_DECODING = 2,
3051 REMOTE_AUDIO_STATE_FROZEN = 3,
3056 REMOTE_AUDIO_STATE_FAILED = 4,
3062 enum REMOTE_AUDIO_STATE_REASON
3067 REMOTE_AUDIO_REASON_INTERNAL = 0,
3071 REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1,
3075 REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2,
3080 REMOTE_AUDIO_REASON_LOCAL_MUTED = 3,
3085 REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4,
3090 REMOTE_AUDIO_REASON_REMOTE_MUTED = 5,
3095 REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6,
3099 REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7,
3103 REMOTE_AUDIO_REASON_NO_PACKET_RECEIVE = 8,
3107 REMOTE_AUDIO_REASON_LOCAL_PLAY_FAILED = 9,
3113 enum REMOTE_VIDEO_STATE {
3119 REMOTE_VIDEO_STATE_STOPPED = 0,
3123 REMOTE_VIDEO_STATE_STARTING = 1,
3129 REMOTE_VIDEO_STATE_DECODING = 2,
3133 REMOTE_VIDEO_STATE_FROZEN = 3,
3137 REMOTE_VIDEO_STATE_FAILED = 4,
3142 enum REMOTE_VIDEO_STATE_REASON {
3146 REMOTE_VIDEO_STATE_REASON_INTERNAL = 0,
3150 REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1,
3154 REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2,
3158 REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3,
3162 REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4,
3166 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5,
3170 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6,
3174 REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7,
3178 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8,
3182 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9,
3185 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_LOW = 10,
3188 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_HIGH = 11,
3191 REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND = 12,
3195 REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT = 13,
3202 enum REMOTE_USER_STATE {
3206 USER_STATE_MUTE_AUDIO = (1 << 0),
3210 USER_STATE_MUTE_VIDEO = (1 << 1),
3214 USER_STATE_ENABLE_VIDEO = (1 << 4),
3218 USER_STATE_ENABLE_LOCAL_VIDEO = (1 << 8),
3272 enum REMOTE_VIDEO_DOWNSCALE_LEVEL {
3276 REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE,
3280 REMOTE_VIDEO_DOWNSCALE_LEVEL_1,
3284 REMOTE_VIDEO_DOWNSCALE_LEVEL_2,
3288 REMOTE_VIDEO_DOWNSCALE_LEVEL_3,
3292 REMOTE_VIDEO_DOWNSCALE_LEVEL_4,
3341 bool isLowLatencyAudioSupported;
3343 DeviceInfo() : isLowLatencyAudioSupported(
false) {}
3406 enum AUDIO_SAMPLE_RATE_TYPE {
3410 AUDIO_SAMPLE_RATE_32000 = 32000,
3414 AUDIO_SAMPLE_RATE_44100 = 44100,
3418 AUDIO_SAMPLE_RATE_48000 = 48000,
3423 enum VIDEO_CODEC_TYPE_FOR_STREAM {
3427 VIDEO_CODEC_H264_FOR_STREAM = 1,
3431 VIDEO_CODEC_H265_FOR_STREAM = 2,
3437 enum VIDEO_CODEC_PROFILE_TYPE {
3441 VIDEO_CODEC_PROFILE_BASELINE = 66,
3445 VIDEO_CODEC_PROFILE_MAIN = 77,
3449 VIDEO_CODEC_PROFILE_HIGH = 100,
3456 enum AUDIO_CODEC_PROFILE_TYPE {
3460 AUDIO_CODEC_PROFILE_LC_AAC = 0,
3464 AUDIO_CODEC_PROFILE_HE_AAC = 1,
3468 AUDIO_CODEC_PROFILE_HE_AAC_V2 = 2,
3526 enum RTMP_STREAM_PUBLISH_STATE {
3530 RTMP_STREAM_PUBLISH_STATE_IDLE = 0,
3534 RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1,
3538 RTMP_STREAM_PUBLISH_STATE_RUNNING = 2,
3544 RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3,
3548 RTMP_STREAM_PUBLISH_STATE_FAILURE = 4,
3552 RTMP_STREAM_PUBLISH_STATE_DISCONNECTING = 5,
3558 enum RTMP_STREAM_PUBLISH_REASON {
3562 RTMP_STREAM_PUBLISH_REASON_OK = 0,
3567 RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT = 1,
3571 RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED = 2,
3575 RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT = 3,
3579 RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR = 4,
3583 RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR = 5,
3587 RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN = 6,
3591 RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT = 7,
3595 RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED = 8,
3599 RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND = 9,
3603 RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED = 10,
3607 RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER = 11,
3611 RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM = 13,
3615 RTMP_STREAM_PUBLISH_REASON_NET_DOWN = 14,
3619 RTMP_STREAM_PUBLISH_REASON_INVALID_APPID = 15,
3621 RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE = 16,
3625 RTMP_STREAM_UNPUBLISH_REASON_OK = 100,
3629 enum RTMP_STREAMING_EVENT {
3633 RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1,
3637 RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2,
3641 RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT = 3,
3645 RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN = 4,
3718 enum CONNECTION_STATE_TYPE
3725 CONNECTION_STATE_DISCONNECTED = 1,
3734 CONNECTION_STATE_CONNECTING = 2,
3742 CONNECTION_STATE_CONNECTED = 3,
3752 CONNECTION_STATE_RECONNECTING = 4,
3761 CONNECTION_STATE_FAILED = 5,
4057 enum VIDEO_TRANSCODER_ERROR {
4061 VT_ERR_VIDEO_SOURCE_NOT_READY = 1,
4065 VT_ERR_INVALID_VIDEO_SOURCE_TYPE = 2,
4069 VT_ERR_INVALID_IMAGE_PATH = 3,
4073 VT_ERR_UNSUPPORT_IMAGE_FORMAT = 4,
4077 VT_ERR_INVALID_LAYOUT = 5,
4081 VT_ERR_INTERNAL = 20
4115 enum LASTMILE_PROBE_RESULT_STATE {
4119 LASTMILE_PROBE_RESULT_COMPLETE = 1,
4123 LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2,
4127 LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
4174 :
state(LASTMILE_PROBE_RESULT_UNAVAILABLE),
4181 enum CONNECTION_CHANGED_REASON_TYPE
4186 CONNECTION_CHANGED_CONNECTING = 0,
4190 CONNECTION_CHANGED_JOIN_SUCCESS = 1,
4194 CONNECTION_CHANGED_INTERRUPTED = 2,
4198 CONNECTION_CHANGED_BANNED_BY_SERVER = 3,
4202 CONNECTION_CHANGED_JOIN_FAILED = 4,
4206 CONNECTION_CHANGED_LEAVE_CHANNEL = 5,
4210 CONNECTION_CHANGED_INVALID_APP_ID = 6,
4214 CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7,
4220 CONNECTION_CHANGED_INVALID_TOKEN = 8,
4224 CONNECTION_CHANGED_TOKEN_EXPIRED = 9,
4230 CONNECTION_CHANGED_REJECTED_BY_SERVER = 10,
4234 CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11,
4238 CONNECTION_CHANGED_RENEW_TOKEN = 12,
4242 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13,
4246 CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14,
4250 CONNECTION_CHANGED_REJOIN_SUCCESS = 15,
4254 CONNECTION_CHANGED_LOST = 16,
4258 CONNECTION_CHANGED_ECHO_TEST = 17,
4262 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER = 18,
4266 CONNECTION_CHANGED_SAME_UID_LOGIN = 19,
4270 CONNECTION_CHANGED_TOO_MANY_BROADCASTERS = 20,
4275 CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE = 21,
4279 CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE = 22,
4283 CONNECTION_CHANGED_STREAM_CHANNEL_NOT_AVAILABLE = 23,
4287 CONNECTION_CHANGED_INCONSISTENT_APPID = 24,
4293 enum CLIENT_ROLE_CHANGE_FAILED_REASON {
4297 CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1,
4301 CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED = 2,
4305 CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT = 3,
4309 CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED = 4,
4315 enum WLACC_MESSAGE_REASON {
4319 WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0,
4323 WLACC_MESSAGE_REASON_CHANNEL_CONGESTION = 1,
4329 enum WLACC_SUGGEST_ACTION {
4333 WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI = 0,
4337 WLACC_SUGGEST_ACTION_CONNECT_SSID = 1,
4341 WLACC_SUGGEST_ACTION_CHECK_5G = 2,
4345 WLACC_SUGGEST_ACTION_MODIFY_SSID = 3,
4373 NETWORK_TYPE_UNKNOWN = -1,
4377 NETWORK_TYPE_DISCONNECTED = 0,
4381 NETWORK_TYPE_LAN = 1,
4385 NETWORK_TYPE_WIFI = 2,
4389 NETWORK_TYPE_MOBILE_2G = 3,
4393 NETWORK_TYPE_MOBILE_3G = 4,
4397 NETWORK_TYPE_MOBILE_4G = 5,
4401 NETWORK_TYPE_MOBILE_5G = 6,
4407 enum VIDEO_VIEW_SETUP_MODE {
4411 VIDEO_VIEW_SETUP_REPLACE = 0,
4415 VIDEO_VIEW_SETUP_ADD = 1,
4419 VIDEO_VIEW_SETUP_REMOVE = 2,
4497 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt)
4502 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
4507 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u, uid_t subu)
4514 PIP_STATE_STARTED = 0,
4515 PIP_STATE_STOPPED = 1,
4516 PIP_STATE_FAILED = 2,
4520 void* contentSource;
4523 #if defined(__APPLE__) && TARGET_OS_IOS
4524 bool autoEnterPip =
false;
4527 PipOptions(): contentSource(NULL), contentWidth(0), contentHeight(0) {}
4744 enum SEG_MODEL_TYPE {
4750 SEG_MODEL_TYPE modelType;
4752 float greenCapacity;
4760 enum AUDIO_TRACK_TYPE {
4764 AUDIO_TRACK_INVALID = -1,
4771 AUDIO_TRACK_MIXABLE = 0,
4777 AUDIO_TRACK_DIRECT = 1,
4783 AUDIO_TRACK_EXTERNAL_AEC_REFERENCE = 3,
4832 enum VOICE_BEAUTIFIER_PRESET {
4835 VOICE_BEAUTIFIER_OFF = 0x00000000,
4841 CHAT_BEAUTIFIER_MAGNETIC = 0x01010100,
4847 CHAT_BEAUTIFIER_FRESH = 0x01010200,
4853 CHAT_BEAUTIFIER_VITALITY = 0x01010300,
4862 SINGING_BEAUTIFIER = 0x01020100,
4865 TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100,
4868 TIMBRE_TRANSFORMATION_DEEP = 0x01030200,
4871 TIMBRE_TRANSFORMATION_MELLOW = 0x01030300,
4874 TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400,
4877 TIMBRE_TRANSFORMATION_FULL = 0x01030500,
4880 TIMBRE_TRANSFORMATION_CLEAR = 0x01030600,
4883 TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700,
4886 TIMBRE_TRANSFORMATION_RINGING = 0x01030800,
4896 ULTRA_HIGH_QUALITY_VOICE = 0x01040100
4919 enum AUDIO_EFFECT_PRESET {
4922 AUDIO_EFFECT_OFF = 0x00000000,
4925 ROOM_ACOUSTICS_KTV = 0x02010100,
4928 ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200,
4931 ROOM_ACOUSTICS_STUDIO = 0x02010300,
4934 ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400,
4941 ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500,
4944 ROOM_ACOUSTICS_SPACIAL = 0x02010600,
4947 ROOM_ACOUSTICS_ETHEREAL = 0x02010700,
4959 ROOM_ACOUSTICS_3D_VOICE = 0x02010800,
4970 ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND = 0x02010900,
4978 ROOM_ACOUSTICS_CHORUS = 0x02010D00,
4985 VOICE_CHANGER_EFFECT_UNCLE = 0x02020100,
4991 VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200,
4997 VOICE_CHANGER_EFFECT_BOY = 0x02020300,
5004 VOICE_CHANGER_EFFECT_SISTER = 0x02020400,
5010 VOICE_CHANGER_EFFECT_GIRL = 0x02020500,
5014 VOICE_CHANGER_EFFECT_PIGKING = 0x02020600,
5017 VOICE_CHANGER_EFFECT_HULK = 0x02020700,
5024 STYLE_TRANSFORMATION_RNB = 0x02030100,
5031 STYLE_TRANSFORMATION_POPULAR = 0x02030200,
5036 PITCH_CORRECTION = 0x02040100,
5045 enum VOICE_CONVERSION_PRESET {
5048 VOICE_CONVERSION_OFF = 0x00000000,
5051 VOICE_CHANGER_NEUTRAL = 0x03010100,
5054 VOICE_CHANGER_SWEET = 0x03010200,
5057 VOICE_CHANGER_SOLID = 0x03010300,
5060 VOICE_CHANGER_BASS = 0x03010400,
5063 VOICE_CHANGER_CARTOON = 0x03010500,
5066 VOICE_CHANGER_CHILDLIKE = 0x03010600,
5069 VOICE_CHANGER_PHONE_OPERATOR = 0x03010700,
5072 VOICE_CHANGER_MONSTER = 0x03010800,
5075 VOICE_CHANGER_TRANSFORMERS = 0x03010900,
5078 VOICE_CHANGER_GROOT = 0x03010A00,
5081 VOICE_CHANGER_DARTH_VADER = 0x03010B00,
5084 VOICE_CHANGER_IRON_LADY = 0x03010C00,
5087 VOICE_CHANGER_SHIN_CHAN = 0x03010D00,
5090 VOICE_CHANGER_GIRLISH_MAN = 0x03010E00,
5093 VOICE_CHANGER_CHIPMUNK = 0x03010F00,
5099 enum HEADPHONE_EQUALIZER_PRESET {
5102 HEADPHONE_EQUALIZER_OFF = 0x00000000,
5105 HEADPHONE_EQUALIZER_OVEREAR = 0x04000001,
5108 HEADPHONE_EQUALIZER_INEAR = 0x04000002
5182 :
dimensions(1920, 1080),
frameRate(5),
bitrate(STANDARD_BITRATE),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
5185 ScreenCaptureParameters(
int width,
int height,
int f,
int b)
5186 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false){}
5187 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs)
5188 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
5189 ScreenCaptureParameters(
int width,
int height,
int f,
int b, view_t *ex,
int cnt)
5190 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
5191 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs, view_t *ex,
int cnt)
5192 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
5198 enum AUDIO_RECORDING_QUALITY_TYPE {
5202 AUDIO_RECORDING_QUALITY_LOW = 0,
5206 AUDIO_RECORDING_QUALITY_MEDIUM = 1,
5210 AUDIO_RECORDING_QUALITY_HIGH = 2,
5214 AUDIO_RECORDING_QUALITY_ULTRA_HIGH = 3,
5220 enum AUDIO_FILE_RECORDING_TYPE {
5224 AUDIO_FILE_RECORDING_MIC = 1,
5228 AUDIO_FILE_RECORDING_PLAYBACK = 2,
5232 AUDIO_FILE_RECORDING_MIXED = 3,
5238 enum AUDIO_ENCODED_FRAME_OBSERVER_POSITION {
5242 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1,
5246 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2,
5250 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3,
5300 quality(AUDIO_RECORDING_QUALITY_LOW),
5311 AudioRecordingConfiguration(
const char* file_path,
bool enc,
int sample_rate, AUDIO_FILE_RECORDING_TYPE type, AUDIO_RECORDING_QUALITY_TYPE quality_type,
int channel)
5319 AudioRecordingConfiguration(
const AudioRecordingConfiguration &rhs)
5342 :
postionType(AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK),
5396 AREA_CODE_CN = 0x00000001,
5400 AREA_CODE_NA = 0x00000002,
5404 AREA_CODE_EU = 0x00000004,
5408 AREA_CODE_AS = 0x00000008,
5412 AREA_CODE_JP = 0x00000010,
5416 AREA_CODE_IN = 0x00000020,
5420 AREA_CODE_GLOB = (0xFFFFFFFF)
5431 AREA_CODE_OC = 0x00000040,
5435 AREA_CODE_SA = 0x00000080,
5439 AREA_CODE_AF = 0x00000100,
5443 AREA_CODE_KR = 0x00000200,
5447 AREA_CODE_HKMC = 0x00000400,
5451 AREA_CODE_US = 0x00000800,
5455 AREA_CODE_RU = 0x00001000,
5459 AREA_CODE_OVS = 0xFFFFFFFE
5465 enum CHANNEL_MEDIA_RELAY_ERROR {
5471 RELAY_ERROR_SERVER_ERROR_RESPONSE = 1,
5477 RELAY_ERROR_SERVER_NO_RESPONSE = 2,
5480 RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3,
5483 RELAY_ERROR_FAILED_JOIN_SRC = 4,
5486 RELAY_ERROR_FAILED_JOIN_DEST = 5,
5489 RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6,
5492 RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7,
5496 RELAY_ERROR_SERVER_CONNECTION_LOST = 8,
5499 RELAY_ERROR_INTERNAL_ERROR = 9,
5502 RELAY_ERROR_SRC_TOKEN_EXPIRED = 10,
5505 RELAY_ERROR_DEST_TOKEN_EXPIRED = 11,
5511 enum CHANNEL_MEDIA_RELAY_STATE {
5515 RELAY_STATE_IDLE = 0,
5518 RELAY_STATE_CONNECTING = 1,
5521 RELAY_STATE_RUNNING = 2,
5524 RELAY_STATE_FAILURE = 3,
5622 :
userId(OPTIONAL_NULLPTR),
5631 if (rhs.
userId != OPTIONAL_NULLPTR) {
5632 const int len = std::strlen(rhs.
userId);
5633 char* buf =
new char[len + 1];
5634 std::memcpy(buf, rhs.
userId, len);
5640 PeerDownlinkInfo& operator=(
const PeerDownlinkInfo& rhs) {
5641 if (
this == &rhs)
return *
this;
5642 userId = OPTIONAL_NULLPTR;
5646 if (rhs.userId != OPTIONAL_NULLPTR) {
5647 const int len = std::strlen(rhs.userId);
5648 char* buf =
new char[len + 1];
5649 std::memcpy(buf, rhs.userId, len);
5656 ~PeerDownlinkInfo() {
delete[]
userId; }
5699 DownlinkNetworkInfo& operator=(
const DownlinkNetworkInfo& rhs) {
5700 if (
this == &rhs)
return *
this;
5723 enum ENCRYPTION_MODE {
5775 bool datastreamEncryptionEnabled;
5780 datastreamEncryptionEnabled(false)
5786 const char* getEncryptionString()
const {
5789 return "aes-128-xts";
5791 return "aes-128-ecb";
5793 return "aes-256-xts";
5795 return "sm4-128-ecb";
5797 return "aes-128-gcm";
5799 return "aes-256-gcm";
5801 return "aes-128-gcm-2";
5803 return "aes-256-gcm-2";
5805 return "aes-128-gcm-2";
5807 return "aes-128-gcm-2";
5814 enum ENCRYPTION_ERROR_TYPE {
5818 ENCRYPTION_ERROR_INTERNAL_FAILURE = 0,
5822 ENCRYPTION_ERROR_DECRYPTION_FAILURE = 1,
5826 ENCRYPTION_ERROR_ENCRYPTION_FAILURE = 2,
5830 ENCRYPTION_ERROR_DATASTREAM_DECRYPTION_FAILURE = 3,
5834 ENCRYPTION_ERROR_DATASTREAM_ENCRYPTION_FAILURE = 4,
5837 enum UPLOAD_ERROR_REASON
5840 UPLOAD_NET_ERROR = 1,
5841 UPLOAD_SERVER_ERROR = 2,
5846 enum PERMISSION_TYPE {
5862 enum STREAM_SUBSCRIBE_STATE {
5879 SUB_STATE_NO_SUBSCRIBED = 1,
5883 SUB_STATE_SUBSCRIBING = 2,
5887 SUB_STATE_SUBSCRIBED = 3
5893 enum STREAM_PUBLISH_STATE {
5905 PUB_STATE_NO_PUBLISHED = 1,
5909 PUB_STATE_PUBLISHING = 2,
5913 PUB_STATE_PUBLISHED = 3
5924 const char* channelId;
5925 int intervalInSeconds;
5928 : view(v), enableAudio(ea), enableVideo(ev), token(t), channelId(c), intervalInSeconds(is) {}
5931 : view(OPTIONAL_NULLPTR), enableAudio(
true), enableVideo(
true), token(OPTIONAL_NULLPTR), channelId(OPTIONAL_NULLPTR), intervalInSeconds(2) {}
5955 enum EAR_MONITORING_FILTER_TYPE {
5959 EAR_MONITORING_FILTER_NONE = (1<<0),
5964 EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1<<1),
5968 EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1<<2),
5973 EAR_MONITORING_FILTER_REUSE_POST_PROCESSING_FILTER = (1<<15),
5979 enum THREAD_PRIORITY_TYPE {
6006 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
6011 struct ScreenVideoParameters {
6038 VideoDimensions dimensions;
6053 VIDEO_CONTENT_HINT contentHint = VIDEO_CONTENT_HINT::CONTENT_HINT_MOTION;
6055 ScreenVideoParameters() : dimensions(1280, 720) {}
6061 struct ScreenAudioParameters {
6065 int sampleRate = 16000;
6074 int captureSignalVolume = 100;
6080 struct ScreenCaptureParameters2 {
6090 bool captureAudio =
false;
6094 ScreenAudioParameters audioParams;
6104 bool captureVideo =
true;
6108 ScreenVideoParameters videoParams;
6115 enum MEDIA_TRACE_EVENT {
6119 MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0,
6123 MEDIA_TRACE_EVENT_VIDEO_DECODED,
6181 enum CONFIG_FETCH_TYPE {
6185 CONFIG_FETCH_TYPE_INITIALIZE = 1,
6189 CONFIG_FETCH_TYPE_JOIN_CHANNEL = 2,
6194 enum LOCAL_PROXY_MODE {
6197 ConnectivityFirst = 0,
6266 const char* channelId;
6283 virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid,
void** inter) = 0;
6296 if (engine && !engine->queryInterface(rtc::AGORA_IID_PARAMETER_ENGINE, (
void**)&p)) reset(p);
6297 return p != OPTIONAL_NULLPTR;
6304 virtual void onCertificateRequired() = 0;
6305 virtual void onLicenseRequest() = 0;
6306 virtual void onLicenseValidated() = 0;
6307 virtual void onLicenseError(
int result) = 0;
6397 AGORA_API
const char* AGORA_CALL getAgoraSdkVersion(
int* build);
6404 AGORA_API
const char* AGORA_CALL getAgoraSdkErrorDescription(
int err);
6406 AGORA_API
int AGORA_CALL setAgoraSdkExternalSymbolLoader(
void* (*func)(
const char* symname));
6430 AGORA_API
int AGORA_CALL getAgoraCertificateVerifyResult(
const char *credential_buf,
int credential_len,
6431 const char *certificate_buf,
int certificate_len);
6474 AGORA_API int64_t AGORA_CALL getAgoraCurrentMonotonicTimeInMs();