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,
650 ERR_CLIENT_IS_BANNED_BY_SERVER = 123,
656 ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH = 130,
661 ERR_LICENSE_CREDENTIAL_INVALID = 131,
666 ERR_INVALID_USER_ACCOUNT = 134,
673 ERR_MODULE_NOT_FOUND = 157,
677 ERR_CERT_JSON_PART = 158,
678 ERR_CERT_JSON_INVAL = 159,
679 ERR_CERT_JSON_NOMEM = 160,
680 ERR_CERT_CUSTOM = 161,
681 ERR_CERT_CREDENTIAL = 162,
686 ERR_CERT_DUEDATE = 167,
687 ERR_CERT_REQUEST = 168,
690 ERR_PCMSEND_FORMAT = 200,
691 ERR_PCMSEND_BUFFEROVERFLOW = 201,
695 ERR_LOGIN_ALREADY_LOGIN = 428,
702 ERR_LOAD_MEDIA_ENGINE = 1001,
708 ERR_ADM_GENERAL_ERROR = 1005,
713 ERR_ADM_INIT_PLAYOUT = 1008,
717 ERR_ADM_START_PLAYOUT = 1009,
721 ERR_ADM_STOP_PLAYOUT = 1010,
726 ERR_ADM_INIT_RECORDING = 1011,
730 ERR_ADM_START_RECORDING = 1012,
734 ERR_ADM_STOP_RECORDING = 1013,
738 ERR_VDM_CAMERA_NOT_AUTHORIZED = 1501,
741 enum LICENSE_ERROR_TYPE {
745 LICENSE_ERR_INVALID = 1,
749 LICENSE_ERR_EXPIRE = 2,
753 LICENSE_ERR_MINUTES_EXCEED = 3,
757 LICENSE_ERR_LIMITED_PERIOD = 4,
761 LICENSE_ERR_DIFF_DEVICES = 5,
765 LICENSE_ERR_INTERNAL = 99,
771 enum AUDIO_SESSION_OPERATION_RESTRICTION {
775 AUDIO_SESSION_OPERATION_RESTRICTION_NONE = 0,
779 AUDIO_SESSION_OPERATION_RESTRICTION_SET_CATEGORY = 1,
783 AUDIO_SESSION_OPERATION_RESTRICTION_CONFIGURE_SESSION = 1 << 1,
788 AUDIO_SESSION_OPERATION_RESTRICTION_DEACTIVATE_SESSION = 1 << 2,
793 AUDIO_SESSION_OPERATION_RESTRICTION_ALL = 1 << 7,
796 typedef const char* user_id_t;
797 typedef void* view_t;
823 typedef util::AList<UserInfo> UserList;
831 enum USER_OFFLINE_REASON_TYPE {
835 USER_OFFLINE_QUIT = 0,
841 USER_OFFLINE_DROPPED = 1,
845 USER_OFFLINE_BECOME_AUDIENCE = 2,
848 enum INTERFACE_ID_TYPE {
849 AGORA_IID_AUDIO_DEVICE_MANAGER = 1,
850 AGORA_IID_VIDEO_DEVICE_MANAGER = 2,
851 AGORA_IID_PARAMETER_ENGINE = 3,
852 AGORA_IID_MEDIA_ENGINE = 4,
853 AGORA_IID_AUDIO_ENGINE = 5,
854 AGORA_IID_VIDEO_ENGINE = 6,
855 AGORA_IID_RTC_CONNECTION = 7,
856 AGORA_IID_SIGNALING_ENGINE = 8,
857 AGORA_IID_MEDIA_ENGINE_REGULATOR = 9,
858 AGORA_IID_LOCAL_SPATIAL_AUDIO = 11,
859 AGORA_IID_STATE_SYNC = 13,
860 AGORA_IID_META_SERVICE = 14,
861 AGORA_IID_MUSIC_CONTENT_CENTER = 15,
862 AGORA_IID_H265_TRANSCODER = 16,
873 QUALITY_UNKNOWN __deprecated = 0,
877 QUALITY_EXCELLENT = 1,
902 QUALITY_UNSUPPORTED = 7,
906 QUALITY_DETECTING = 8,
930 enum VIDEO_ORIENTATION {
934 VIDEO_ORIENTATION_0 = 0,
938 VIDEO_ORIENTATION_90 = 90,
942 VIDEO_ORIENTATION_180 = 180,
946 VIDEO_ORIENTATION_270 = 270
956 FRAME_RATE_FPS_1 = 1,
960 FRAME_RATE_FPS_7 = 7,
964 FRAME_RATE_FPS_10 = 10,
968 FRAME_RATE_FPS_15 = 15,
972 FRAME_RATE_FPS_24 = 24,
976 FRAME_RATE_FPS_30 = 30,
980 FRAME_RATE_FPS_60 = 60,
984 FRAME_WIDTH_960 = 960,
988 FRAME_HEIGHT_540 = 540,
995 enum VIDEO_FRAME_TYPE {
997 VIDEO_FRAME_TYPE_BLANK_FRAME = 0,
999 VIDEO_FRAME_TYPE_KEY_FRAME = 3,
1001 VIDEO_FRAME_TYPE_DELTA_FRAME = 4,
1003 VIDEO_FRAME_TYPE_B_FRAME = 5,
1005 VIDEO_FRAME_TYPE_DROPPABLE_FRAME = 6,
1007 VIDEO_FRAME_TYPE_UNKNOW
1013 enum ORIENTATION_MODE {
1021 ORIENTATION_MODE_ADAPTIVE = 0,
1028 ORIENTATION_MODE_FIXED_LANDSCAPE = 1,
1035 ORIENTATION_MODE_FIXED_PORTRAIT = 2,
1041 enum DEGRADATION_PREFERENCE {
1049 MAINTAIN_QUALITY = 0,
1055 MAINTAIN_FRAMERATE = 1,
1062 MAINTAIN_BALANCED = 2,
1066 MAINTAIN_RESOLUTION = 3,
1087 bool operator==(
const VideoDimensions& rhs)
const {
1088 return width == rhs.width &&
height == rhs.height;
1097 const int STANDARD_BITRATE = 0;
1106 const int COMPATIBLE_BITRATE = -1;
1111 const int DEFAULT_MIN_BITRATE = -1;
1116 const int DEFAULT_MIN_BITRATE_EQUAL_TO_TARGET_BITRATE = -2;
1121 enum SCREEN_CAPTURE_FRAMERATE_CAPABILITY {
1122 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_15_FPS = 0,
1123 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_30_FPS = 1,
1124 SCREEN_CAPTURE_FRAMERATE_CAPABILITY_60_FPS = 2,
1130 enum VIDEO_CODEC_CAPABILITY_LEVEL {
1132 CODEC_CAPABILITY_LEVEL_UNSPECIFIED = -1,
1134 CODEC_CAPABILITY_LEVEL_BASIC_SUPPORT = 5,
1136 CODEC_CAPABILITY_LEVEL_1080P30FPS = 10,
1138 CODEC_CAPABILITY_LEVEL_1080P60FPS = 20,
1140 CODEC_CAPABILITY_LEVEL_4K60FPS = 30,
1146 enum VIDEO_CODEC_TYPE {
1147 VIDEO_CODEC_NONE = 0,
1151 VIDEO_CODEC_VP8 = 1,
1155 VIDEO_CODEC_H264 = 2,
1159 VIDEO_CODEC_H265 = 3,
1164 VIDEO_CODEC_GENERIC = 6,
1168 VIDEO_CODEC_GENERIC_H264 = 7,
1172 VIDEO_CODEC_AV1 = 12,
1176 VIDEO_CODEC_VP9 = 13,
1180 VIDEO_CODEC_GENERIC_JPEG = 20,
1277 enum AUDIO_CODEC_TYPE {
1281 AUDIO_CODEC_OPUS = 1,
1286 AUDIO_CODEC_PCMA = 3,
1290 AUDIO_CODEC_PCMU = 4,
1294 AUDIO_CODEC_G722 = 5,
1301 AUDIO_CODEC_AACLC = 8,
1305 AUDIO_CODEC_HEAAC = 9,
1309 AUDIO_CODEC_JC1 = 10,
1313 AUDIO_CODEC_HEAAC2 = 11,
1317 AUDIO_CODEC_LPCNET = 12,
1323 enum AUDIO_ENCODING_TYPE {
1328 AUDIO_ENCODING_TYPE_AAC_16000_LOW = 0x010101,
1333 AUDIO_ENCODING_TYPE_AAC_16000_MEDIUM = 0x010102,
1338 AUDIO_ENCODING_TYPE_AAC_32000_LOW = 0x010201,
1343 AUDIO_ENCODING_TYPE_AAC_32000_MEDIUM = 0x010202,
1348 AUDIO_ENCODING_TYPE_AAC_32000_HIGH = 0x010203,
1353 AUDIO_ENCODING_TYPE_AAC_48000_MEDIUM = 0x010302,
1358 AUDIO_ENCODING_TYPE_AAC_48000_HIGH = 0x010303,
1363 AUDIO_ENCODING_TYPE_OPUS_16000_LOW = 0x020101,
1368 AUDIO_ENCODING_TYPE_OPUS_16000_MEDIUM = 0x020102,
1373 AUDIO_ENCODING_TYPE_OPUS_48000_MEDIUM = 0x020302,
1378 AUDIO_ENCODING_TYPE_OPUS_48000_HIGH = 0x020303,
1384 enum WATERMARK_FIT_MODE {
1389 FIT_MODE_COVER_POSITION,
1394 FIT_MODE_USE_IMAGE_RATIO
1424 :
codec(AUDIO_CODEC_AACLC),
1473 channelNum(rhs.channelNum),
1502 enum H264PacketizeMode {
1516 enum VIDEO_STREAM_TYPE {
1520 VIDEO_STREAM_HIGH = 0,
1524 VIDEO_STREAM_LOW = 1,
1548 enum MAX_USER_ACCOUNT_LENGTH_TYPE
1552 MAX_USER_ACCOUNT_LENGTH = 256
1565 frameType(VIDEO_FRAME_TYPE_BLANK_FRAME),
1586 if (
this == &rhs)
return *
this;
1654 enum COMPRESSION_PREFERENCE {
1668 enum ENCODING_PREFERENCE {
1676 PREFER_SOFTWARE = 0,
1680 PREFER_HARDWARE = 1,
1702 COMPRESSION_PREFERENCE compression_preference) :
1706 bool operator==(
const AdvanceOptions& rhs)
const {
1716 enum VIDEO_MIRROR_MODE_TYPE {
1720 VIDEO_MIRROR_MODE_AUTO = 0,
1724 VIDEO_MIRROR_MODE_ENABLED = 1,
1728 VIDEO_MIRROR_MODE_DISABLED = 2,
1733 enum CODEC_CAP_MASK {
1735 CODEC_CAP_MASK_NONE = 0,
1738 CODEC_CAP_MASK_HW_DEC = 1 << 0,
1741 CODEC_CAP_MASK_HW_ENC = 1 << 1,
1744 CODEC_CAP_MASK_SW_DEC = 1 << 2,
1747 CODEC_CAP_MASK_SW_ENC = 1 << 3,
1751 VIDEO_CODEC_CAPABILITY_LEVEL hwDecodingLevel;
1752 VIDEO_CODEC_CAPABILITY_LEVEL swDecodingLevel;
1754 CodecCapLevels(): hwDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED), swDecodingLevel(CODEC_CAPABILITY_LEVEL_UNSPECIFIED) {}
1889 VideoEncoderConfiguration(
int width,
int height,
int f,
int b, ORIENTATION_MODE m, VIDEO_MIRROR_MODE_TYPE mirror = VIDEO_MIRROR_MODE_DISABLED)
1899 VideoEncoderConfiguration(
const VideoEncoderConfiguration& config)
1909 VideoEncoderConfiguration()
1911 dimensions(FRAME_WIDTH_960, FRAME_HEIGHT_540),
1920 VideoEncoderConfiguration& operator=(
const VideoEncoderConfiguration& rhs) {
1921 if (
this == &rhs)
return *
this;
1964 enum SIMULCAST_STREAM_MODE {
1968 AUTO_SIMULCAST_STREAM = -1,
1972 DISABLE_SIMULCAST_STREAM = 0,
1976 ENABLE_SIMULCAST_STREAM = 1,
2093 mode(FIT_MODE_COVER_POSITION) {}
2295 enum CLIENT_ROLE_TYPE {
2299 CLIENT_ROLE_BROADCASTER = 1,
2303 CLIENT_ROLE_AUDIENCE = 2,
2309 enum QUALITY_ADAPT_INDICATION {
2317 ADAPT_UP_BANDWIDTH = 1,
2321 ADAPT_DOWN_BANDWIDTH = 2,
2328 enum AUDIENCE_LATENCY_LEVEL_TYPE
2333 AUDIENCE_LATENCY_LEVEL_LOW_LATENCY = 1,
2337 AUDIENCE_LATENCY_LEVEL_ULTRA_LOW_LATENCY = 2,
2357 enum EXPERIENCE_QUALITY_TYPE {
2359 EXPERIENCE_QUALITY_GOOD = 0,
2361 EXPERIENCE_QUALITY_BAD = 1,
2367 enum EXPERIENCE_POOR_REASON {
2371 EXPERIENCE_REASON_NONE = 0,
2375 REMOTE_NETWORK_QUALITY_POOR = 1,
2379 LOCAL_NETWORK_QUALITY_POOR = 2,
2383 WIRELESS_SIGNAL_POOR = 4,
2388 WIFI_BLUETOOTH_COEXIST = 8,
2394 enum AUDIO_AINS_MODE {
2398 AINS_MODE_BALANCED = 0,
2402 AINS_MODE_AGGRESSIVE = 1,
2406 AINS_MODE_ULTRALOWLATENCY = 2
2412 enum AUDIO_PROFILE_TYPE {
2421 AUDIO_PROFILE_DEFAULT = 0,
2425 AUDIO_PROFILE_SPEECH_STANDARD = 1,
2429 AUDIO_PROFILE_MUSIC_STANDARD = 2,
2436 AUDIO_PROFILE_MUSIC_STANDARD_STEREO = 3,
2440 AUDIO_PROFILE_MUSIC_HIGH_QUALITY = 4,
2447 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO = 5,
2451 AUDIO_PROFILE_IOT = 6,
2452 AUDIO_PROFILE_NUM = 7
2458 enum AUDIO_SCENARIO_TYPE {
2463 AUDIO_SCENARIO_DEFAULT = 0,
2469 AUDIO_SCENARIO_GAME_STREAMING = 3,
2475 AUDIO_SCENARIO_CHATROOM = 5,
2479 AUDIO_SCENARIO_CHORUS = 7,
2483 AUDIO_SCENARIO_MEETING = 8,
2487 AUDIO_SCENARIO_NUM = 9,
2494 OPTIONAL_ENUM_SIZE_T {
2496 kMaxWidthInPixels = 3840,
2498 kMaxHeightInPixels = 2160,
2518 bool operator<(
const VideoFormat& fmt)
const {
2519 if (
height != fmt.height) {
2520 return height < fmt.height;
2521 }
else if (
width != fmt.width) {
2522 return width < fmt.width;
2524 return fps < fmt.fps;
2527 bool operator==(
const VideoFormat& fmt)
const {
2528 return width == fmt.width &&
height == fmt.height &&
fps == fmt.fps;
2530 bool operator!=(
const VideoFormat& fmt)
const {
2531 return !operator==(fmt);
2538 enum VIDEO_CONTENT_HINT {
2549 CONTENT_HINT_MOTION,
2555 CONTENT_HINT_DETAILS
2560 enum SCREEN_SCENARIO_TYPE {
2566 SCREEN_SCENARIO_DOCUMENT = 1,
2571 SCREEN_SCENARIO_GAMING = 2,
2576 SCREEN_SCENARIO_VIDEO = 3,
2582 SCREEN_SCENARIO_RDC = 4,
2589 enum VIDEO_APPLICATION_SCENARIO_TYPE {
2593 APPLICATION_SCENARIO_GENERAL = 0,
2597 APPLICATION_SCENARIO_MEETING = 1,
2603 enum VIDEO_QOE_PREFERENCE_TYPE {
2607 VIDEO_QOE_PREFERENCE_BALANCE = 1,
2611 VIDEO_QOE_PREFERENCE_DELAY_FIRST = 2,
2615 VIDEO_QOE_PREFERENCE_PICTURE_QUALITY_FIRST = 3,
2619 VIDEO_QOE_PREFERENCE_FLUENCY_FIRST = 4,
2626 enum CAPTURE_BRIGHTNESS_LEVEL_TYPE {
2630 CAPTURE_BRIGHTNESS_LEVEL_INVALID = -1,
2633 CAPTURE_BRIGHTNESS_LEVEL_NORMAL = 0,
2636 CAPTURE_BRIGHTNESS_LEVEL_BRIGHT = 1,
2639 CAPTURE_BRIGHTNESS_LEVEL_DARK = 2,
2645 enum LOCAL_AUDIO_STREAM_STATE {
2649 LOCAL_AUDIO_STREAM_STATE_STOPPED = 0,
2653 LOCAL_AUDIO_STREAM_STATE_RECORDING = 1,
2657 LOCAL_AUDIO_STREAM_STATE_ENCODING = 2,
2661 LOCAL_AUDIO_STREAM_STATE_FAILED = 3
2667 enum LOCAL_AUDIO_STREAM_REASON {
2671 LOCAL_AUDIO_STREAM_REASON_OK = 0,
2675 LOCAL_AUDIO_STREAM_REASON_FAILURE = 1,
2679 LOCAL_AUDIO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
2686 LOCAL_AUDIO_STREAM_REASON_DEVICE_BUSY = 3,
2690 LOCAL_AUDIO_STREAM_REASON_RECORD_FAILURE = 4,
2694 LOCAL_AUDIO_STREAM_REASON_ENCODE_FAILURE = 5,
2697 LOCAL_AUDIO_STREAM_REASON_NO_RECORDING_DEVICE = 6,
2700 LOCAL_AUDIO_STREAM_REASON_NO_PLAYOUT_DEVICE = 7,
2704 LOCAL_AUDIO_STREAM_REASON_INTERRUPTED = 8,
2707 LOCAL_AUDIO_STREAM_REASON_RECORD_INVALID_ID = 9,
2710 LOCAL_AUDIO_STREAM_REASON_PLAYOUT_INVALID_ID = 10,
2715 enum LOCAL_VIDEO_STREAM_STATE {
2719 LOCAL_VIDEO_STREAM_STATE_STOPPED = 0,
2724 LOCAL_VIDEO_STREAM_STATE_CAPTURING = 1,
2728 LOCAL_VIDEO_STREAM_STATE_ENCODING = 2,
2732 LOCAL_VIDEO_STREAM_STATE_FAILED = 3
2738 enum LOCAL_VIDEO_STREAM_REASON {
2742 LOCAL_VIDEO_STREAM_REASON_OK = 0,
2746 LOCAL_VIDEO_STREAM_REASON_FAILURE = 1,
2751 LOCAL_VIDEO_STREAM_REASON_DEVICE_NO_PERMISSION = 2,
2756 LOCAL_VIDEO_STREAM_REASON_DEVICE_BUSY = 3,
2762 LOCAL_VIDEO_STREAM_REASON_CAPTURE_FAILURE = 4,
2766 LOCAL_VIDEO_STREAM_REASON_CODEC_NOT_SUPPORT = 5,
2771 LOCAL_VIDEO_STREAM_REASON_CAPTURE_INBACKGROUND = 6,
2778 LOCAL_VIDEO_STREAM_REASON_CAPTURE_MULTIPLE_FOREGROUND_APPS = 7,
2784 LOCAL_VIDEO_STREAM_REASON_DEVICE_NOT_FOUND = 8,
2789 LOCAL_VIDEO_STREAM_REASON_DEVICE_DISCONNECTED = 9,
2794 LOCAL_VIDEO_STREAM_REASON_DEVICE_INVALID_ID = 10,
2798 LOCAL_VIDEO_STREAM_REASON_DEVICE_SYSTEM_PRESSURE = 101,
2804 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_MINIMIZED = 11,
2819 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_CLOSED = 12,
2821 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_OCCLUDED = 13,
2823 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_NOT_SUPPORTED = 20,
2825 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_FAILURE = 21,
2827 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_NO_PERMISSION = 22,
2833 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_AUTO_FALLBACK = 24,
2835 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_HIDDEN = 25,
2837 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_HIDDEN = 26,
2839 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_WINDOW_RECOVER_FROM_MINIMIZED = 27,
2847 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_PAUSED = 28,
2849 LOCAL_VIDEO_STREAM_REASON_SCREEN_CAPTURE_RESUMED = 29,
2856 enum REMOTE_AUDIO_STATE
2863 REMOTE_AUDIO_STATE_STOPPED = 0,
2867 REMOTE_AUDIO_STATE_STARTING = 1,
2873 REMOTE_AUDIO_STATE_DECODING = 2,
2878 REMOTE_AUDIO_STATE_FROZEN = 3,
2883 REMOTE_AUDIO_STATE_FAILED = 4,
2889 enum REMOTE_AUDIO_STATE_REASON
2894 REMOTE_AUDIO_REASON_INTERNAL = 0,
2898 REMOTE_AUDIO_REASON_NETWORK_CONGESTION = 1,
2902 REMOTE_AUDIO_REASON_NETWORK_RECOVERY = 2,
2907 REMOTE_AUDIO_REASON_LOCAL_MUTED = 3,
2912 REMOTE_AUDIO_REASON_LOCAL_UNMUTED = 4,
2917 REMOTE_AUDIO_REASON_REMOTE_MUTED = 5,
2922 REMOTE_AUDIO_REASON_REMOTE_UNMUTED = 6,
2926 REMOTE_AUDIO_REASON_REMOTE_OFFLINE = 7,
2932 enum REMOTE_VIDEO_STATE {
2938 REMOTE_VIDEO_STATE_STOPPED = 0,
2942 REMOTE_VIDEO_STATE_STARTING = 1,
2948 REMOTE_VIDEO_STATE_DECODING = 2,
2952 REMOTE_VIDEO_STATE_FROZEN = 3,
2956 REMOTE_VIDEO_STATE_FAILED = 4,
2961 enum REMOTE_VIDEO_STATE_REASON {
2965 REMOTE_VIDEO_STATE_REASON_INTERNAL = 0,
2969 REMOTE_VIDEO_STATE_REASON_NETWORK_CONGESTION = 1,
2973 REMOTE_VIDEO_STATE_REASON_NETWORK_RECOVERY = 2,
2977 REMOTE_VIDEO_STATE_REASON_LOCAL_MUTED = 3,
2981 REMOTE_VIDEO_STATE_REASON_LOCAL_UNMUTED = 4,
2985 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED = 5,
2989 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED = 6,
2993 REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE = 7,
2997 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK = 8,
3001 REMOTE_VIDEO_STATE_REASON_AUDIO_FALLBACK_RECOVERY = 9,
3004 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_LOW = 10,
3007 REMOTE_VIDEO_STATE_REASON_VIDEO_STREAM_TYPE_CHANGE_TO_HIGH = 11,
3010 REMOTE_VIDEO_STATE_REASON_SDK_IN_BACKGROUND = 12,
3014 REMOTE_VIDEO_STATE_REASON_CODEC_NOT_SUPPORT = 13,
3021 enum REMOTE_USER_STATE {
3025 USER_STATE_MUTE_AUDIO = (1 << 0),
3029 USER_STATE_MUTE_VIDEO = (1 << 1),
3033 USER_STATE_ENABLE_VIDEO = (1 << 4),
3037 USER_STATE_ENABLE_LOCAL_VIDEO = (1 << 8),
3095 enum REMOTE_VIDEO_DOWNSCALE_LEVEL {
3099 REMOTE_VIDEO_DOWNSCALE_LEVEL_NONE,
3103 REMOTE_VIDEO_DOWNSCALE_LEVEL_1,
3107 REMOTE_VIDEO_DOWNSCALE_LEVEL_2,
3111 REMOTE_VIDEO_DOWNSCALE_LEVEL_3,
3115 REMOTE_VIDEO_DOWNSCALE_LEVEL_4,
3164 bool isLowLatencyAudioSupported;
3166 DeviceInfo() : isLowLatencyAudioSupported(
false) {}
3229 enum AUDIO_SAMPLE_RATE_TYPE {
3233 AUDIO_SAMPLE_RATE_32000 = 32000,
3237 AUDIO_SAMPLE_RATE_44100 = 44100,
3241 AUDIO_SAMPLE_RATE_48000 = 48000,
3246 enum VIDEO_CODEC_TYPE_FOR_STREAM {
3250 VIDEO_CODEC_H264_FOR_STREAM = 1,
3254 VIDEO_CODEC_H265_FOR_STREAM = 2,
3260 enum VIDEO_CODEC_PROFILE_TYPE {
3264 VIDEO_CODEC_PROFILE_BASELINE = 66,
3268 VIDEO_CODEC_PROFILE_MAIN = 77,
3272 VIDEO_CODEC_PROFILE_HIGH = 100,
3279 enum AUDIO_CODEC_PROFILE_TYPE {
3283 AUDIO_CODEC_PROFILE_LC_AAC = 0,
3287 AUDIO_CODEC_PROFILE_HE_AAC = 1,
3291 AUDIO_CODEC_PROFILE_HE_AAC_V2 = 2,
3341 enum RTMP_STREAM_PUBLISH_STATE {
3345 RTMP_STREAM_PUBLISH_STATE_IDLE = 0,
3349 RTMP_STREAM_PUBLISH_STATE_CONNECTING = 1,
3353 RTMP_STREAM_PUBLISH_STATE_RUNNING = 2,
3359 RTMP_STREAM_PUBLISH_STATE_RECOVERING = 3,
3363 RTMP_STREAM_PUBLISH_STATE_FAILURE = 4,
3367 RTMP_STREAM_PUBLISH_STATE_DISCONNECTING = 5,
3373 enum RTMP_STREAM_PUBLISH_REASON {
3377 RTMP_STREAM_PUBLISH_REASON_OK = 0,
3382 RTMP_STREAM_PUBLISH_REASON_INVALID_ARGUMENT = 1,
3386 RTMP_STREAM_PUBLISH_REASON_ENCRYPTED_STREAM_NOT_ALLOWED = 2,
3390 RTMP_STREAM_PUBLISH_REASON_CONNECTION_TIMEOUT = 3,
3394 RTMP_STREAM_PUBLISH_REASON_INTERNAL_SERVER_ERROR = 4,
3398 RTMP_STREAM_PUBLISH_REASON_RTMP_SERVER_ERROR = 5,
3402 RTMP_STREAM_PUBLISH_REASON_TOO_OFTEN = 6,
3406 RTMP_STREAM_PUBLISH_REASON_REACH_LIMIT = 7,
3410 RTMP_STREAM_PUBLISH_REASON_NOT_AUTHORIZED = 8,
3414 RTMP_STREAM_PUBLISH_REASON_STREAM_NOT_FOUND = 9,
3418 RTMP_STREAM_PUBLISH_REASON_FORMAT_NOT_SUPPORTED = 10,
3422 RTMP_STREAM_PUBLISH_REASON_NOT_BROADCASTER = 11,
3426 RTMP_STREAM_PUBLISH_REASON_TRANSCODING_NO_MIX_STREAM = 13,
3430 RTMP_STREAM_PUBLISH_REASON_NET_DOWN = 14,
3434 RTMP_STREAM_PUBLISH_REASON_INVALID_APPID = 15,
3436 RTMP_STREAM_PUBLISH_REASON_INVALID_PRIVILEGE = 16,
3440 RTMP_STREAM_UNPUBLISH_REASON_OK = 100,
3444 enum RTMP_STREAMING_EVENT {
3448 RTMP_STREAMING_EVENT_FAILED_LOAD_IMAGE = 1,
3452 RTMP_STREAMING_EVENT_URL_ALREADY_IN_USE = 2,
3456 RTMP_STREAMING_EVENT_ADVANCED_FEATURE_NOT_SUPPORT = 3,
3460 RTMP_STREAMING_EVENT_REQUEST_TOO_OFTEN = 4,
3533 enum CONNECTION_STATE_TYPE
3540 CONNECTION_STATE_DISCONNECTED = 1,
3549 CONNECTION_STATE_CONNECTING = 2,
3557 CONNECTION_STATE_CONNECTED = 3,
3567 CONNECTION_STATE_RECONNECTING = 4,
3576 CONNECTION_STATE_FAILED = 5,
3872 enum VIDEO_TRANSCODER_ERROR {
3876 VT_ERR_VIDEO_SOURCE_NOT_READY = 1,
3880 VT_ERR_INVALID_VIDEO_SOURCE_TYPE = 2,
3884 VT_ERR_INVALID_IMAGE_PATH = 3,
3888 VT_ERR_UNSUPPORT_IMAGE_FORMAT = 4,
3892 VT_ERR_INVALID_LAYOUT = 5,
3896 VT_ERR_INTERNAL = 20
3930 enum LASTMILE_PROBE_RESULT_STATE {
3934 LASTMILE_PROBE_RESULT_COMPLETE = 1,
3938 LASTMILE_PROBE_RESULT_INCOMPLETE_NO_BWE = 2,
3942 LASTMILE_PROBE_RESULT_UNAVAILABLE = 3
3989 :
state(LASTMILE_PROBE_RESULT_UNAVAILABLE),
3996 enum CONNECTION_CHANGED_REASON_TYPE
4001 CONNECTION_CHANGED_CONNECTING = 0,
4005 CONNECTION_CHANGED_JOIN_SUCCESS = 1,
4009 CONNECTION_CHANGED_INTERRUPTED = 2,
4013 CONNECTION_CHANGED_BANNED_BY_SERVER = 3,
4017 CONNECTION_CHANGED_JOIN_FAILED = 4,
4021 CONNECTION_CHANGED_LEAVE_CHANNEL = 5,
4025 CONNECTION_CHANGED_INVALID_APP_ID = 6,
4029 CONNECTION_CHANGED_INVALID_CHANNEL_NAME = 7,
4035 CONNECTION_CHANGED_INVALID_TOKEN = 8,
4039 CONNECTION_CHANGED_TOKEN_EXPIRED = 9,
4045 CONNECTION_CHANGED_REJECTED_BY_SERVER = 10,
4049 CONNECTION_CHANGED_SETTING_PROXY_SERVER = 11,
4053 CONNECTION_CHANGED_RENEW_TOKEN = 12,
4057 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED = 13,
4061 CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT = 14,
4065 CONNECTION_CHANGED_REJOIN_SUCCESS = 15,
4069 CONNECTION_CHANGED_LOST = 16,
4073 CONNECTION_CHANGED_ECHO_TEST = 17,
4077 CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER = 18,
4081 CONNECTION_CHANGED_SAME_UID_LOGIN = 19,
4085 CONNECTION_CHANGED_TOO_MANY_BROADCASTERS = 20,
4090 CONNECTION_CHANGED_LICENSE_VALIDATION_FAILURE = 21,
4094 CONNECTION_CHANGED_CERTIFICATION_VERYFY_FAILURE = 22,
4098 CONNECTION_CHANGED_STREAM_CHANNEL_NOT_AVAILABLE = 23,
4102 CONNECTION_CHANGED_INCONSISTENT_APPID = 24,
4108 enum CLIENT_ROLE_CHANGE_FAILED_REASON {
4112 CLIENT_ROLE_CHANGE_FAILED_TOO_MANY_BROADCASTERS = 1,
4116 CLIENT_ROLE_CHANGE_FAILED_NOT_AUTHORIZED = 2,
4120 CLIENT_ROLE_CHANGE_FAILED_REQUEST_TIME_OUT = 3,
4124 CLIENT_ROLE_CHANGE_FAILED_CONNECTION_FAILED = 4,
4130 enum WLACC_MESSAGE_REASON {
4134 WLACC_MESSAGE_REASON_WEAK_SIGNAL = 0,
4138 WLACC_MESSAGE_REASON_CHANNEL_CONGESTION = 1,
4144 enum WLACC_SUGGEST_ACTION {
4148 WLACC_SUGGEST_ACTION_CLOSE_TO_WIFI = 0,
4152 WLACC_SUGGEST_ACTION_CONNECT_SSID = 1,
4156 WLACC_SUGGEST_ACTION_CHECK_5G = 2,
4160 WLACC_SUGGEST_ACTION_MODIFY_SSID = 3,
4188 NETWORK_TYPE_UNKNOWN = -1,
4192 NETWORK_TYPE_DISCONNECTED = 0,
4196 NETWORK_TYPE_LAN = 1,
4200 NETWORK_TYPE_WIFI = 2,
4204 NETWORK_TYPE_MOBILE_2G = 3,
4208 NETWORK_TYPE_MOBILE_3G = 4,
4212 NETWORK_TYPE_MOBILE_4G = 5,
4216 NETWORK_TYPE_MOBILE_5G = 6,
4222 enum VIDEO_VIEW_SETUP_MODE {
4226 VIDEO_VIEW_SETUP_REPLACE = 0,
4230 VIDEO_VIEW_SETUP_ADD = 1,
4234 VIDEO_VIEW_SETUP_REMOVE = 2,
4312 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt)
4317 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
4322 VideoCanvas(view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u, uid_t subu)
4542 enum SEG_MODEL_TYPE {
4548 SEG_MODEL_TYPE modelType;
4550 float greenCapacity;
4558 enum AUDIO_TRACK_TYPE {
4562 AUDIO_TRACK_INVALID = -1,
4569 AUDIO_TRACK_MIXABLE = 0,
4575 AUDIO_TRACK_DIRECT = 1,
4612 enum VOICE_BEAUTIFIER_PRESET {
4615 VOICE_BEAUTIFIER_OFF = 0x00000000,
4621 CHAT_BEAUTIFIER_MAGNETIC = 0x01010100,
4627 CHAT_BEAUTIFIER_FRESH = 0x01010200,
4633 CHAT_BEAUTIFIER_VITALITY = 0x01010300,
4642 SINGING_BEAUTIFIER = 0x01020100,
4645 TIMBRE_TRANSFORMATION_VIGOROUS = 0x01030100,
4648 TIMBRE_TRANSFORMATION_DEEP = 0x01030200,
4651 TIMBRE_TRANSFORMATION_MELLOW = 0x01030300,
4654 TIMBRE_TRANSFORMATION_FALSETTO = 0x01030400,
4657 TIMBRE_TRANSFORMATION_FULL = 0x01030500,
4660 TIMBRE_TRANSFORMATION_CLEAR = 0x01030600,
4663 TIMBRE_TRANSFORMATION_RESOUNDING = 0x01030700,
4666 TIMBRE_TRANSFORMATION_RINGING = 0x01030800,
4676 ULTRA_HIGH_QUALITY_VOICE = 0x01040100
4698 enum AUDIO_EFFECT_PRESET {
4701 AUDIO_EFFECT_OFF = 0x00000000,
4704 ROOM_ACOUSTICS_KTV = 0x02010100,
4707 ROOM_ACOUSTICS_VOCAL_CONCERT = 0x02010200,
4710 ROOM_ACOUSTICS_STUDIO = 0x02010300,
4713 ROOM_ACOUSTICS_PHONOGRAPH = 0x02010400,
4720 ROOM_ACOUSTICS_VIRTUAL_STEREO = 0x02010500,
4723 ROOM_ACOUSTICS_SPACIAL = 0x02010600,
4726 ROOM_ACOUSTICS_ETHEREAL = 0x02010700,
4738 ROOM_ACOUSTICS_3D_VOICE = 0x02010800,
4749 ROOM_ACOUSTICS_VIRTUAL_SURROUND_SOUND = 0x02010900,
4756 VOICE_CHANGER_EFFECT_UNCLE = 0x02020100,
4762 VOICE_CHANGER_EFFECT_OLDMAN = 0x02020200,
4768 VOICE_CHANGER_EFFECT_BOY = 0x02020300,
4775 VOICE_CHANGER_EFFECT_SISTER = 0x02020400,
4781 VOICE_CHANGER_EFFECT_GIRL = 0x02020500,
4785 VOICE_CHANGER_EFFECT_PIGKING = 0x02020600,
4788 VOICE_CHANGER_EFFECT_HULK = 0x02020700,
4795 STYLE_TRANSFORMATION_RNB = 0x02030100,
4802 STYLE_TRANSFORMATION_POPULAR = 0x02030200,
4807 PITCH_CORRECTION = 0x02040100,
4816 enum VOICE_CONVERSION_PRESET {
4819 VOICE_CONVERSION_OFF = 0x00000000,
4822 VOICE_CHANGER_NEUTRAL = 0x03010100,
4825 VOICE_CHANGER_SWEET = 0x03010200,
4828 VOICE_CHANGER_SOLID = 0x03010300,
4831 VOICE_CHANGER_BASS = 0x03010400,
4834 VOICE_CHANGER_CARTOON = 0x03010500,
4837 VOICE_CHANGER_CHILDLIKE = 0x03010600,
4840 VOICE_CHANGER_PHONE_OPERATOR = 0x03010700,
4843 VOICE_CHANGER_MONSTER = 0x03010800,
4846 VOICE_CHANGER_TRANSFORMERS = 0x03010900,
4849 VOICE_CHANGER_GROOT = 0x03010A00,
4852 VOICE_CHANGER_DARTH_VADER = 0x03010B00,
4855 VOICE_CHANGER_IRON_LADY = 0x03010C00,
4858 VOICE_CHANGER_SHIN_CHAN = 0x03010D00,
4861 VOICE_CHANGER_GIRLISH_MAN = 0x03010E00,
4864 VOICE_CHANGER_CHIPMUNK = 0x03010F00,
4870 enum HEADPHONE_EQUALIZER_PRESET {
4873 HEADPHONE_EQUALIZER_OFF = 0x00000000,
4876 HEADPHONE_EQUALIZER_OVEREAR = 0x04000001,
4879 HEADPHONE_EQUALIZER_INEAR = 0x04000002
4953 :
dimensions(1920, 1080),
frameRate(5),
bitrate(STANDARD_BITRATE),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4956 ScreenCaptureParameters(
int width,
int height,
int f,
int b)
4957 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false){}
4958 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs)
4959 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(OPTIONAL_NULLPTR),
excludeWindowCount(0),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4960 ScreenCaptureParameters(
int width,
int height,
int f,
int b, view_t *ex,
int cnt)
4961 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(true),
windowFocus(false),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4962 ScreenCaptureParameters(
int width,
int height,
int f,
int b,
bool cur,
bool fcs, view_t *ex,
int cnt)
4963 :
dimensions(width, height),
frameRate(f),
bitrate(b),
captureMouseCursor(cur),
windowFocus(fcs),
excludeWindowList(ex),
excludeWindowCount(cnt),
highLightWidth(0),
highLightColor(0),
enableHighLight(false) {}
4969 enum AUDIO_RECORDING_QUALITY_TYPE {
4973 AUDIO_RECORDING_QUALITY_LOW = 0,
4977 AUDIO_RECORDING_QUALITY_MEDIUM = 1,
4981 AUDIO_RECORDING_QUALITY_HIGH = 2,
4985 AUDIO_RECORDING_QUALITY_ULTRA_HIGH = 3,
4991 enum AUDIO_FILE_RECORDING_TYPE {
4995 AUDIO_FILE_RECORDING_MIC = 1,
4999 AUDIO_FILE_RECORDING_PLAYBACK = 2,
5003 AUDIO_FILE_RECORDING_MIXED = 3,
5009 enum AUDIO_ENCODED_FRAME_OBSERVER_POSITION {
5013 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_RECORD = 1,
5017 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK = 2,
5021 AUDIO_ENCODED_FRAME_OBSERVER_POSITION_MIXED = 3,
5071 quality(AUDIO_RECORDING_QUALITY_LOW),
5082 AudioRecordingConfiguration(
const char* file_path,
bool enc,
int sample_rate, AUDIO_FILE_RECORDING_TYPE type, AUDIO_RECORDING_QUALITY_TYPE quality_type,
int channel)
5090 AudioRecordingConfiguration(
const AudioRecordingConfiguration &rhs)
5113 :
postionType(AUDIO_ENCODED_FRAME_OBSERVER_POSITION_PLAYBACK),
5167 AREA_CODE_CN = 0x00000001,
5171 AREA_CODE_NA = 0x00000002,
5175 AREA_CODE_EU = 0x00000004,
5179 AREA_CODE_AS = 0x00000008,
5183 AREA_CODE_JP = 0x00000010,
5187 AREA_CODE_IN = 0x00000020,
5191 AREA_CODE_GLOB = (0xFFFFFFFF)
5198 AREA_CODE_OC = 0x00000040,
5202 AREA_CODE_SA = 0x00000080,
5206 AREA_CODE_AF = 0x00000100,
5210 AREA_CODE_KR = 0x00000200,
5214 AREA_CODE_HKMC = 0x00000400,
5218 AREA_CODE_US = 0x00000800,
5222 AREA_CODE_OVS = 0xFFFFFFFE
5228 enum CHANNEL_MEDIA_RELAY_ERROR {
5234 RELAY_ERROR_SERVER_ERROR_RESPONSE = 1,
5240 RELAY_ERROR_SERVER_NO_RESPONSE = 2,
5243 RELAY_ERROR_NO_RESOURCE_AVAILABLE = 3,
5246 RELAY_ERROR_FAILED_JOIN_SRC = 4,
5249 RELAY_ERROR_FAILED_JOIN_DEST = 5,
5252 RELAY_ERROR_FAILED_PACKET_RECEIVED_FROM_SRC = 6,
5255 RELAY_ERROR_FAILED_PACKET_SENT_TO_DEST = 7,
5259 RELAY_ERROR_SERVER_CONNECTION_LOST = 8,
5262 RELAY_ERROR_INTERNAL_ERROR = 9,
5265 RELAY_ERROR_SRC_TOKEN_EXPIRED = 10,
5268 RELAY_ERROR_DEST_TOKEN_EXPIRED = 11,
5274 enum CHANNEL_MEDIA_RELAY_STATE {
5278 RELAY_STATE_IDLE = 0,
5281 RELAY_STATE_CONNECTING = 1,
5284 RELAY_STATE_RUNNING = 2,
5287 RELAY_STATE_FAILURE = 3,
5385 :
userId(OPTIONAL_NULLPTR),
5394 if (rhs.
userId != OPTIONAL_NULLPTR) {
5395 const int len = std::strlen(rhs.
userId);
5396 char* buf =
new char[len + 1];
5397 std::memcpy(buf, rhs.
userId, len);
5403 PeerDownlinkInfo& operator=(
const PeerDownlinkInfo& rhs) {
5404 if (
this == &rhs)
return *
this;
5405 userId = OPTIONAL_NULLPTR;
5409 if (rhs.userId != OPTIONAL_NULLPTR) {
5410 const int len = std::strlen(rhs.userId);
5411 char* buf =
new char[len + 1];
5412 std::memcpy(buf, rhs.userId, len);
5419 ~PeerDownlinkInfo() {
delete[]
userId; }
5462 DownlinkNetworkInfo& operator=(
const DownlinkNetworkInfo& rhs) {
5463 if (
this == &rhs)
return *
this;
5486 enum ENCRYPTION_MODE {
5546 const char* getEncryptionString()
const {
5549 return "aes-128-xts";
5551 return "aes-128-ecb";
5553 return "aes-256-xts";
5555 return "sm4-128-ecb";
5557 return "aes-128-gcm";
5559 return "aes-256-gcm";
5561 return "aes-128-gcm-2";
5563 return "aes-256-gcm-2";
5565 return "aes-128-gcm-2";
5567 return "aes-128-gcm-2";
5574 enum ENCRYPTION_ERROR_TYPE {
5578 ENCRYPTION_ERROR_INTERNAL_FAILURE = 0,
5582 ENCRYPTION_ERROR_DECRYPTION_FAILURE = 1,
5586 ENCRYPTION_ERROR_ENCRYPTION_FAILURE = 2,
5589 enum UPLOAD_ERROR_REASON
5592 UPLOAD_NET_ERROR = 1,
5593 UPLOAD_SERVER_ERROR = 2,
5598 enum PERMISSION_TYPE {
5614 enum STREAM_SUBSCRIBE_STATE {
5631 SUB_STATE_NO_SUBSCRIBED = 1,
5635 SUB_STATE_SUBSCRIBING = 2,
5639 SUB_STATE_SUBSCRIBED = 3
5645 enum STREAM_PUBLISH_STATE {
5657 PUB_STATE_NO_PUBLISHED = 1,
5661 PUB_STATE_PUBLISHING = 2,
5665 PUB_STATE_PUBLISHED = 3
5676 const char* channelId;
5677 int intervalInSeconds;
5680 : view(v), enableAudio(ea), enableVideo(ev), token(t), channelId(c), intervalInSeconds(is) {}
5683 : view(OPTIONAL_NULLPTR), enableAudio(
true), enableVideo(
true), token(OPTIONAL_NULLPTR), channelId(OPTIONAL_NULLPTR), intervalInSeconds(2) {}
5707 enum EAR_MONITORING_FILTER_TYPE {
5711 EAR_MONITORING_FILTER_NONE = (1<<0),
5716 EAR_MONITORING_FILTER_BUILT_IN_AUDIO_FILTERS = (1<<1),
5720 EAR_MONITORING_FILTER_NOISE_SUPPRESSION = (1<<2)
5726 enum THREAD_PRIORITY_TYPE {
5753 #if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS)
5758 struct ScreenVideoParameters {
5785 VideoDimensions dimensions;
5800 VIDEO_CONTENT_HINT contentHint = VIDEO_CONTENT_HINT::CONTENT_HINT_MOTION;
5802 ScreenVideoParameters() : dimensions(1280, 720) {}
5808 struct ScreenAudioParameters {
5812 int sampleRate = 16000;
5821 int captureSignalVolume = 100;
5827 struct ScreenCaptureParameters2 {
5837 bool captureAudio =
false;
5841 ScreenAudioParameters audioParams;
5851 bool captureVideo =
true;
5855 ScreenVideoParameters videoParams;
5862 enum MEDIA_TRACE_EVENT {
5866 MEDIA_TRACE_EVENT_VIDEO_RENDERED = 0,
5870 MEDIA_TRACE_EVENT_VIDEO_DECODED,
5928 enum CONFIG_FETCH_TYPE {
5932 CONFIG_FETCH_TYPE_INITIALIZE = 1,
5936 CONFIG_FETCH_TYPE_JOIN_CHANNEL = 2,
5941 enum LOCAL_PROXY_MODE {
5944 ConnectivityFirst = 0,
6013 const char* channelId;
6030 virtual int queryInterface(rtc::INTERFACE_ID_TYPE iid,
void** inter) = 0;
6043 if (engine && !engine->queryInterface(rtc::AGORA_IID_PARAMETER_ENGINE, (
void**)&p)) reset(p);
6044 return p != OPTIONAL_NULLPTR;
6051 virtual void onCertificateRequired() = 0;
6052 virtual void onLicenseRequest() = 0;
6053 virtual void onLicenseValidated() = 0;
6054 virtual void onLicenseError(
int result) = 0;
6144 AGORA_API
const char* AGORA_CALL getAgoraSdkVersion(
int* build);
6151 AGORA_API
const char* AGORA_CALL getAgoraSdkErrorDescription(
int err);
6153 AGORA_API
int AGORA_CALL setAgoraSdkExternalSymbolLoader(
void* (*func)(
const char* symname));
6177 AGORA_API
int AGORA_CALL getAgoraCertificateVerifyResult(
const char *credential_buf,
int credential_len,
6178 const char *certificate_buf,
int certificate_len);
6221 AGORA_API int64_t AGORA_CALL getAgoraCurrentMonotonicTimeInMs();