Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
IAgoraRtcEngine.h
1//
2// Agora Rtc Engine SDK
3//
4// Copyright (c) 2018 Agora.io. All rights reserved.
5//
6#pragma once
7
8#include "AgoraBase.h"
9#include "AgoraMediaBase.h"
10#include "IAgoraLog.h"
11#include "AgoraOptional.h"
12#include "IAudioDeviceManager.h"
13#include "IAgoraRhythmPlayer.h"
14#include "IAgoraMediaEngine.h"
15#include "IAgoraH265Transcoder.h"
16
17namespace agora {
18namespace rtm {
19class IStreamChannel;
20}
21namespace rtc {
22
23template <typename T>
24static void SetFrom(Optional<T>* s, const Optional<T>& o) {
25 if (o) {
26 *s = o;
27 }
28}
29
30template <typename T>
31static void ReplaceBy(Optional<T>* s, const Optional<T>& o) {
32 *s = o;
33}
34
35//class IAudioDeviceManager;
36
74
103
142
192
238
264
295
304
305struct RtcConnection;
306
430
572
669
671 struct Region {
677 double x; // [0,1]
680 double y; // [0,1]
684 double width; // [0,1]
686 double height; // [0,1]
690 int zOrder; // optional, [0, 100] //0 (default): bottom most, 100: top most
691
695 double alpha;
696
697 media::base::RENDER_MODE_TYPE renderMode; // RENDER_MODE_HIDDEN: Crop, RENDER_MODE_FIT: Zoom to fit
698
700 : uid(0),
701 x(0),
702 y(0),
703 width(0),
704 height(0),
705 zOrder(0),
706 alpha(1.0),
707 renderMode(media::base::RENDER_MODE_HIDDEN) {}
708 };
709
722 const char* backgroundColor; // e.g. "#C0C0C0" in RGB
732 const char* appData;
736
738 : canvasWidth(0),
739 canvasHeight(0),
740 backgroundColor(OPTIONAL_NULLPTR),
741 regions(NULL),
742 regionCount(0),
743 appData(OPTIONAL_NULLPTR),
744 appDataLength(0) {}
745};
746
753 int width;
781
782 // width / height default set to 0 means pull the stream with its original
783 // resolution
793};
794
810
817 int width;
843 bool owner;
852 const char* injectStreamUrl;
856 const char* publishUrl;
860 const char* rawStreamUrl;
863 const char* extraInfo;
864
866 : width(640),
867 height(360),
868 framerate(15),
869 bitrate(500),
870 defaultLayout(1),
872 owner(true),
875 injectStreamUrl(NULL),
876 publishUrl(NULL),
877 rawStreamUrl(NULL),
878 extraInfo(NULL) {}
879};
880
894
912
916 TCP_PROXY = 2,
918};
919
990
999 bool isCaptureWindow; // true - capture window, false - capture display
1004 int64_t displayId;
1009 Rectangle screenRect; //Windows only
1014 int64_t windowId;
1026
1028};
1029
1030#if (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)|| (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
1033struct SIZE {
1040
1041 SIZE() : width(0), height(0) {}
1042 SIZE(int ww, int hh) : width(ww), height(hh) {}
1043};
1044#endif
1045
1046#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
1058 const char* buffer;
1062 unsigned int length;
1066 unsigned int width;
1070 unsigned int height;
1071 ThumbImageBuffer() : buffer(nullptr), length(0), width(0), height(0) {}
1072};
1073
1094
1159
1163 protected:
1165
1166 public:
1175 virtual unsigned int getCount() = 0;
1192 virtual ScreenCaptureSourceInfo getSourceInfo(unsigned int index) = 0;
1203 virtual void release() = 0;
1204};
1205#endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
1220
1239
1287 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__)
1294 #endif
1295 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1303
1304 #else
1332 #endif
1333
1345
1497
1503
1514
1521
1528
1535
1543
1546
1547 void SetAll(const ChannelMediaOptions& change) {
1548#define SET_FROM(X) SetFrom(&X, change.X)
1549
1550 SET_FROM(publishCameraTrack);
1552 SET_FROM(publishThirdCameraTrack);
1553 SET_FROM(publishFourthCameraTrack);
1554 SET_FROM(publishMicrophoneTrack);
1555#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__)
1556 SET_FROM(publishScreenCaptureAudio);
1557#endif
1558#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1559 SET_FROM(publishScreenCaptureVideo);
1560#else
1561 SET_FROM(publishScreenTrack);
1563 SET_FROM(publishThirdScreenTrack);
1564 SET_FROM(publishFourthScreenTrack);
1565#endif
1567 SET_FROM(publishMixedAudioTrack);
1568 SET_FROM(publishLipSyncTrack);
1569 SET_FROM(publishCustomAudioTrack);
1570 SET_FROM(publishCustomAudioTrackId);
1571 SET_FROM(publishCustomVideoTrack);
1572 SET_FROM(publishEncodedVideoTrack);
1575 SET_FROM(autoSubscribeAudio);
1576 SET_FROM(autoSubscribeVideo);
1577 SET_FROM(publishMediaPlayerId);
1579 SET_FROM(clientRoleType);
1580 SET_FROM(audienceLatencyLevel);
1581 SET_FROM(defaultVideoStreamType);
1582 SET_FROM(channelProfile);
1583 SET_FROM(audioDelayMs);
1584 SET_FROM(mediaPlayerAudioDelayMs);
1585 SET_FROM(token);
1587 SET_FROM(publishRhythmPlayerTrack);
1588 SET_FROM(customVideoTrackId);
1589 SET_FROM(isAudioFilterable);
1590 SET_FROM(isInteractiveAudience);
1591 SET_FROM(parameters);
1592 SET_FROM(enableMultipath);
1593 SET_FROM(uplinkMultipathMode);
1594 SET_FROM(downlinkMultipathMode);
1595 SET_FROM(preferMultipathType);
1596 SET_FROM(channelType);
1597#undef SET_FROM
1598 }
1599
1600 bool operator==(const ChannelMediaOptions& o) const {
1601#define BEGIN_COMPARE() bool b = true
1602#define ADD_COMPARE(X) b = (b && (X == o.X))
1603#define END_COMPARE()
1604
1605 BEGIN_COMPARE();
1606 ADD_COMPARE(publishCameraTrack);
1607 ADD_COMPARE(publishSecondaryCameraTrack);
1608 ADD_COMPARE(publishThirdCameraTrack);
1609 ADD_COMPARE(publishFourthCameraTrack);
1610 ADD_COMPARE(publishMicrophoneTrack);
1611#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__)
1612 ADD_COMPARE(publishScreenCaptureAudio);
1613#endif
1614#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1615 ADD_COMPARE(publishScreenCaptureVideo);
1616#else
1617 ADD_COMPARE(publishScreenTrack);
1618 ADD_COMPARE(publishSecondaryScreenTrack);
1619 ADD_COMPARE(publishThirdScreenTrack);
1620 ADD_COMPARE(publishFourthScreenTrack);
1621#endif
1622 ADD_COMPARE(publishTranscodedVideoTrack);
1623 ADD_COMPARE(publishMixedAudioTrack);
1624 ADD_COMPARE(publishLipSyncTrack);
1625 ADD_COMPARE(publishCustomAudioTrack);
1626 ADD_COMPARE(publishCustomAudioTrackId);
1627 ADD_COMPARE(publishCustomVideoTrack);
1628 ADD_COMPARE(publishEncodedVideoTrack);
1629 ADD_COMPARE(publishMediaPlayerAudioTrack);
1630 ADD_COMPARE(publishMediaPlayerVideoTrack);
1631 ADD_COMPARE(autoSubscribeAudio);
1632 ADD_COMPARE(autoSubscribeVideo);
1633 ADD_COMPARE(publishMediaPlayerId);
1634 ADD_COMPARE(enableAudioRecordingOrPlayout);
1635 ADD_COMPARE(clientRoleType);
1636 ADD_COMPARE(audienceLatencyLevel);
1637 ADD_COMPARE(defaultVideoStreamType);
1638 ADD_COMPARE(channelProfile);
1639 ADD_COMPARE(audioDelayMs);
1640 ADD_COMPARE(mediaPlayerAudioDelayMs);
1641 ADD_COMPARE(token);
1642 ADD_COMPARE(enableBuiltInMediaEncryption);
1643 ADD_COMPARE(publishRhythmPlayerTrack);
1644 ADD_COMPARE(customVideoTrackId);
1645 ADD_COMPARE(isAudioFilterable);
1646 ADD_COMPARE(isInteractiveAudience);
1647 ADD_COMPARE(parameters);
1648 ADD_COMPARE(enableMultipath);
1649 ADD_COMPARE(uplinkMultipathMode);
1650 ADD_COMPARE(downlinkMultipathMode);
1651 ADD_COMPARE(preferMultipathType);
1652 ADD_COMPARE(channelType);
1653 END_COMPARE();
1654
1655#undef BEGIN_COMPARE
1656#undef ADD_COMPARE
1657#undef END_COMPARE
1658 return b;
1659 }
1660
1662 if (this != &replace) {
1663#define REPLACE_BY(X) ReplaceBy(&X, replace.X)
1664
1665 REPLACE_BY(publishCameraTrack);
1666 REPLACE_BY(publishSecondaryCameraTrack);
1667 REPLACE_BY(publishThirdCameraTrack);
1668 REPLACE_BY(publishFourthCameraTrack);
1669 REPLACE_BY(publishMicrophoneTrack);
1670#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(TARGET_OS_MAC) || defined(__OHOS__)
1671 REPLACE_BY(publishScreenCaptureAudio);
1672#endif
1673#if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
1674 REPLACE_BY(publishScreenCaptureVideo);
1675#else
1676 REPLACE_BY(publishScreenTrack);
1677 REPLACE_BY(publishSecondaryScreenTrack);
1678 REPLACE_BY(publishThirdScreenTrack);
1679 REPLACE_BY(publishFourthScreenTrack);
1680#endif
1681 REPLACE_BY(publishTranscodedVideoTrack);
1682 REPLACE_BY(publishMixedAudioTrack);
1683 REPLACE_BY(publishLipSyncTrack);
1684 REPLACE_BY(publishCustomAudioTrack);
1685 REPLACE_BY(publishCustomAudioTrackId);
1686 REPLACE_BY(publishCustomVideoTrack);
1687 REPLACE_BY(publishEncodedVideoTrack);
1688 REPLACE_BY(publishMediaPlayerAudioTrack);
1689 REPLACE_BY(publishMediaPlayerVideoTrack);
1690 REPLACE_BY(autoSubscribeAudio);
1691 REPLACE_BY(autoSubscribeVideo);
1692 REPLACE_BY(publishMediaPlayerId);
1694 REPLACE_BY(clientRoleType);
1695 REPLACE_BY(audienceLatencyLevel);
1696 REPLACE_BY(defaultVideoStreamType);
1697 REPLACE_BY(channelProfile);
1698 REPLACE_BY(audioDelayMs);
1699 REPLACE_BY(mediaPlayerAudioDelayMs);
1700 REPLACE_BY(token);
1701 REPLACE_BY(enableBuiltInMediaEncryption);
1702 REPLACE_BY(publishRhythmPlayerTrack);
1703 REPLACE_BY(customVideoTrackId);
1704 REPLACE_BY(isAudioFilterable);
1705 REPLACE_BY(isInteractiveAudience);
1706 REPLACE_BY(parameters);
1707 REPLACE_BY(enableMultipath);
1708 REPLACE_BY(uplinkMultipathMode);
1709 REPLACE_BY(downlinkMultipathMode);
1710 REPLACE_BY(preferMultipathType);
1711 REPLACE_BY(channelType);
1712#undef REPLACE_BY
1713 }
1714 return *this;
1715 }
1716};
1717
1752
1766
1792
1804 public:
1806
1807 virtual const char* eventHandlerType() const { return "event_handler"; }
1808
1829 virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1830 (void)channel;
1831 (void)uid;
1832 (void)elapsed;
1833 }
1834
1849 virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) {
1850 (void)channel;
1851 (void)uid;
1852 (void)elapsed;
1853 }
1854
1874 virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) {
1875 (void)channel;
1876 (void)uid;
1877 (void)proxyType;
1878 (void)localProxyIp;
1879 (void)elapsed;
1880 }
1881
1894 virtual void onError(int err, const char* msg) {
1895 (void)err;
1896 (void)msg;
1897 }
1898
1917 virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated {
1918 (void)uid;
1919 (void)quality;
1920 (void)delay;
1921 (void)lost;
1922 }
1923
1934 virtual void onLastmileProbeResult(const LastmileProbeResult& result) {
1935 (void)result;
1936 }
1937
1974 virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber,
1975 int totalVolume) {
1976 (void)speakers;
1977 (void)speakerNumber;
1978 (void)totalVolume;
1979 }
1980
1995 virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; }
1996
2007 virtual void onRtcStats(const RtcStats& stats) { (void)stats; }
2008
2023 virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
2024 (void)deviceId;
2025 (void)deviceType;
2026 (void)deviceState;
2027 }
2028
2043 virtual void onAudioMixingPositionChanged(int64_t position) {}
2044
2059
2069 virtual void onAudioEffectFinished(int soundId) {}
2070
2086 virtual void onVideoDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) {
2087 (void)deviceId;
2088 (void)deviceType;
2089 (void)deviceState;
2090 }
2091
2122 virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) {
2123 (void)uid;
2124 (void)txQuality;
2125 (void)rxQuality;
2126 }
2127
2134 virtual void onIntraRequestReceived() {}
2135
2149 (void)info;
2150 }
2151
2165 virtual void onLastmileQuality(int quality) { (void)quality; }
2166
2188 virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) {
2189 (void)source;
2190 (void)width;
2191 (void)height;
2192 (void)elapsed;
2193 }
2194
2216 virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) {
2217 (void)source;
2218 (void)elapsed;
2219 }
2220
2242 virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated {
2243 (void)uid;
2244 (void)width;
2245 (void)height;
2246 (void)elapsed;
2247 }
2248
2261 virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
2262 (void)uid;
2263 (void)width;
2264 (void)height;
2265 (void)rotation;
2266 }
2267
2281 (void)source;
2282 (void)event;
2283 }
2284
2337 (void)source;
2338 (void)state;
2339 (void)reason;
2340 }
2341
2356 virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) {
2357 (void)uid;
2358 (void)state;
2359 (void)reason;
2360 (void)elapsed;
2361 }
2362
2379 virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed) {
2380 (void)uid;
2381 (void)width;
2382 (void)height;
2383 (void)elapsed;
2384 }
2385
2410 virtual void onUserJoined(uid_t uid, int elapsed) {
2411 (void)uid;
2412 (void)elapsed;
2413 }
2414
2435 (void)uid;
2436 (void)reason;
2437 }
2438
2456 virtual void onUserMuteAudio(uid_t uid, bool muted) {
2457 (void)uid;
2458 (void)muted;
2459 }
2460
2478 virtual void onUserMuteVideo(uid_t uid, bool muted) {
2479 (void)uid;
2480 (void)muted;
2481 }
2482
2498 virtual void onUserEnableVideo(uid_t uid, bool enabled) {
2499 (void)uid;
2500 (void)enabled;
2501 }
2502
2508 virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state) {
2509 (void)uid;
2510 (void)state;
2511 }
2512
2533 virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated {
2534 (void)uid;
2535 (void)enabled;
2536 }
2537
2549 virtual void onRemoteAudioStats(const RemoteAudioStats& stats) {
2550 (void)stats;
2551 }
2552
2562 virtual void onLocalAudioStats(const LocalAudioStats& stats) {
2563 (void)stats;
2564 }
2565
2577 virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) {
2578 (void)source;
2579 (void)stats;
2580 }
2581
2593 virtual void onRemoteVideoStats(const RemoteVideoStats& stats) {
2594 (void)stats;
2595 }
2596
2607 virtual void onCameraReady() __deprecated {}
2608
2620 virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) {
2621 (void)x;
2622 (void)y;
2623 (void)width;
2624 (void)height;
2625 }
2626
2641 virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) {
2642 (void)x;
2643 (void)y;
2644 (void)width;
2645 (void)height;
2646 }
2647#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
2686 virtual void onFacePositionChanged(int imageWidth, int imageHeight,
2687 const Rectangle* vecRectangle, const int* vecDistance,
2688 int numFaces) {
2689 (void) imageWidth;
2690 (void) imageHeight;
2691 (void) vecRectangle;
2692 (void) vecDistance;
2693 (void) numFaces;
2694 }
2695#endif
2708
2721 (void)state;
2722 (void)reason;
2723 }
2724
2740 virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason) {
2741 (void)state;
2742 (void)reason;
2743 }
2744
2757 virtual void onConnectionLost() {}
2758
2778
2785
2803 virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length, uint64_t sentTs) {
2804 (void)uid;
2805 (void)streamId;
2806 (void)data;
2807 (void)length;
2808 (void)sentTs;
2809 }
2810
2828 virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached) {
2829 (void)uid;
2830 (void)streamId;
2831 (void)code;
2832 (void)missed;
2833 (void)cached;
2834 }
2835
2849 virtual void onRdtMessage(uid_t userId, RdtStreamType type, const char *data, size_t length) {
2850 (void)userId;
2851 (void)type;
2852 (void)data;
2853 (void)length;
2854 };
2855
2864 virtual void onRdtStateChanged(uid_t userId, RdtState state) {
2865 (void)userId;
2866 (void)state;
2867 }
2868
2880 virtual void onMediaControlMessage(uid_t userId, const char* data, size_t length) {
2881 (void)userId;
2882 (void)data;
2883 (void)length;
2884 }
2885
2903 virtual void onRequestToken() {}
2904
2925 virtual void onTokenPrivilegeWillExpire(const char* token) {
2926 (void)token;
2927 }
2928
2935 (void)error;
2936 }
2937
2955 virtual void onFirstLocalAudioFramePublished(int elapsed) {
2956 (void)elapsed;
2957 }
2958
2980 virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated {
2981 (void)uid;
2982 (void)elapsed;
2983 }
2984
2996 virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated {
2997 (void)uid;
2998 (void)elapsed;
2999 }
3000
3018 (void)state;
3019 (void)reason;
3020 }
3021
3041 virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
3042 (void)uid;
3043 (void)state;
3044 (void)reason;
3045 (void)elapsed;
3046 }
3047
3065 virtual void onActiveSpeaker(uid_t uid) {
3066 (void)uid;
3067 }
3068
3073 virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result) { (void)result; }
3074
3099 virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) {
3100 (void)uid;
3101 (void)filePath;
3102 (void)width;
3103 (void)height;
3104 (void)errCode;
3105 }
3106
3130 virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
3131 (void)oldRole;
3132 (void)newRole;
3133 (void)newRoleOptions;
3134 }
3135
3151 (void)reason;
3152 (void)currentRole;
3153 }
3154
3171 virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) {
3172 (void)deviceType;
3173 (void)volume;
3174 (void)muted;
3175 }
3176
3191 virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state,
3193 (void)url;
3194 (void)state;
3195 (void)reason;
3196 }
3197
3205 virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) {
3206 (void)url;
3207 (void)eventCode;
3208 }
3209
3221 virtual void onTranscodingUpdated() {}
3222
3231 virtual void onAudioRoutingChanged(int routing) { (void)routing; }
3232
3243 virtual void onChannelMediaRelayStateChanged(int state, int code) {
3244 (void)state;
3245 (void)code;
3246 }
3247
3271 virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover) {
3272 (void)uid;
3273 (void)isFallbackOrRecover;
3274 }
3275
3294 virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated {
3295 (void)uid;
3296 (void)delay;
3297 (void)lost;
3298 (void)rxKBitRate;
3299 }
3300
3318 virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated {
3319 (void)uid;
3320 (void)delay;
3321 (void)lost;
3322 (void)rxKBitRate;
3323 }
3324
3338 (void)state;
3339 (void)reason;
3340 }
3341
3355 (void)type;
3356 }
3357
3369 (void)errorType;
3370 }
3371
3382 virtual void onPermissionError(PERMISSION_TYPE permissionType) {
3383 (void)permissionType;
3384 }
3385
3386#if defined(__ANDROID__)
3391 virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType) {}
3392#endif
3393
3408 virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) {
3409 (void)uid;
3410 (void)userAccount;
3411 }
3412
3425 virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) {
3426 (void)uid;
3427 (void)info;
3428 }
3429
3436 virtual void onUserAccountUpdated(uid_t uid, const char* userAccount){
3437 (void)uid;
3438 (void)userAccount;
3439 }
3440
3458 (void)uid;
3459 (void)currentEvent;
3460 (void)tracingInfo;
3461 }
3462
3476 (void)stream;
3477 (void)error;
3478 }
3479
3486 virtual void onUploadLogResult(const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
3487 (void)requestId;
3488 (void)success;
3489 (void)reason;
3490 }
3491
3502 virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
3503 (void)channel;
3504 (void)uid;
3505 (void)oldState;
3506 (void)newState;
3507 (void)elapseSinceLastState;
3508 }
3509
3520 virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) {
3521 (void)channel;
3522 (void)uid;
3523 (void)oldState;
3524 (void)newState;
3525 (void)elapseSinceLastState;
3526 }
3527
3537 virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
3538 (void)channel;
3539 (void)oldState;
3540 (void)newState;
3541 (void)elapseSinceLastState;
3542 }
3543
3554 virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) {
3555 (void)source;
3556 (void)channel;
3557 (void)oldState;
3558 (void)newState;
3559 (void)elapseSinceLastState;
3560 }
3561
3581 virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
3582 (void)uid;
3583 (void)width;
3584 (void)height;
3585 (void)layoutCount;
3586 (void)layoutlist;
3587 }
3588
3597 virtual void onAudioMetadataReceived(uid_t uid, const char* metadata, size_t length) {
3598 (void)uid;
3599 (void)metadata;
3600 (void)length;
3601 }
3602
3614 virtual void onExtensionEventWithContext(const ExtensionContext &context, const char* key, const char* value) {
3615 (void)context;
3616 (void)key;
3617 (void)value;
3618 }
3619
3630 (void)context;
3631 }
3632
3643 (void)context;
3644 }
3645
3660 virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char* message) {
3661 (void)context;
3662 (void)error;
3663 (void)message;
3664 }
3665
3672 virtual void onSetRtmFlagResult(int code) {
3673 (void)code;
3674 }
3675
3687 virtual void onMultipathStats(const MultipathStats& stats) {
3688 (void)stats;
3689 }
3690
3704 virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERROR_CODE code) {
3705 (void)token;
3706 (void)code;
3707 }
3708};
3709
3714 public:
3716
3723 virtual int getCount() = 0;
3724
3734 virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3735
3746 virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH],
3747 char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3748
3752 virtual void release() = 0;
3753};
3754
3759 public:
3775
3786 virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3787
3800 virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH]) = 0;
3801
3802#if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__)) || \
3803 (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)
3823 virtual int numberOfCapabilities(const char* deviceIdUTF8) = 0;
3824
3846 virtual int getCapability(const char* deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat& capability) = 0;
3847#endif
3861 virtual int startDeviceTest(view_t hwnd) = 0;
3862
3869 virtual int stopDeviceTest() = 0;
3870
3877 virtual void release() = 0;
3878};
3879
3886 public:
3888
3894 enum class VIDEO_EFFECT_NODE_ID : uint32_t {
3898 BEAUTY = 1U << 0,
3902 STYLE_MAKEUP = 1U << 1,
3906 FILTER = 1U << 2,
3910 STICKER = 1U << 3,
3911 };
3912
3922 SAVE = 1,
3927 };
3928
3957 virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char* templateName) = 0;
3958
3971 virtual int removeVideoEffect(uint32_t nodeId) = 0;
3972
3985 virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId) = 0;
3986
4000 virtual int setVideoEffectStringParam(const char* option, const char* key, const char* param) = 0;
4001
4015 virtual int setVideoEffectFloatParam(const char* option, const char* key, float param) = 0;
4016
4030 virtual int setVideoEffectIntParam(const char* option, const char* key, int param) = 0;
4031
4047 virtual int setVideoEffectBoolParam(const char* option, const char* key, bool param) = 0;
4048
4065 virtual float getVideoEffectFloatParam(const char* option, const char* key) = 0;
4066
4082 virtual int getVideoEffectIntParam(const char* option, const char* key) = 0;
4083
4096 virtual bool getVideoEffectBoolParam(const char* option, const char* key) = 0;
4097
4098};
4099
4209
4213public:
4215
4230
4239
4244 {
4248 const char* channelId;
4254 unsigned int uid;
4258 unsigned int size;
4262 unsigned char *buffer;
4266 long long timeStampMs;
4267
4268 Metadata() : channelId(NULL), uid(0), size(0), buffer(NULL), timeStampMs(0) {}
4269 };
4270
4284
4302 virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type) = 0;
4303
4310 virtual void onMetadataReceived(const Metadata& metadata) = 0;
4311};
4312
4319 // No error occurs.
4324 // A general error occurs (no specified reason).
4329 // Audio publication error.
4335 // Video publication error.
4341
4346 // Already exist stream name.
4351};
4352
4390
4422
4430 public:
4432
4448 (void)state;
4449 (void)reason;
4450 (void)message;
4451 };
4452
4464 (void)stats;
4465 };
4466};
4467
4514
4517
4519#define SET_FROM(X) SetFrom(&X, change.X)
4520 SET_FROM(publishCameraTrack);
4521 SET_FROM(publishMicrophoneTrack);
4522 SET_FROM(publishCustomAudioTrack);
4523 SET_FROM(publishCustomVideoTrack);
4525 SET_FROM(publishMediaPlayerId);
4526 SET_FROM(customVideoTrackId);
4527#undef SET_FROM
4528 }
4529
4531#define BEGIN_COMPARE() bool b = true
4532#define ADD_COMPARE(X) b = (b && (X == o.X))
4533#define END_COMPARE()
4534
4535 BEGIN_COMPARE();
4536 ADD_COMPARE(publishCameraTrack);
4537 ADD_COMPARE(publishMicrophoneTrack);
4538 ADD_COMPARE(publishCustomAudioTrack);
4539 ADD_COMPARE(publishCustomVideoTrack);
4540 ADD_COMPARE(publishMediaPlayerAudioTrack);
4541 ADD_COMPARE(customVideoTrackId);
4542 ADD_COMPARE(publishMediaPlayerId);
4543 END_COMPARE();
4544
4545#undef BEGIN_COMPARE
4546#undef ADD_COMPARE
4547#undef END_COMPARE
4548 return b;
4549 }
4550
4552 if (this != &replace) {
4553#define REPLACE_BY(X) ReplaceBy(&X, replace.X)
4554
4555 REPLACE_BY(publishCameraTrack);
4556 REPLACE_BY(publishMicrophoneTrack);
4557 REPLACE_BY(publishCustomAudioTrack);
4558 REPLACE_BY(publishCustomVideoTrack);
4559 REPLACE_BY(publishMediaPlayerAudioTrack);
4560 REPLACE_BY(customVideoTrackId);
4561 REPLACE_BY(publishMediaPlayerId);
4562#undef REPLACE_BY
4563 }
4564 return *this;
4565 }
4566};
4567
4604
4605class IMediaPlayer;
4606class IMediaRecorder;
4607
4621
4629 public:
4654 AGORA_CPP_API static void release(RtcEngineReleaseCallback callback = nullptr);
4655
4680 virtual int initialize(const RtcEngineContext& context) = 0;
4681
4692 virtual int queryInterface(INTERFACE_ID_TYPE iid, void** inter) = 0;
4693
4694
4703 virtual const char* getVersion(int* build) = 0;
4704
4713 virtual const char* getErrorDescription(int code) = 0;
4714
4732 virtual int queryCodecCapability(CodecCapInfo* codecInfo, int& size) = 0;
4733
4750 virtual int queryDeviceScore() = 0;
4751
4809 virtual int preloadChannel(const char* token, const char* channelId, uid_t uid) = 0;
4810
4875 virtual int preloadChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
4876
4898 virtual int updatePreloadChannelToken(const char* token) = 0;
4899
4971 virtual int joinChannel(const char* token, const char* channelId, const char* info, uid_t uid) = 0;
4972
5048 virtual int joinChannel(const char* token, const char* channelId, uid_t uid, const ChannelMediaOptions& options) = 0;
5049
5069 virtual int updateChannelMediaOptions(const ChannelMediaOptions& options) = 0;
5070
5100 virtual int leaveChannel() = 0;
5101
5129 virtual int leaveChannel(const LeaveChannelOptions& options) = 0;
5130
5158 virtual int renewToken(const char* token) = 0;
5159
5184 virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile) = 0;
5185
5227 virtual int setClientRole(CLIENT_ROLE_TYPE role) = 0;
5228
5279 virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions& options) = 0;
5280
5307 virtual int startEchoTest(const EchoTestConfiguration& config) = 0;
5308
5321 virtual int stopEchoTest() = 0;
5322
5323#if defined(__APPLE__) && TARGET_OS_IOS
5366 virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration& config) = 0;
5367#endif
5396 virtual int enableVideo() = 0;
5397
5424 virtual int disableVideo() = 0;
5425
5442 virtual int startPreview() = 0;
5443
5463 virtual int startPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
5464
5477 virtual int stopPreview() = 0;
5478
5494 virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType) = 0;
5495
5520 virtual int startLastmileProbeTest(const LastmileProbeConfig& config) = 0;
5521
5529 virtual int stopLastmileProbeTest() = 0;
5530
5557
5662
5685
5709
5740
5741
5758
5759
5772
5903
5965
5993 virtual int setupRemoteVideo(const VideoCanvas& canvas) = 0;
5994
6027 virtual int setupLocalVideo(const VideoCanvas& canvas) = 0;
6028
6097
6116 virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference) = 0;
6117
6142 virtual int enableAudio() = 0;
6143
6165 virtual int disableAudio() = 0;
6166
6196
6215 virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile) = 0;
6237 virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
6269 virtual int enableLocalAudio(bool enabled) = 0;
6270
6291 virtual int muteLocalAudioStream(bool mute) = 0;
6292
6360 virtual int muteAllRemoteAudioStreams(bool mute) = 0;
6361
6379 virtual int muteRemoteAudioStream(uid_t uid, bool mute) = 0;
6380
6403 virtual int muteLocalVideoStream(bool mute) = 0;
6404
6434 virtual int enableLocalVideo(bool enabled) = 0;
6435
6501 virtual int muteAllRemoteVideoStreams(bool mute) = 0;
6502
6541
6559 virtual int muteRemoteVideoStream(uid_t uid, bool mute) = 0;
6560
6599 virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType) = 0;
6600
6626
6654 virtual int setSubscribeAudioBlocklist(uid_t* uidList, int uidNumber) = 0;
6655
6682 virtual int setSubscribeAudioAllowlist(uid_t* uidList, int uidNumber) = 0;
6683
6711 virtual int setSubscribeVideoBlocklist(uid_t* uidList, int uidNumber) = 0;
6712
6739 virtual int setSubscribeVideoAllowlist(uid_t* uidList, int uidNumber) = 0;
6740
6773 virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad) = 0;
6774
6801 virtual int startAudioRecording(const char* filePath,
6802 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
6837 virtual int startAudioRecording(const char* filePath,
6838 int sampleRate,
6839 AUDIO_RECORDING_QUALITY_TYPE quality) = 0;
6840
6861 virtual int startAudioRecording(const AudioRecordingConfiguration& config) = 0;
6862
6880
6888 virtual int stopAudioRecording() = 0;
6889
6904
6914 virtual int destroyMediaPlayer(agora_refptr<IMediaPlayer> media_player) = 0;
6915
6937
6953
7005 virtual int startAudioMixing(const char* filePath, bool loopback, int cycle) = 0;
7006
7061 virtual int startAudioMixing(const char* filePath, bool loopback, int cycle, int startPos) = 0;
7062
7076 virtual int stopAudioMixing() = 0;
7077
7091 virtual int pauseAudioMixing() = 0;
7092
7105 virtual int resumeAudioMixing() = 0;
7106
7128 virtual int selectAudioTrack(int index) = 0;
7140 virtual int getAudioTrackCount() = 0;
7141
7159 virtual int adjustAudioMixingVolume(int volume) = 0;
7160
7177 virtual int adjustAudioMixingPublishVolume(int volume) = 0;
7178
7194
7210 virtual int adjustAudioMixingPlayoutVolume(int volume) = 0;
7211
7227
7241 virtual int getAudioMixingDuration() = 0;
7242
7262
7279 virtual int setAudioMixingPosition(int pos /*in ms*/) = 0;
7280
7308
7328 virtual int setAudioMixingPitch(int pitch) = 0;
7329
7348 virtual int setAudioMixingPlaybackSpeed(int speed) = 0;
7349
7363 virtual int getEffectsVolume() = 0;
7377 virtual int setEffectsVolume(int volume) = 0;
7408 virtual int preloadEffect(int soundId, const char* filePath, int startPos = 0) = 0;
7461 virtual int playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false, int startPos = 0) = 0;
7492 virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish = false) = 0;
7493
7504 virtual int getVolumeOfEffect(int soundId) = 0;
7505
7520 virtual int setVolumeOfEffect(int soundId, int volume) = 0;
7530 virtual int pauseEffect(int soundId) = 0;
7538 virtual int pauseAllEffects() = 0;
7548 virtual int resumeEffect(int soundId) = 0;
7561 virtual int resumeAllEffects() = 0;
7576 virtual int stopEffect(int soundId) = 0;
7589 virtual int stopAllEffects() = 0;
7604 virtual int unloadEffect(int soundId) = 0;
7612 virtual int unloadAllEffects() = 0;
7632 virtual int getEffectDuration(const char* filePath) = 0;
7648 virtual int setEffectPosition(int soundId, int pos) = 0;
7660 virtual int getEffectCurrentPosition(int soundId) = 0;
7677 virtual int enableSoundPositionIndication(bool enabled) = 0;
7678
7708 virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain) = 0;
7709
7730 virtual int enableSpatialAudio(bool enabled) = 0;
7731
7748
7790
7832
7876
7951 virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2) = 0;
7952
8002 int param1, int param2) = 0;
8003
8017 int param1, int param2) = 0;
8018
8032 virtual int setLocalVoicePitch(double pitch) = 0;
8033
8054 virtual int setLocalVoiceFormant(double formantRatio) = 0;
8055
8072 virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain) = 0;
8073
8091 virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value) = 0;
8110
8129 virtual int setHeadphoneEQParameters(int lowGain, int highGain) = 0;
8130
8149 virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type) = 0;
8150
8167 virtual int setLogFile(const char* filePath) = 0;
8168
8186 virtual int setLogFilter(unsigned int filter) = 0;
8187
8201 virtual int setLogLevel(commons::LOG_LEVEL level) = 0;
8202
8236 virtual int setLogFileSize(unsigned int fileSizeInKBytes) = 0;
8237
8246 virtual int uploadLogFile(agora::util::AString& requestId) = 0;
8247
8263 virtual int writeLog(commons::LOG_LEVEL level, const char* fmt, ...) = 0;
8264
8291
8314 VIDEO_MIRROR_MODE_TYPE mirrorMode) = 0;
8335 virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps) = 0;
8355 virtual int setRemoteRenderTargetFps(int targetFps) = 0;
8356 // The following APIs are either deprecated and going to deleted.
8357
8379
8392
8419 virtual int enableDualStreamMode(bool enabled) __deprecated = 0;
8420
8451 virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) __deprecated = 0;
8452
8453
8486
8505 virtual int setSimulcastConfig(const SimulcastConfig& simulcastConfig) = 0;
8506
8547 virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig& streamConfig) = 0;
8548
8571 virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled) = 0;
8572
8595 virtual int setRecordingAudioFrameParameters(int sampleRate, int channel,
8597 int samplesPerCall) = 0;
8598
8621 virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel,
8623 int samplesPerCall) = 0;
8624
8646 virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall) = 0;
8647
8677 virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel,
8679 int samplesPerCall) = 0;
8680
8699 virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel) = 0;
8700
8722 virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall) = 0;
8723
8742 virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
8757
8792
8810 virtual int adjustRecordingSignalVolume(int volume) = 0;
8811
8831 virtual int muteRecordingSignal(bool mute) = 0;
8832
8851 virtual int adjustPlaybackSignalVolume(int volume) = 0;
8852
8872 virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume) = 0;
8873
8896
8910 virtual int setHighPriorityUserList(uid_t* uidList, int uidNum, STREAM_FALLBACK_OPTIONS option) = 0;
8911
8932 virtual int enableExtension(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, bool enable = true) = 0;
8933
8947 virtual int setExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, const char* value) = 0;
8948
8963 virtual int getExtensionProperty(const char* provider, const char* extension, const ExtensionInfo& extensionInfo, const char* key, char* value, int buf_len) = 0;
8964
8993 virtual int enableLoopbackRecording(bool enabled, const char* deviceName = NULL) = 0;
8994
8995
9010 virtual int adjustLoopbackSignalVolume(int volume) = 0;
9011
9019
9040 virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters) = 0;
9041
9059 virtual int setInEarMonitoringVolume(int volume) = 0;
9060
9061#if defined(_WIN32) || defined(__linux__) || defined(__ANDROID__)
9085 virtual int loadExtensionProvider(const char* path, bool unload_after_use = false) = 0;
9086#endif
9087
9107 virtual int setExtensionProviderProperty(const char* provider, const char* key, const char* value) = 0;
9108
9140 virtual int registerExtension(const char* provider, const char* extension, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
9141
9167 virtual int enableExtension(const char* provider, const char* extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
9168
9192 const char* provider, const char* extension,
9193 const char* key, const char* value, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
9194
9214 const char* provider, const char* extension,
9215 const char* key, char* value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;
9216
9240
9260
9269
9279 virtual int destroyCustomVideoTrack(video_track_id_t video_track_id) = 0;
9280
9289 virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id) = 0;
9290
9291#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
9312 virtual int switchCamera() = 0;
9313
9327 virtual bool isCameraZoomSupported() = 0;
9328
9342
9360 virtual bool isCameraTorchSupported() = 0;
9361
9374 virtual bool isCameraFocusSupported() = 0;
9375
9389
9416 virtual int setCameraZoomFactor(float factor) = 0;
9417
9440 virtual int enableFaceDetection(bool enabled) = 0;
9441
9453 virtual float getCameraMaxZoomFactor() = 0;
9454
9472 virtual int setCameraFocusPositionInPreview(float positionX, float positionY) = 0;
9473
9491 virtual int setCameraTorchOn(bool isOn) = 0;
9492
9512 virtual int setCameraAutoFocusFaceModeEnabled(bool enabled) = 0;
9513
9529
9549 virtual int setCameraExposurePosition(float positionXinView, float positionYinView) = 0;
9550
9569 virtual bool isCameraExposureSupported() = 0;
9570
9603 virtual int setCameraExposureFactor(float factor) = 0;
9604
9605#if defined(__APPLE__)
9619
9620
9638 virtual int setCameraAutoExposureFaceModeEnabled(bool enabled) = 0;
9639
9667#endif
9668
9699 virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker) = 0;
9700
9729 virtual int setEnableSpeakerphone(bool speakerOn) = 0;
9730
9744 virtual bool isSpeakerphoneEnabled() = 0;
9745
9774 virtual int setRouteInCommunicationMode(int route) = 0;
9775#endif // __ANDROID__ || (__APPLE__ && TARGET_OS_IOS) || __OHOS__
9776
9777#if defined(__APPLE__)
9795
9834 virtual int enableCameraCenterStage(bool enabled) = 0;
9835#endif
9836
9837#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE)|| (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
9870 virtual IScreenCaptureSourceList* getScreenCaptureSources(const SIZE& thumbSize, const SIZE& iconSize, const bool includeScreen) = 0;
9871#endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
9872#if (defined(__APPLE__) && TARGET_OS_IOS)
9897#endif // __APPLE__ && TARGET_OS_IOS
9898
9899#if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
9900
9940 virtual int startScreenCaptureByDisplayId(int64_t displayId, const Rectangle& regionRect,
9941 const ScreenCaptureParameters& captureParams) = 0;
9942
9943#endif // __APPLE__ && TARGET_OS_MAC && !TARGET_OS_IPHONE
9944
9945#if defined(_WIN32)
9984 virtual int startScreenCaptureByScreenRect(const Rectangle& screenRect,
9985 const Rectangle& regionRect,
9986 const ScreenCaptureParameters& captureParams) __deprecated = 0;
9987#endif
9988
9989#if defined(__ANDROID__)
10010 virtual int getAudioDeviceInfo(DeviceInfo& deviceInfo) = 0;
10011#endif // __ANDROID__
10012
10030 virtual int setRemoteRenderRotation(uid_t uid, VIDEO_ORIENTATION rotation) = 0;
10031
10032#if defined(_WIN32) || (defined(__APPLE__) && TARGET_OS_MAC && !TARGET_OS_IPHONE) || (defined(__linux__) && !defined(__ANDROID__) && !defined(__OHOS__))
10033
10106 virtual int startScreenCaptureByWindowId(int64_t windowId, const Rectangle& regionRect,
10107 const ScreenCaptureParameters& captureParams) = 0;
10108
10130
10149 virtual int updateScreenCaptureRegion(const Rectangle& regionRect) = 0;
10150
10170 virtual int updateScreenCaptureParameters(const ScreenCaptureParameters& captureParams) = 0;
10171#endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC)
10172
10173#if defined(__ANDROID__) || (defined(__APPLE__) && TARGET_OS_IOS) || defined(__OHOS__)
10229 virtual int startScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
10230
10255 virtual int updateScreenCapture(const ScreenCaptureParameters2& captureParams) = 0;
10256
10278
10306 virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo* focalLengthInfos, int& size) = 0;
10307
10308#if defined(__ANDROID__)
10338 virtual int setExternalMediaProjection(void* mediaProjection) = 0;
10339#endif
10340#endif
10341
10342#if defined(_WIN32) || defined(__APPLE__) || defined(__ANDROID__) || (defined(__linux__) && !defined(__ANDROID__) && !defined (__OHOS__))
10359 virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario) = 0;
10360
10375 virtual int stopScreenCapture() = 0;
10376#endif // _WIN32 || (__APPLE__ && !TARGET_OS_IPHONE && TARGET_OS_MAC) || __ANDROID__
10377
10393 virtual int getCallId(agora::util::AString& callId) = 0;
10394
10411 virtual int rate(const char* callId, int rating, const char* description) = 0; // 0~10
10412
10431 virtual int complain(const char* callId, const char* description) = 0;
10432
10463 virtual int startRtmpStreamWithoutTranscoding(const char* url) = 0;
10464
10498 virtual int startRtmpStreamWithTranscoding(const char* url, const LiveTranscoding& transcoding) = 0;
10499
10516 virtual int updateRtmpTranscoding(const LiveTranscoding& transcoding) = 0;
10517
10593
10613 virtual int stopRtmpStream(const char* url) = 0;
10614
10626 virtual int stopLocalVideoTranscoder() = 0;
10627
10661
10682
10697 virtual int stopLocalAudioMixer() = 0;
10698
10724 virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration& config) = 0;
10725
10746 virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
10778
10821 virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration& config) = 0;
10822
10841 virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType) = 0;
10842
10853
10854 // The following APIs are not implemented yet.
10855 virtual bool registerEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
10856 virtual bool unregisterEventHandler(IRtcEngineEventHandler* eventHandler) = 0;
10857 virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority) = 0;
10858
10882 virtual int registerPacketObserver(IPacketObserver* observer) = 0;
10883
10884
10913 virtual int enableEncryption(bool enabled, const EncryptionConfig& config) = 0;
10914
10950 virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
10951
10975 virtual int createDataStream(int* streamId, const DataStreamConfig& config) = 0;
10976
11010 virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
11011
11025 virtual int sendRdtMessage(uid_t uid, RdtStreamType type, const char *data, size_t length) = 0;
11026
11039 virtual int sendMediaControlMessage(uid_t uid, const char* data, size_t length) = 0;
11040
11067 virtual int addVideoWatermark(const RtcImage& watermark) __deprecated = 0;
11068
11115 virtual int addVideoWatermark(const char* watermarkUrl, const WatermarkOptions& options) = 0;
11116
11132 virtual int addVideoWatermark(const WatermarkConfig& configs) = 0;
11133
11150 virtual int removeVideoWatermark(const char* id) = 0;
11151
11159 virtual int clearVideoWatermarks() = 0;
11160
11161 // The following APIs are either deprecated and going to deleted.
11162
11171 virtual int pauseAudio() __deprecated = 0;
11180 virtual int resumeAudio() __deprecated = 0;
11181
11202 virtual int enableWebSdkInteroperability(bool enabled) __deprecated = 0;
11203
11215 virtual int sendCustomReportMessage(const char* id, const char* category, const char* event, const char* label, int value) = 0;
11216
11241 virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type) = 0;
11242
11254 virtual int unregisterMediaMetadataObserver(IMetadataObserver* observer, IMetadataObserver::METADATA_TYPE type) = 0;
11255
11264 virtual int startAudioFrameDump(const char* channel_id, uid_t uid, const char* location, const char* uuid, const char* passwd, long duration_ms, bool auto_upload) = 0;
11265
11269 virtual int stopAudioFrameDump(const char* channel_id, uid_t uid, const char* location) = 0;
11270
11308 virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode) = 0;
11309
11363 virtual int registerLocalUserAccount(const char* appId, const char* userAccount) = 0;
11364
11448 virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount) = 0;
11449
11537 virtual int joinChannelWithUserAccount(const char* token, const char* channelId, const char* userAccount, const ChannelMediaOptions& options) = 0;
11538
11626 virtual int joinChannelWithUserAccountEx(const char* token, const char* channelId,
11627 const char* userAccount, const ChannelMediaOptions& options,
11628 IRtcEngineEventHandler* eventHandler) = 0;
11629
11651 virtual int getUserInfoByUserAccount(const char* userAccount, rtc::UserInfo* userInfo) = 0;
11652
11674 virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo* userInfo) = 0;
11675
11712
11733 virtual int stopChannelMediaRelay() = 0;
11734
11750 virtual int pauseAllChannelMediaRelay() = 0;
11751
11767
11786
11811
11845 const char* publishUrl, const DirectCdnStreamingMediaOptions& options) = 0;
11846
11856 virtual int stopDirectCdnStreaming() = 0;
11857
11872
11906 virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
11907
11920 virtual int stopRhythmPlayer() = 0;
11921
11946 virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig& config) = 0;
11947
11979 virtual int takeSnapshot(uid_t uid, const char* filePath) = 0;
11980
12005 virtual int takeSnapshot(uid_t uid, const media::SnapshotConfig& config) = 0;
12006
12035 virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config) = 0;
12055 virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume) = 0;
12056
12076 virtual int adjustCustomAudioPlayoutVolume(track_id_t trackId, int volume) = 0;
12077
12111 virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType) = 0;
12131
12149 virtual int setAdvancedAudioOptions(AdvancedAudioOptions& options, int sourceType = 0) = 0;
12150
12171 virtual int setAVSyncSource(const char* channelId, uid_t uid) = 0;
12172
12193 virtual int enableVideoImageSource(bool enable, const ImageTrackOptions& options) = 0;
12194
12212 virtual int64_t getCurrentMonotonicTimeInMs() = 0;
12213
12234 virtual int getNetworkType() = 0;
12235
12249 virtual int setParameters(const char* parameters) = 0;
12250
12281
12306
12319 virtual uint64_t getNtpWallTimeInMs() = 0;
12320
12342
12353 virtual int sendAudioMetadata(const char* metadata, size_t length) = 0;
12354
12366};
12367
12368// The following types are either deprecated or not implmented yet.
12377
12409
12410enum VIDEO_PROFILE_TYPE { // res fps
12460 VIDEO_PROFILE_LANDSCAPE_720P = 50, // 1280x720 15
12468 VIDEO_PROFILE_LANDSCAPE_1080P = 60, // 1920x1080 15
12474 VIDEO_PROFILE_LANDSCAPE_1440P = 66, // 2560x1440 30
12478 VIDEO_PROFILE_LANDSCAPE_4K = 70, // 3840x2160 30
12480 VIDEO_PROFILE_LANDSCAPE_4K_3 = 72, // 3840x2160 60
12482 VIDEO_PROFILE_PORTRAIT_120P = 1000, // 120x160 15
12484 VIDEO_PROFILE_PORTRAIT_120P_3 = 1002, // 120x120 15
12486 VIDEO_PROFILE_PORTRAIT_180P = 1010, // 180x320 15
12488 VIDEO_PROFILE_PORTRAIT_180P_3 = 1012, // 180x180 15
12490 VIDEO_PROFILE_PORTRAIT_180P_4 = 1013, // 180x240 15
12492 VIDEO_PROFILE_PORTRAIT_240P = 1020, // 240x320 15
12494 VIDEO_PROFILE_PORTRAIT_240P_3 = 1022, // 240x240 15
12496 VIDEO_PROFILE_PORTRAIT_240P_4 = 1023, // 240x424 15
12498 VIDEO_PROFILE_PORTRAIT_360P = 1030, // 360x640 15
12500 VIDEO_PROFILE_PORTRAIT_360P_3 = 1032, // 360x360 15
12502 VIDEO_PROFILE_PORTRAIT_360P_4 = 1033, // 360x640 30
12504 VIDEO_PROFILE_PORTRAIT_360P_6 = 1035, // 360x360 30
12506 VIDEO_PROFILE_PORTRAIT_360P_7 = 1036, // 360x480 15
12508 VIDEO_PROFILE_PORTRAIT_360P_8 = 1037, // 360x480 30
12510 VIDEO_PROFILE_PORTRAIT_360P_9 = 1038, // 360x640 15
12516 VIDEO_PROFILE_PORTRAIT_480P = 1040, // 480x640 15
12518 VIDEO_PROFILE_PORTRAIT_480P_3 = 1042, // 480x480 15
12520 VIDEO_PROFILE_PORTRAIT_480P_4 = 1043, // 480x640 30
12522 VIDEO_PROFILE_PORTRAIT_480P_6 = 1045, // 480x480 30
12524 VIDEO_PROFILE_PORTRAIT_480P_8 = 1047, // 480x848 15
12526 VIDEO_PROFILE_PORTRAIT_480P_9 = 1048, // 480x848 30
12530 VIDEO_PROFILE_PORTRAIT_720P = 1050, // 720x1280 15
12532 VIDEO_PROFILE_PORTRAIT_720P_3 = 1052, // 720x1280 30
12534 VIDEO_PROFILE_PORTRAIT_720P_5 = 1054, // 720x960 15
12536 VIDEO_PROFILE_PORTRAIT_720P_6 = 1055, // 720x960 30
12538 VIDEO_PROFILE_PORTRAIT_1080P = 1060, // 1080x1920 15
12540 VIDEO_PROFILE_PORTRAIT_1080P_3 = 1062, // 1080x1920 30
12542 VIDEO_PROFILE_PORTRAIT_1080P_5 = 1064, // 1080x1920 60
12544 VIDEO_PROFILE_PORTRAIT_1440P = 1066, // 1440x2560 30
12546 VIDEO_PROFILE_PORTRAIT_1440P_2 = 1067, // 1440x2560 60
12548 VIDEO_PROFILE_PORTRAIT_4K = 1070, // 2160x3840 30
12550 VIDEO_PROFILE_PORTRAIT_4K_3 = 1072, // 2160x3840 60
12553};
12554
12555class AAudioDeviceManager : public agora::util::AutoPtr<IAudioDeviceManager> {
12556 public:
12560};
12561
12562class AVideoDeviceManager : public agora::util::AutoPtr<IVideoDeviceManager> {
12563 public:
12567};
12568
12569} // namespace rtc
12570} // namespace agora
12571
12577#define getAgoraRtcEngineVersion getAgoraSdkVersion
12578
12580
12584
12595
12597
12599
12605#define getAgoraRtcEngineErrorDescription getAgoraSdkErrorDescription
12606#define setAgoraRtcEngineExternalSymbolLoader setAgoraSdkExternalSymbolLoader
Definition AgoraOptional.h:413
Definition AgoraRefPtr.h:31
Definition AgoraRefPtr.h:44
Definition AgoraBase.h:8145
Definition AgoraMediaBase.h:1881
AAudioDeviceManager(IRtcEngine *engine)
Definition IAgoraRtcEngine.h:12557
AVideoDeviceManager(IRtcEngine *engine)
Definition IAgoraRtcEngine.h:12564
Definition AgoraBase.h:6949
Definition IAgoraRtcEngine.h:4429
virtual void onDirectCdnStreamingStats(const DirectCdnStreamingStats &stats)
Reports the CDN streaming statistics.
Definition IAgoraRtcEngine.h:4463
virtual void onDirectCdnStreamingStateChanged(DIRECT_CDN_STREAMING_STATE state, DIRECT_CDN_STREAMING_REASON reason, const char *message)
Occurs when the CDN streaming state changes.
Definition IAgoraRtcEngine.h:4447
virtual ~IDirectCdnStreamingEventHandler()
Definition IAgoraRtcEngine.h:4431
Definition IAgoraRtcEngine.h:4212
METADATA_TYPE
Metadata type of the observer. We only support video metadata for now.
Definition IAgoraRtcEngine.h:4220
@ UNKNOWN_METADATA
Definition IAgoraRtcEngine.h:4224
@ VIDEO_METADATA
Definition IAgoraRtcEngine.h:4228
virtual ~IMetadataObserver()
Definition IAgoraRtcEngine.h:4214
virtual void onMetadataReceived(const Metadata &metadata)=0
Occurs when the local user receives the metadata.
virtual int getMaxMetadataSize()
Occurs when the SDK requests the maximum size of the metadata.
Definition IAgoraRtcEngine.h:4283
MAX_METADATA_SIZE_TYPE
Definition IAgoraRtcEngine.h:4234
@ MAX_METADATA_SIZE_IN_BYTE
Definition IAgoraRtcEngine.h:4237
@ DEFAULT_METADATA_SIZE_IN_BYTE
Definition IAgoraRtcEngine.h:4236
@ INVALID_METADATA_SIZE_IN_BYTE
Definition IAgoraRtcEngine.h:4235
virtual bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type)=0
Occurs when the SDK is ready to send metadata.
Definition AgoraBase.h:4127
Definition IAgoraRtcEngine.h:1803
virtual void onUserMuteAudio(uid_t uid, bool muted)
Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) st...
Definition IAgoraRtcEngine.h:2456
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_REASON reason)
Occurs when the state of Media Push changes.
Definition IAgoraRtcEngine.h:3191
virtual void onFirstLocalAudioFramePublished(int elapsed)
Occurs when the first audio frame is published.
Definition IAgoraRtcEngine.h:2955
virtual void onTranscodingUpdated()
Occurs when the publisher's transcoding is updated.
Definition IAgoraRtcEngine.h:3221
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Occurs when the local user receives the data stream from the remote user.
Definition IAgoraRtcEngine.h:2803
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Reports the statistics of the local audio stream.
Definition IAgoraRtcEngine.h:2562
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height)
Occurs when the camera focus area changes.
Definition IAgoraRtcEngine.h:2620
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Reports the volume change of the audio device or app.
Definition IAgoraRtcEngine.h:3171
virtual void onLocalVideoTranscoderError(const TranscodingVideoStream &stream, VIDEO_TRANSCODER_ERROR error)
Occurs when there's an error during the local video mixing.
Definition IAgoraRtcEngine.h:3475
virtual const char * eventHandlerType() const
Definition IAgoraRtcEngine.h:1807
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed)
Occurs when the first local video frame is displayed on the local video view.
Definition IAgoraRtcEngine.h:2188
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated
Occurs when the SDK receives the first audio frame from a specific remote user.
Definition IAgoraRtcEngine.h:2996
virtual void onError(int err, const char *msg)
Reports an error during SDK runtime.
Definition IAgoraRtcEngine.h:1894
virtual void onExtensionStoppedWithContext(const ExtensionContext &context)
Occurs when the extension is disabled.
Definition IAgoraRtcEngine.h:3642
virtual void onChannelMediaRelayStateChanged(int state, int code)
Occurs when the state of the media stream relay changes.
Definition IAgoraRtcEngine.h:3243
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Occurs when a specific remote user enables/disables the local video capturing function.
Definition IAgoraRtcEngine.h:2533
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Occurs when the renderer receives the first frame of the remote video.
Definition IAgoraRtcEngine.h:2379
virtual void onAudioMixingPositionChanged(int64_t position)
Reports the playback progress of a music file.
Definition IAgoraRtcEngine.h:2043
virtual void onContentInspectResult(media::CONTENT_INSPECT_RESULT result)
Definition IAgoraRtcEngine.h:3073
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition IAgoraRtcEngine.h:2508
virtual void onIntraRequestReceived()
Definition IAgoraRtcEngine.h:2134
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Reports the transport-layer statistics of each remote audio stream.
Definition IAgoraRtcEngine.h:3294
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height)
Occurs when the camera exposure area changes.
Definition IAgoraRtcEngine.h:2641
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Occurs when the local audio stream state changes.
Definition IAgoraRtcEngine.h:3017
virtual void onMultipathStats(const MultipathStats &stats)
Callback for multipath transmission statistics.
Definition IAgoraRtcEngine.h:3687
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Reports the statistics of the local video stream.
Definition IAgoraRtcEngine.h:2577
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Occurs when the local user does not receive the data stream from the remote user.
Definition IAgoraRtcEngine.h:2828
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Occurs when the video size or rotation of a specified user changes.
Definition IAgoraRtcEngine.h:2261
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition IAgoraRtcEngine.h:2934
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Reports the last mile network probe result.
Definition IAgoraRtcEngine.h:1934
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Occurs when the local video stream state changes.
Definition IAgoraRtcEngine.h:2336
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition IAgoraRtcEngine.h:3597
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Occurs when the local user receives a mixed video stream carrying layout information.
Definition IAgoraRtcEngine.h:3581
virtual void onVideoStopped() __deprecated
Occurs when the video stops playing.
Definition IAgoraRtcEngine.h:2707
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated
Occurs when the SDK decodes the first remote audio frame for playback.
Definition IAgoraRtcEngine.h:2980
virtual void onAudioRoutingChanged(int routing)
Occurs when the local audio route changes.
Definition IAgoraRtcEngine.h:3231
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition IAgoraRtcEngine.h:3486
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Occurs when the user role or the audience latency level changes.
Definition IAgoraRtcEngine.h:3130
virtual void onCameraReady() __deprecated
Occurs when the camera turns on and is ready to capture the video.
Definition IAgoraRtcEngine.h:2607
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Reports the result of taking a video snapshot.
Definition IAgoraRtcEngine.h:3099
virtual void onProxyConnected(const char *channel, uid_t uid, PROXY_TYPE proxyType, const char *localProxyIp, int elapsed)
Reports the proxy connection state.
Definition IAgoraRtcEngine.h:1874
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Reports the statistics of the video stream sent by each remote users.
Definition IAgoraRtcEngine.h:2593
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Occurs when the first video frame is published.
Definition IAgoraRtcEngine.h:2216
virtual void onRdtStateChanged(uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition IAgoraRtcEngine.h:2864
virtual void onPermissionGranted(agora::rtc::PERMISSION_TYPE permissionType)
Definition IAgoraRtcEngine.h:3391
virtual void onRemoteSubscribeFallbackToAudioOnly(uid_t uid, bool isFallbackOrRecover)
Occurs when the remote media stream falls back to the audio-only stream due to poor network condition...
Definition IAgoraRtcEngine.h:3271
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Occurs when switching a user role fails.
Definition IAgoraRtcEngine.h:3150
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Reports the last mile network quality of each user in the channel.
Definition IAgoraRtcEngine.h:2122
virtual void onUserMuteVideo(uid_t uid, bool muted)
Occurs when a remote user stops or resumes publishing the video stream.
Definition IAgoraRtcEngine.h:2478
virtual void onMediaControlMessage(uid_t userId, const char *data, size_t length)
Occurs when the local user receives media control message sent by a remote user.
Definition IAgoraRtcEngine.h:2880
virtual void onAudioMixingFinished() __deprecated
Occurs when the playback of the local music file finishes.
Definition IAgoraRtcEngine.h:2058
virtual void onLocalVideoEvent(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_EVENT_TYPE event)
Occurs when the local video event occurs.
Definition IAgoraRtcEngine.h:2280
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user rejoins the channel.
Definition IAgoraRtcEngine.h:1849
virtual void onExtensionErrorWithContext(const ExtensionContext &context, int error, const char *message)
Occurs when the extension runs incorrectly.
Definition IAgoraRtcEngine.h:3660
virtual void onLocalUserRegistered(uid_t uid, const char *userAccount)
Occurs when the local user registers a user account.
Definition IAgoraRtcEngine.h:3408
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Occurs when a remote user enables or disables the video module.
Definition IAgoraRtcEngine.h:2498
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves...
Definition IAgoraRtcEngine.h:2434
virtual void onConnectionBanned() __deprecated
Occurs when the connection is banned by the Agora server.
Definition IAgoraRtcEngine.h:2784
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
Occurs when the state of virtual metronome changes.
Definition IAgoraRtcEngine.h:2740
virtual void onUserJoined(uid_t uid, int elapsed)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins ...
Definition IAgoraRtcEngine.h:2410
virtual void onLeaveChannel(const RtcStats &stats)
Occurs when a user leaves a channel.
Definition IAgoraRtcEngine.h:1995
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Occurs when the video device state changes.
Definition IAgoraRtcEngine.h:2086
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Occurs when the remote audio state changes.
Definition IAgoraRtcEngine.h:3041
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo &info)
Occurs when the uplink network information changes.
Definition IAgoraRtcEngine.h:2148
virtual void onRtmpStreamingEvent(const char *url, RTMP_STREAMING_EVENT eventCode)
Reports events during the Media Push.
Definition IAgoraRtcEngine.h:3205
virtual void onRequestToken()
Occurs when the token expires.
Definition IAgoraRtcEngine.h:2903
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Reports the volume information of users.
Definition IAgoraRtcEngine.h:1974
virtual ~IRtcEngineEventHandler()
Definition IAgoraRtcEngine.h:1805
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Reports the transport-layer statistics of each remote video stream.
Definition IAgoraRtcEngine.h:3318
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user joins a channel.
Definition IAgoraRtcEngine.h:1829
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)
Callback for renewToken call result.
Definition IAgoraRtcEngine.h:3704
virtual void onAudioEffectFinished(int soundId)
Occurs when the playback of the local music file finishes.
Definition IAgoraRtcEngine.h:2069
virtual void onConnectionLost()
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the se...
Definition IAgoraRtcEngine.h:2757
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
Reports the statistics of the audio stream sent by each remote user.
Definition IAgoraRtcEngine.h:1917
virtual void onRdtMessage(uid_t userId, RdtStreamType type, const char *data, size_t length)
Occurs when the local user receives data via Reliable Data Transmission (RDT) from a remote user.
Definition IAgoraRtcEngine.h:2849
virtual void onPermissionError(PERMISSION_TYPE permissionType)
Occurs when the SDK cannot get the device permission.
Definition IAgoraRtcEngine.h:3382
virtual void onTokenPrivilegeWillExpire(const char *token)
Occurs when the token expires in 30 seconds.
Definition IAgoraRtcEngine.h:2925
virtual void onConnectionInterrupted() __deprecated
Occurs when the connection between the SDK and the server is interrupted.
Definition IAgoraRtcEngine.h:2777
virtual void onLastmileQuality(int quality)
Reports the last-mile network quality of the local user.
Definition IAgoraRtcEngine.h:2165
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition IAgoraRtcEngine.h:3436
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Occurs when the SDK gets the user ID and user account of the remote user.
Definition IAgoraRtcEngine.h:3425
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Occurs when the audio device state changes.
Definition IAgoraRtcEngine.h:2023
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Reports the built-in encryption errors.
Definition IAgoraRtcEngine.h:3368
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Occurs when the first remote video frame is received and decoded.
Definition IAgoraRtcEngine.h:2242
virtual void onRtcStats(const RtcStats &stats)
Reports the statistics about the current call.
Definition IAgoraRtcEngine.h:2007
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason)
Occurs when the playback state of the music file changes.
Definition IAgoraRtcEngine.h:2720
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the audio subscribing state changes.
Definition IAgoraRtcEngine.h:3502
virtual void onActiveSpeaker(uid_t uid)
Occurs when the most active remote speaker is detected.
Definition IAgoraRtcEngine.h:3065
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Occurs when the remote video stream state changes.
Definition IAgoraRtcEngine.h:2356
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the video publishing state changes.
Definition IAgoraRtcEngine.h:3554
virtual void onExtensionEventWithContext(const ExtensionContext &context, const char *key, const char *value)
The event callback of the extension.
Definition IAgoraRtcEngine.h:3614
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the video subscribing state changes.
Definition IAgoraRtcEngine.h:3520
virtual void onExtensionStartedWithContext(const ExtensionContext &context)
Occurrs when the extension is enabled.
Definition IAgoraRtcEngine.h:3629
virtual void onFacePositionChanged(int imageWidth, int imageHeight, const Rectangle *vecRectangle, const int *vecDistance, int numFaces)
Reports the face detection result of the local user.
Definition IAgoraRtcEngine.h:2686
virtual void onSetRtmFlagResult(int code)
Definition IAgoraRtcEngine.h:3672
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Video frame rendering event callback.
Definition IAgoraRtcEngine.h:3457
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Occurs when the network connection state changes.
Definition IAgoraRtcEngine.h:3336
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the audio publishing state changes.
Definition IAgoraRtcEngine.h:3537
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Occurs when the local network type changes.
Definition IAgoraRtcEngine.h:3354
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Reports the transport-layer statistics of each remote audio stream.
Definition IAgoraRtcEngine.h:2549
Definition IAgoraRtcEngine.h:4628
virtual int setLocalAccessPoint(const LocalAccessPointConfiguration &config)=0
Configures the connection to Agora's Private Media Server access module.
virtual int muteRemoteVideoStream(uid_t uid, bool mute)=0
Stops or resumes subscribing to the video stream of a specified user.
virtual int preloadEffect(int soundId, const char *filePath, int startPos=0)=0
Preloads a specified audio effect file into the memory.
virtual int setVolumeOfEffect(int soundId, int volume)=0
Gets the volume of a specified audio effect file.
virtual int muteLocalAudioStream(bool mute)=0
Stops or resumes publishing the local audio stream.
virtual int startScreenCaptureByDisplayId(int64_t displayId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
Captures the screen by specifying the display ID.
virtual int setScreenCaptureContentHint(VIDEO_CONTENT_HINT contentHint)=0
Sets the content hint for screen sharing.
virtual int getFaceShapeAreaOptions(agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Gets the facial beauty area options.
virtual int updateScreenCapture(const ScreenCaptureParameters2 &captureParams)=0
Updates the screen capturing parameters.
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
Registers a user account.
virtual int getEffectsVolume()=0
Retrieves the volume of the audio effects.
virtual int startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0
Starts Media Push and sets the transcoding configuration.
virtual int startScreenCaptureByWindowId(int64_t windowId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
Captures the whole or part of a window by specifying the window ID.
virtual int joinChannelWithUserAccountEx(const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
Join a channel using a user account and token, and set the media options.
virtual int setCameraTorchOn(bool isOn)=0
Enables the camera flash.
virtual int setSubscribeAudioBlocklist(uid_t *uidList, int uidNumber)=0
Sets the blocklist of subscriptions for audio streams.
virtual int enableCustomAudioLocalPlayback(track_id_t trackId, bool enabled)=0
Sets whether to enable the local playback of external audio source.
virtual int setExternalMediaProjection(void *mediaProjection)=0
Configures MediaProjection outside of the SDK to capture screen video streams.
virtual int joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
Joins a channel with a User Account and Token.
virtual int setAudioMixingPlaybackSpeed(int speed)=0
Sets the playback speed of the current audio file.
virtual int enableLocalVideo(bool enabled)=0
Enables/Disables the local video capture.
virtual int getExtensionProperty(const char *provider, const char *extension, const char *key, char *value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
Gets detailed information on the extensions.
virtual int disableAudio()=0
Disables the audio module.
virtual int setCameraAutoExposureFaceModeEnabled(bool enabled)=0
Sets whether to enable auto exposure.
virtual int setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario)=0
Sets the screen sharing scenario.
virtual int setSubscribeAudioAllowlist(uid_t *uidList, int uidNumber)=0
Sets the allowlist of subscriptions for audio streams.
virtual int stopDirectCdnStreaming()=0
Stops pushing media streams to the CDN directly.
virtual int setLogFileSize(unsigned int fileSizeInKBytes)=0
Sets the log file size.
virtual int selectAudioTrack(int index)=0
Selects the audio track used during playback.
virtual int enableAudioVolumeIndication(int interval, int smooth, bool reportVad)=0
Enables the reporting of users' volume indication.
virtual int updateLocalAudioMixerConfiguration(const LocalAudioMixerConfiguration &config)=0
Updates the configurations for mixing audio streams locally.
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
Registers an audio spectrum observer.
virtual int setAudioMixingPitch(int pitch)=0
Sets the pitch of the local music file.
virtual int stopAudioFrameDump(const char *channel_id, uid_t uid, const char *location)=0
virtual int startRhythmPlayer(const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
Enables the virtual metronome.
virtual int stopCameraCapture(VIDEO_SOURCE_TYPE sourceType)=0
Stops camera capture.
virtual bool isCameraZoomSupported()=0
Checks whether the device supports camera zoom.
virtual int setAINSMode(bool enabled, AUDIO_AINS_MODE mode)=0
Sets whether to enable the AI ​​noise suppression function and set the noise suppression mode.
virtual int setRemoteRenderMode(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
Updates the display mode of the video view of a remote user.
virtual int stopAudioMixing()=0
Stops playing the music file.
virtual int startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
Starts client-side audio recording and sets the recording sample rate.
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode)=0
Sets the dual-stream mode on the sender side.
virtual int setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
Sets the format of the captured raw audio data.
virtual int setEnableSpeakerphone(bool speakerOn)=0
Enables/Disables the audio route to the speakerphone.
virtual int setFaceShapeBeautyOptions(bool enabled, const FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets the face shape options and specifies the media source.
virtual int resumeAllEffects()=0
Resumes playing all audio effect files.
virtual agora_refptr< IVideoEffectObject > createVideoEffectObject(const char *bundlePath, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Creates a video effect object.
virtual int queryCodecCapability(CodecCapInfo *codecInfo, int &size)=0
Queries the video codec capabilities of the SDK.
virtual int uploadLogFile(agora::util::AString &requestId)=0
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
Sets dual-stream mode configuration on the sender side.
virtual int getFaceShapeBeautyOptions(FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Gets the beauty effect options.
virtual const char * getVersion(int *build)=0
Gets the SDK version.
virtual int addVideoWatermark(const char *watermarkUrl, const WatermarkOptions &options)=0
Adds a watermark image to the local video.
virtual int setBeautyEffectOptions(bool enabled, const BeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets the image enhancement options.
virtual int setEarMonitoringAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
Sets the format of the in-ear monitoring raw audio data.
virtual int enableVideoImageSource(bool enable, const ImageTrackOptions &options)=0
Sets whether to replace the current video feeds with images when publishing video streams.
virtual int setSimulcastConfig(const SimulcastConfig &simulcastConfig)=0
Sets the simulcast video stream configuration.
virtual int startEchoTest(const EchoTestConfiguration &config)=0
Starts an audio device loopback test.
virtual int startLocalAudioMixer(const LocalAudioMixerConfiguration &config)=0
Starts local audio mixing.
virtual int startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
Starts client-side audio recording and sets the recording sample rate.
virtual int pauseEffect(int soundId)=0
Pauses a specified audio effect file.
virtual int setHeadphoneEQPreset(HEADPHONE_EQUALIZER_PRESET preset)=0
Sets the preset headphone equalization effect.
virtual int muteRecordingSignal(bool mute)=0
Whether to mute the recording signal.
virtual int muteRemoteAudioStream(uid_t uid, bool mute)=0
Stops or resumes subscribing to the audio stream of a specified user.
virtual int joinChannel(const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
Joins a channel with media options.
virtual int startLocalVideoTranscoder(const LocalTranscoderConfiguration &config)=0
Starts the local video mixing.
virtual int enableDualStreamMode(bool enabled) __deprecated=0
Enables or disables dual-stream mode on the sender side.
virtual int setInEarMonitoringVolume(int volume)=0
Sets the volume of the in-ear monitor.
virtual bool isCameraTorchSupported()=0
Checks whether the device supports camera flash.
virtual int stopLocalVideoTranscoder()=0
Stops the local video mixing.
virtual int updateChannelMediaOptions(const ChannelMediaOptions &options)=0
Updates the channel media options after joining the channel.
virtual int setColorEnhanceOptions(bool enabled, const ColorEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets color enhancement.
virtual int setLocalVoicePitch(double pitch)=0
Changes the voice pitch of the local speaker.
virtual int queryDeviceScore()=0
Queries device score.
virtual int enableCameraCenterStage(bool enabled)=0
Enables or disables portrait center stage.
virtual int switchCamera()=0
Switches between front and rear cameras.
virtual int startMediaRenderingTracing()=0
Enables tracing the video frame rendering process.
virtual int setHeadphoneEQParameters(int lowGain, int highGain)=0
Sets the low- and high-frequency parameters of the headphone equalizer.
virtual int playEffect(int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false, int startPos=0)=0
Plays the specified local or online audio effect file.
virtual int setVoiceConversionParameters(VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
virtual int addVideoWatermark(const RtcImage &watermark) __deprecated=0
Adds a watermark image to the local video.
virtual int setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value)=0
Sets the local voice reverberation.
virtual int getEffectDuration(const char *filePath)=0
Retrieves the duration of the audio effect file.
virtual int setAudioMixingDualMonoMode(media::AUDIO_MIXING_DUAL_MONO_MODE mode)=0
Sets the channel mode of the current audio file.
virtual bool isCameraCenterStageSupported()=0
Checks if the camera supports portrait center stage.
virtual CONNECTION_STATE_TYPE getConnectionState()=0
Gets the current connection state of the SDK.
virtual int setExtensionProviderProperty(const char *provider, const char *key, const char *value)=0
Sets the properties of the extension provider.
virtual int leaveChannel()=0
Leaves a channel.
virtual int setLocalVoiceFormant(double formantRatio)=0
Sets the formant ratio to change the timbre of human voice.
virtual int adjustAudioMixingVolume(int volume)=0
Adjusts the volume during audio mixing.
virtual int enableMultiCamera(bool enabled, const CameraCapturerConfiguration &config)=0
Enables or disables multi-camera capture.
virtual int resumeAudio() __deprecated=0
virtual int setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0
Sets a preset voice beautifier effect.
virtual int setRemoteUserSpatialAudioParams(uid_t uid, const agora::SpatialAudioParams &params)=0
Sets the spatial audio effect parameters of the remote user.
virtual int createDataStream(int *streamId, bool reliable, bool ordered)=0
Creates a data stream.
virtual int takeSnapshot(uid_t uid, const char *filePath)=0
Takes a snapshot of a video stream.
virtual int resumeAudioMixing()=0
Resumes playing and mixing the music file.
virtual int enableWebSdkInteroperability(bool enabled) __deprecated=0
Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios.
virtual int destroyCustomVideoTrack(video_track_id_t video_track_id)=0
Destroys the specified video track.
virtual int addVideoWatermark(const WatermarkConfig &configs)=0
Adds a watermark image to the local video.
virtual int setFilterEffectOptions(bool enabled, const FilterEffectOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets the filter effect options and specifies the media source.
virtual int setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0
Sets an SDK preset audio effect.
virtual int setRemoteRenderRotation(uid_t uid, VIDEO_ORIENTATION rotation)=0
virtual int setCameraExposureFactor(float factor)=0
Sets the camera exposure value.
virtual int resumeEffect(int soundId)=0
Resumes playing a specified audio effect.
virtual int pauseAllChannelMediaRelay()=0
Pauses the media stream relay to all target channels.
virtual int setCameraZoomFactor(float factor)=0
Sets the camera zoom factor.
virtual int getAudioMixingDuration()=0
Retrieves the duration (ms) of the music file.
virtual int writeLog(commons::LOG_LEVEL level, const char *fmt,...)=0
virtual int enableExtension(const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
Enables or disables extensions.
virtual int setDirectCdnStreamingVideoConfiguration(const VideoEncoderConfiguration &config)=0
Sets the video profile of the media streams directly pushed to the CDN by the host.
virtual int setAudioMixingPosition(int pos)=0
Sets the audio mixing position.
virtual int adjustCustomAudioPlayoutVolume(track_id_t trackId, int volume)=0
Adjusts the volume of the custom audio track played locally.
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
Unregisters the audio spectrum observer.
virtual int setHighPriorityUserList(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option)=0
virtual int sendStreamMessage(int streamId, const char *data, size_t length)=0
Sends data stream messages.
virtual int enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Enables/Disables the virtual background.
virtual int updateLocalTranscoderConfiguration(const LocalTranscoderConfiguration &config)=0
Updates the local video mixing configuration.
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
Turns on audio spectrum monitoring.
virtual int destroyMediaPlayer(agora_refptr< IMediaPlayer > media_player)=0
Destroys the media player instance.
virtual int queryInterface(INTERFACE_ID_TYPE iid, void **inter)=0
Gets the pointer to the specified interface.
virtual int setRemoteRenderTargetFps(int targetFps)=0
Sets the maximum frame rate for rendering remote video.
virtual int setupLocalVideo(const VideoCanvas &canvas)=0
Initializes the local video view.
virtual int rate(const char *callId, int rating, const char *description)=0
Allows a user to rate a call after the call ends.
virtual int muteLocalVideoStream(bool mute)=0
Stops or resumes publishing the local video stream.
virtual int pauseAudio() __deprecated=0
virtual int stopScreenCapture()=0
Stops screen capture.
virtual int getUserInfoByUid(uid_t uid, rtc::UserInfo *userInfo)=0
Gets the user information by passing in the user ID.
virtual const char * getErrorDescription(int code)=0
Gets the warning or error description.
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType)=0
Sets the video stream type to subscribe to.
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
Sets the audio profile and audio scenario.
virtual int enableVideo()=0
Enables the video module.
virtual int getAudioTrackCount()=0
Gets the index of audio tracks of the current music file.
virtual int setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
Sets the user role and the audience latency level in a live streaming scenario.
virtual int setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker)=0
Sets the default audio playback route.
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
Sets audio scenarios.
virtual int startScreenCapture(const ScreenCaptureParameters2 &captureParams)=0
Starts screen capture.
virtual int registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
Registers the metadata observer.
virtual int destroyCustomEncodedVideoTrack(video_track_id_t video_track_id)=0
virtual int startScreenCaptureByScreenRect(const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams) __deprecated=0
Captures the whole or part of a screen by specifying the screen rect.
virtual int adjustAudioMixingPlayoutVolume(int volume)=0
Adjusts the volume of audio mixing for local playback.
virtual int updateRtmpTranscoding(const LiveTranscoding &transcoding)=0
Updates the transcoding configuration.
virtual int enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0
Enables loopback audio capturing.
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle)=0
Starts playing the music file.
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode) __deprecated=0
Updates the display mode of the local video view.
virtual int stopAllEffects()=0
Stops playing all audio effects.
virtual int startAudioMixing(const char *filePath, bool loopback, int cycle, int startPos)=0
Starts playing the music file.
virtual int preloadChannel(const char *token, const char *channelId, uid_t uid)=0
Preloads a channel with token, channelId, and uid.
virtual int muteAllRemoteVideoStreams(bool mute)=0
Stops or resumes subscribing to the video streams of all remote users.
virtual int setClientRole(CLIENT_ROLE_TYPE role)=0
Sets the client role.
virtual int getNetworkType()=0
Gets the type of the local network connection.
virtual int preloadChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0
Preloads a channel with token, channelId, and userAccount.
virtual int setFaceShapeAreaOptions(const FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets the image enhancement options for facial areas and specifies the media source.
virtual int queryHDRCapability(VIDEO_MODULE_TYPE videoModule, HDR_CAPABILITY &capability)=0
Queries the HDR capability of the video module.
virtual int setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
Sets the local voice equalization effect.
virtual int unloadAllEffects()=0
Releases a specified preloaded audio effect from the memory.
virtual int sendMediaControlMessage(uid_t uid, const char *data, size_t length)=0
Send media control message.
virtual int setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0
Sets the local video mirror mode.
virtual int renewToken(const char *token)=0
Renews the token.
virtual bool isFeatureAvailableOnDevice(FeatureType type)=0
Checks whether the device supports the specified advanced feature.
virtual bool isCameraAutoExposureFaceModeSupported()=0
Checks whether the device supports auto exposure.
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel, int samplesPerCall)=0
Sets the format of audio data in the onPlaybackAudioFrameBeforeMixing callback.
virtual int registerAudioEncodedFrameObserver(const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
Registers an encoded audio observer.
virtual int startDirectCdnStreaming(IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
Starts pushing media streams to the CDN directly.
virtual int resumeAllChannelMediaRelay()=0
Resumes the media stream relay to all target channels.
virtual int stopScreenCapture(VIDEO_SOURCE_TYPE sourceType)=0
Stops screen capture from the specified video source.
virtual video_track_id_t createCustomVideoTrack()=0
Creates a custom video track.
virtual int stopLastmileProbeTest()=0
Stops the last mile network probe test.
virtual int registerPacketObserver(IPacketObserver *observer)=0
Registers a packet observer.
virtual int adjustLoopbackSignalVolume(int volume)=0
Adjusts the volume of the signal captured by the sound card.
virtual int adjustPlaybackSignalVolume(int volume)=0
Adjusts the playback signal volume of all remote users.
virtual int enableAudio()=0
Enables the audio module.
virtual int setRemoteVideoSubscriptionOptions(uid_t uid, const VideoSubscriptionOptions &options)=0
Options for subscribing to remote video streams.
virtual int setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0
Sets the video encoder configuration.
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType)=0
Sets the default video stream type to subscribe to.
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig &streamConfig) __deprecated=0
Sets the dual-stream mode on the sender side and the low-quality video stream.
virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type)=0
Enables or disables the voice AI tuner.
virtual int setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2)=0
Sets parameters for SDK preset audio effects.
virtual int adjustAudioMixingPublishVolume(int volume)=0
Adjusts the volume of audio mixing for publishing.
virtual int setExtensionProperty(const char *provider, const char *extension, const char *key, const char *value, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
Sets the properties of the extension.
virtual int setCameraFocusPositionInPreview(float positionX, float positionY)=0
Sets the camera manual focus position.
virtual bool isCameraFocusSupported()=0
Check whether the device supports the manual focus function.
virtual int getExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, char *value, int buf_len)=0
virtual int setCameraAutoFocusFaceModeEnabled(bool enabled)=0
Enables the camera auto-face focus function.
virtual int unloadEffect(int soundId)=0
Releases a specified preloaded audio effect from the memory.
virtual int setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
Sets the format of the raw audio playback data.
virtual int enableLocalAudio(bool enabled)=0
Enables or disables the local audio capture.
virtual int getAudioMixingPublishVolume()=0
Retrieves the audio mixing volume for publishing.
virtual int setAdvancedAudioOptions(AdvancedAudioOptions &options, int sourceType=0)=0
Sets audio advanced options.
static AGORA_CPP_API void release(RtcEngineReleaseCallback callback=nullptr)
Releases the IRtcEngine instance.
virtual IScreenCaptureSourceList * getScreenCaptureSources(const SIZE &thumbSize, const SIZE &iconSize, const bool includeScreen)=0
Gets a list of shareable screens and windows.
virtual int setCameraCapturerConfiguration(const CameraCapturerConfiguration &config)=0
Sets the camera capture configuration.
virtual int setChannelProfile(CHANNEL_PROFILE_TYPE profile)=0
Sets the channel profile.
virtual int setDirectCdnStreamingAudioConfiguration(AUDIO_PROFILE_TYPE profile)=0
Sets the audio profile of the audio streams directly pushed to the CDN by the host.
virtual int startPreview()=0
Enables the local video preview.
virtual int adjustCustomAudioPublishVolume(track_id_t trackId, int volume)=0
Adjusts the volume of the custom audio track played remotely.
virtual int getAudioMixingCurrentPosition()=0
Retrieves the playback position (ms) of the music file.
virtual bool isSpeakerphoneEnabled()=0
Checks whether the speakerphone is enabled.
virtual bool unregisterEventHandler(IRtcEngineEventHandler *eventHandler)=0
virtual int updateDirectCdnStreamingMediaOptions(const DirectCdnStreamingMediaOptions &options)=0
virtual int registerExtension(const char *provider, const char *extension, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
Registers an extension.
virtual int disableAudioSpectrumMonitor()=0
Disables audio spectrum monitoring.
virtual int setCameraDeviceOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
Sets the rotation angle of the captured video.
virtual int stopPreview()=0
Stops the local video preview.
virtual int setVideoDenoiserOptions(bool enabled, const VideoDenoiserOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets video noise reduction.
virtual int stopRhythmPlayer()=0
Disables the virtual metronome.
virtual int enableInEarMonitoring(bool enabled, int includeAudioFilters)=0
Enables in-ear monitoring.
virtual int enableInstantMediaRendering()=0
Enables audio and video frame instant rendering.
virtual int stopChannelMediaRelay()=0
Stops the media stream relay. Once the relay stops, the host quits all the target channels.
virtual int getVolumeOfEffect(int soundId)=0
Gets the volume of a specified audio effect file.
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig &config)=0
Configures the virtual metronome.
virtual int complain(const char *callId, const char *description)=0
Allows a user to complain about the call quality after a call ends.
virtual int pauseAudioMixing()=0
Pauses playing and mixing the music file.
virtual int setAVSyncSource(const char *channelId, uid_t uid)=0
Sets audio-video synchronization for the sender.
virtual int stopRtmpStream(const char *url)=0
Stops pushing media streams to a CDN.
virtual int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish=false)=0
Plays all audio effect files.
virtual bool isCameraExposurePositionSupported()=0
Checks whether the device supports manual exposure.
virtual int setLowlightEnhanceOptions(bool enabled, const LowlightEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
Sets low-light enhancement.
virtual int setCameraStabilizationMode(CAMERA_STABILIZATION_MODE mode)=0
Sets the camera stabilization mode.
virtual int getEffectCurrentPosition(int soundId)=0
Retrieves the playback position of the audio effect file.
virtual int sendRdtMessage(uid_t uid, RdtStreamType type, const char *data, size_t length)=0
Send Reliable message to remote uid in channel.
virtual int destroyVideoEffectObject(agora_refptr< IVideoEffectObject > videoEffectObject)=0
Destroys a video effect object.
virtual int setRouteInCommunicationMode(int route)=0
Selects the audio playback route in communication audio mode.
virtual int adjustUserPlaybackSignalVolume(uid_t uid, int volume)=0
Adjusts the playback signal volume of a specified remote user.
virtual int muteAllRemoteAudioStreams(bool mute)=0
Stops or resumes subscribing to the audio streams of all remote users.
virtual int enableContentInspect(bool enabled, const media::ContentInspectConfig &config)=0
Enables or disables video screenshot and upload.
virtual int setupRemoteVideo(const VideoCanvas &canvas)=0
Initializes the video view of a remote user.
virtual int setSubscribeVideoBlocklist(uid_t *uidList, int uidNumber)=0
Sets the blocklist of subscriptions for video streams.
virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo *focalLengthInfos, int &size)=0
Queries the focal length capability supported by the camera.
virtual int enableSoundPositionIndication(bool enabled)=0
Enables or disables stereo panning for remote users.
virtual int stopPreview(VIDEO_SOURCE_TYPE sourceType)=0
Stops the local video preview.
virtual int destroyMediaRecorder(agora_refptr< IMediaRecorder > mediaRecorder)=0
Destroys an audio and video recording object.
virtual int64_t getCurrentMonotonicTimeInMs()=0
Gets the current Monotonic Time of the SDK.
virtual int setRemoteVoicePosition(uid_t uid, double pan, double gain)=0
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
virtual int enableExtension(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, bool enable=true)=0
virtual int enableSpatialAudio(bool enabled)=0
Enables or disables the spatial audio effect.
virtual int initialize(const RtcEngineContext &context)=0
Initializes IRtcEngine.
virtual int disableVideo()=0
Disables the video module.
virtual int removeVideoWatermark(const char *id)=0
Removes the watermark image from the local video.
virtual int getLoopbackRecordingVolume()=0
virtual agora_refptr< IMediaRecorder > createMediaRecorder(const RecorderStreamInfo &info)=0
Creates an audio and video recording object.
virtual bool isCameraAutoFocusFaceModeSupported()=0
Checks whether the device supports the face auto-focus function.
virtual float getCameraMaxZoomFactor()=0
Gets the maximum zoom ratio supported by the camera.
virtual int getUserInfoByUserAccount(const char *userAccount, rtc::UserInfo *userInfo)=0
Gets the user information by passing in the user account.
virtual int startOrUpdateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0
Starts relaying media streams across channels or updates channels for media relay.
virtual int setEffectPosition(int soundId, int pos)=0
Sets the playback position of an audio effect file.
virtual int startAudioRecording(const AudioRecordingConfiguration &config)=0
Starts client-side audio recording with recording configuration.
virtual int unregisterMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
Unregisters the specified metadata observer.
virtual int getAudioDeviceInfo(DeviceInfo &deviceInfo)=0
Gets the audio device information.
virtual int createDataStream(int *streamId, const DataStreamConfig &config)=0
Creates a data stream.
virtual int adjustRecordingSignalVolume(int volume)=0
Adjusts the capturing signal volume.
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
Sets video application scenarios.
virtual int setLogFilter(unsigned int filter)=0
Sets the log output level of the SDK.
virtual int startRtmpStreamWithoutTranscoding(const char *url)=0
Starts pushing media streams to a CDN without transcoding.
virtual int startCameraCapture(VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration &config)=0
Starts camera capture.
virtual int startPreview(VIDEO_SOURCE_TYPE sourceType)=0
Enables the local video preview and specifies the video source for the preview.
virtual int enableFaceDetection(bool enabled)=0
Enables or disables face detection for the local user.
virtual bool isCameraFaceDetectSupported()=0
Checks whether the device camera supports face detection.
virtual int setLocalRenderMode(media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
Updates the display mode of the local video view.
virtual int queryScreenCaptureCapability()=0
Queries the highest frame rate supported by the device during screen sharing.
virtual int leaveChannel(const LeaveChannelOptions &options)=0
Sets channel options and leaves the channel.
virtual int enableEncryption(bool enabled, const EncryptionConfig &config)=0
Enables or disables the built-in encryption.
virtual int updateScreenCaptureParameters(const ScreenCaptureParameters &captureParams)=0
Updates the screen capturing parameters.
virtual int pauseAllEffects()=0
Pauses all audio effects.
virtual int stopEffect(int soundId)=0
Stops playing a specified audio effect.
virtual video_track_id_t createCustomEncodedVideoTrack(const SenderOptions &sender_option)=0
virtual int setCameraExposurePosition(float positionXinView, float positionYinView)=0
Sets the camera exposure position.
virtual int startScreenCapture(VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration &config)=0
Starts screen capture from the specified video source.
virtual int stopAudioRecording()=0
Stops client-side audio recording.
virtual int startLastmileProbeTest(const LastmileProbeConfig &config)=0
Starts the last mile network probe test.
virtual int joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0
Joins a channel.
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
virtual int setEffectsVolume(int volume)=0
Sets the volume of the audio effects.
virtual int setScreenCaptureOrientation(VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
virtual bool registerEventHandler(IRtcEngineEventHandler *eventHandler)=0
virtual int setLocalRenderTargetFps(VIDEO_SOURCE_TYPE sourceType, int targetFps)=0
Sets the maximum frame rate for rendering local video.
virtual int loadExtensionProvider(const char *path, bool unload_after_use=false)=0
Loads an extension.
virtual int updateScreenCaptureRegion(const Rectangle &regionRect)=0
Updates the screen capturing region.
virtual int setSubscribeVideoAllowlist(uid_t *uidList, int uidNumber)=0
Sets the allowlist of subscriptions for video streams.
virtual int setParameters(const char *parameters)=0
Provides technical preview functionalities or special customizations by configuring the SDK with JSON...
virtual uint64_t getNtpWallTimeInMs()=0
Gets the current NTP (Network Time Protocol) time.
virtual int setLogFile(const char *filePath)=0
Sets the log file.
virtual int stopEchoTest()=0
Stops the audio call test.
virtual int clearVideoWatermarks()=0
Removes the watermark image from the video stream.
virtual int sendAudioMetadata(const char *metadata, size_t length)=0
send audio metadata
virtual agora_refptr< IMediaPlayer > createMediaPlayer()=0
Creates a media player object.
virtual int setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority)=0
virtual int getAudioMixingPlayoutVolume()=0
Retrieves the audio mixing volume for local playback.
virtual int setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0
Sets a preset voice beautifier effect.
virtual int updatePreloadChannelToken(const char *token)=0
Updates the wildcard token for preloading channels.
virtual bool isCameraExposureSupported()=0
Queries whether the current camera supports adjusting exposure value.
virtual int startAudioFrameDump(const char *channel_id, uid_t uid, const char *location, const char *uuid, const char *passwd, long duration_ms, bool auto_upload)=0
virtual int setLogLevel(commons::LOG_LEVEL level)=0
Sets the output log level of the SDK.
virtual int setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction)=0
Sets the operational permission of the SDK on the audio session.
virtual int getCallId(agora::util::AString &callId)=0
Retrieves the call ID.
virtual int setPlaybackAudioFrameBeforeMixingParameters(int sampleRate, int channel)=0
Sets the format of the raw audio playback data before mixing.
virtual int setMixedAudioFrameParameters(int sampleRate, int channel, int samplesPerCall)=0
Sets the format of the raw audio data after mixing for audio capture and playback.
virtual int sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0
Reports customized messages.
virtual int setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0
Sets the fallback option for the subscribed video stream based on the network conditions.
virtual int setExtensionProperty(const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, const char *value)=0
virtual int stopLocalAudioMixer()=0
Stops the local audio mixing.
virtual int setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
Sets parameters for the preset voice beautifier effects.
virtual int setAudioProfile(AUDIO_PROFILE_TYPE profile)=0
Sets audio profiles.
virtual int setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0
Sets up cloud proxy service.
Definition IAgoraRtcEngine.h:1162
virtual unsigned int getCount()=0
Gets the number of shareable windows and screens.
virtual ~IScreenCaptureSourceList()
Definition IAgoraRtcEngine.h:1164
virtual ScreenCaptureSourceInfo getSourceInfo(unsigned int index)=0
Gets information about the specified shareable window or screen.
virtual void release()=0
Releases IScreenCaptureSourceList.
Definition IAgoraRtcEngine.h:3713
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual void release()=0
Releases all the resources occupied by the IVideoDeviceCollection object.
virtual int getDevice(int index, char deviceNameUTF8[MAX_DEVICE_ID_LENGTH], char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual int getCount()=0
Gets the total number of the indexed video devices in the system.
virtual ~IVideoDeviceCollection()
Definition IAgoraRtcEngine.h:3715
Definition IAgoraRtcEngine.h:3758
virtual int setDevice(const char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
virtual IVideoDeviceCollection * enumerateVideoDevices()=0
Enumerates the video devices.
virtual int getDevice(char deviceIdUTF8[MAX_DEVICE_ID_LENGTH])=0
Retrieves the current video capture device.
virtual ~IVideoDeviceManager()
Definition IAgoraRtcEngine.h:3760
virtual void release()=0
Releases all the resources occupied by the IVideoDeviceManager object.
virtual int startDeviceTest(view_t hwnd)=0
virtual int getCapability(const char *deviceIdUTF8, const uint32_t deviceCapabilityNumber, VideoFormat &capability)=0
Gets the detailed video frame information of the video capture device in the specified video format.
virtual int numberOfCapabilities(const char *deviceIdUTF8)=0
Gets the number of video formats supported by the specified video capture device.
Provides methods to manage and configure video effects, such as beauty, style makeup,...
Definition IAgoraRtcEngine.h:3885
VIDEO_EFFECT_NODE_ID
Types of applicable video effect nodes.
Definition IAgoraRtcEngine.h:3894
@ STYLE_MAKEUP
Definition IAgoraRtcEngine.h:3902
@ FILTER
Definition IAgoraRtcEngine.h:3906
@ BEAUTY
Definition IAgoraRtcEngine.h:3898
@ STICKER
Definition IAgoraRtcEngine.h:3910
virtual int setVideoEffectFloatParam(const char *option, const char *key, float param)=0
Sets the float parameter for video effects.
virtual float getVideoEffectFloatParam(const char *option, const char *key)=0
Retrieves float type parameters in video effects.
virtual int removeVideoEffect(uint32_t nodeId)=0
Removes the video effect with the specified node ID.
virtual int setVideoEffectIntParam(const char *option, const char *key, int param)=0
Sets an integer parameter for video effects.
virtual ~IVideoEffectObject()
Definition IAgoraRtcEngine.h:3887
virtual bool getVideoEffectBoolParam(const char *option, const char *key)=0
Gets the boolean parameter in video effects.
virtual int addOrUpdateVideoEffect(uint32_t nodeId, const char *templateName)=0
Adds or updates the video effect for the specified node ID and template.
VIDEO_EFFECT_ACTION
Actions that can be performed on video effect nodes.
Definition IAgoraRtcEngine.h:3918
@ SAVE
Definition IAgoraRtcEngine.h:3922
@ RESET
Definition IAgoraRtcEngine.h:3926
virtual int getVideoEffectIntParam(const char *option, const char *key)=0
Retrieves integer parameters in video effects.
virtual int performVideoEffectAction(uint32_t nodeId, VIDEO_EFFECT_ACTION actionId)=0
Performs an action on the specified video effect node.
virtual int setVideoEffectStringParam(const char *option, const char *key, const char *param)=0
Sets the string parameter for the video effect.
virtual int setVideoEffectBoolParam(const char *option, const char *key, bool param)=0
Sets the boolean parameter for video effects.
Definition AgoraBase.h:100
bool queryInterface(C1 *c, C2 iid)
Definition AgoraBase.h:138
AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine()
Creates one IRtcEngine object.
Definition IAgoraService.h:73
Definition channel_capability_i.h:14
OPTIONAL_ENUM_CLASS LOG_LEVEL
The output log level of the SDK.
Definition IAgoraLog.h:33
Definition builtin_extension_literal_def.h:10
RENDER_MODE_TYPE
Video display modes.
Definition AgoraMediaBase.h:588
Definition content_inspect_i.h:15
MEDIA_SOURCE_TYPE
Media source type.
Definition AgoraMediaBase.h:283
@ PRIMARY_CAMERA_SOURCE
Definition AgoraMediaBase.h:295
@ UNKNOWN_MEDIA_SOURCE
Definition AgoraMediaBase.h:343
CONTENT_INSPECT_RESULT
Definition AgoraMediaBase.h:1278
AUDIO_MIXING_DUAL_MONO_MODE
The channel mode.
Definition IAgoraMediaEngine.h:18
Definition AgoraExtensions.h:5
unsigned int video_track_id_t
Definition AgoraMediaBase.h:31
MEDIA_DEVICE_STATE_TYPE
Media device states.
Definition IAgoraRtcEngine.h:12381
@ MEDIA_DEVICE_STATE_IDLE
Definition IAgoraRtcEngine.h:12385
@ MEDIA_DEVICE_STATE_DISABLED
Definition IAgoraRtcEngine.h:12393
@ MEDIA_DEVICE_STATE_PLUGGED_IN
Definition IAgoraRtcEngine.h:12398
@ MEDIA_DEVICE_STATE_ACTIVE
Definition IAgoraRtcEngine.h:12389
@ MEDIA_DEVICE_STATE_NOT_PRESENT
Definition IAgoraRtcEngine.h:12403
@ MEDIA_DEVICE_STATE_UNPLUGGED
Definition IAgoraRtcEngine.h:12407
FeatureType
The type of the advanced feature.
Definition IAgoraRtcEngine.h:1756
@ VIDEO_BEAUTY_EFFECT
Definition IAgoraRtcEngine.h:1764
@ VIDEO_VIRTUAL_BACKGROUND
Definition IAgoraRtcEngine.h:1760
MEDIA_TRACE_EVENT
The rendering state of the media frame.
Definition AgoraBase.h:7827
SIMULCAST_STREAM_MODE
The mode in which the video stream is sent.
Definition AgoraBase.h:2296
AUDIO_EFFECT_PRESET
Preset audio effects.
Definition AgoraBase.h:6322
LOCAL_AUDIO_STREAM_STATE
The state of the local audio.
Definition AgoraBase.h:3491
VOICE_BEAUTIFIER_PRESET
The options for SDK preset voice beautifier effects.
Definition AgoraBase.h:6233
DIRECT_CDN_STREAMING_REASON
Reasons for the changes in CDN streaming status.
Definition IAgoraRtcEngine.h:4318
@ DIRECT_CDN_STREAMING_REASON_OK
Definition IAgoraRtcEngine.h:4323
@ DIRECT_CDN_STREAMING_REASON_BAD_NAME
Definition IAgoraRtcEngine.h:4350
@ DIRECT_CDN_STREAMING_REASON_FAILED
Definition IAgoraRtcEngine.h:4328
@ DIRECT_CDN_STREAMING_REASON_VIDEO_PUBLICATION
Definition IAgoraRtcEngine.h:4340
@ DIRECT_CDN_STREAMING_REASON_AUDIO_PUBLICATION
Definition IAgoraRtcEngine.h:4334
@ DIRECT_CDN_STREAMING_REASON_NET_CONNECT
Definition IAgoraRtcEngine.h:4345
AUDIO_SCENARIO_TYPE
The audio scenarios.
Definition AgoraBase.h:3210
@ AUDIO_SCENARIO_DEFAULT
Definition AgoraBase.h:3215
VIDEO_QOE_PREFERENCE_TYPE
Definition AgoraBase.h:3409
AUDIO_EQUALIZATION_BAND_FREQUENCY
The midrange frequency for audio equalization.
Definition IAgoraRtcEngine.h:196
@ AUDIO_EQUALIZATION_BAND_1K
Definition IAgoraRtcEngine.h:220
@ AUDIO_EQUALIZATION_BAND_16K
Definition IAgoraRtcEngine.h:236
@ AUDIO_EQUALIZATION_BAND_31
Definition IAgoraRtcEngine.h:200
@ AUDIO_EQUALIZATION_BAND_250
Definition IAgoraRtcEngine.h:212
@ AUDIO_EQUALIZATION_BAND_125
Definition IAgoraRtcEngine.h:208
@ AUDIO_EQUALIZATION_BAND_2K
Definition IAgoraRtcEngine.h:224
@ AUDIO_EQUALIZATION_BAND_62
Definition IAgoraRtcEngine.h:204
@ AUDIO_EQUALIZATION_BAND_500
Definition IAgoraRtcEngine.h:216
@ AUDIO_EQUALIZATION_BAND_8K
Definition IAgoraRtcEngine.h:232
@ AUDIO_EQUALIZATION_BAND_4K
Definition IAgoraRtcEngine.h:228
CONNECTION_CHANGED_REASON_TYPE
Reasons causing the change of the connection state.
Definition AgoraBase.h:5139
ENCRYPTION_ERROR_TYPE
Encryption error type.
Definition AgoraBase.h:7473
PROXY_TYPE
The cloud proxy type.
Definition IAgoraRtcEngine.h:1721
@ TCP_PROXY_AUTO_FALLBACK_TYPE
Definition IAgoraRtcEngine.h:1744
@ HTTPS_PROXY_TYPE
Definition IAgoraRtcEngine.h:1750
@ NONE_PROXY_TYPE
Definition IAgoraRtcEngine.h:1725
@ TCP_PROXY_TYPE
Definition IAgoraRtcEngine.h:1735
@ UDP_PROXY_TYPE
Definition IAgoraRtcEngine.h:1730
@ LOCAL_PROXY_TYPE
Definition IAgoraRtcEngine.h:1739
@ HTTP_PROXY_TYPE
Definition IAgoraRtcEngine.h:1747
MEDIA_DEVICE_TYPE
Media device types.
Definition IAgoraRtcEngine.h:40
@ VIDEO_CAPTURE_DEVICE
Definition IAgoraRtcEngine.h:60
@ AUDIO_VIRTUAL_PLAYOUT_DEVICE
Definition IAgoraRtcEngine.h:68
@ AUDIO_VIRTUAL_RECORDING_DEVICE
Definition IAgoraRtcEngine.h:72
@ AUDIO_PLAYOUT_DEVICE
Definition IAgoraRtcEngine.h:48
@ VIDEO_RENDER_DEVICE
Definition IAgoraRtcEngine.h:56
@ AUDIO_RECORDING_DEVICE
Definition IAgoraRtcEngine.h:52
@ AUDIO_APPLICATION_PLAYOUT_DEVICE
Definition IAgoraRtcEngine.h:64
@ UNKNOWN_AUDIO_DEVICE
Definition IAgoraRtcEngine.h:44
VIDEO_CONTENT_HINT
The content hint for screen sharing.
Definition AgoraBase.h:3296
CLIENT_ROLE_TYPE
The user role in the interactive live streaming.
Definition AgoraBase.h:3037
CONNECTION_STATE_TYPE
Connection states.
Definition AgoraBase.h:4528
AUDIO_SAMPLE_RATE_TYPE
The audio sampling rate of the stream to be pushed to the CDN.
Definition AgoraBase.h:4192
@ AUDIO_SAMPLE_RATE_48000
Definition AgoraBase.h:4204
PERMISSION_TYPE
The type of the device permission.
Definition AgoraBase.h:7553
void(*)() RtcEngineReleaseCallback
Callback triggered when IRtcEngine is released.
Definition IAgoraRtcEngine.h:4620
REMOTE_AUDIO_STATE_REASON
The reason for the remote audio state change.
Definition AgoraBase.h:3826
USER_OFFLINE_REASON_TYPE
Reasons for a user being offline.
Definition AgoraBase.h:969
STREAM_PUBLISH_STATE
The publishing state.
Definition AgoraBase.h:7606
CAMERA_DIRECTION
The camera direction.
Definition IAgoraRtcEngine.h:884
@ CAMERA_FRONT
Definition IAgoraRtcEngine.h:892
@ CAMERA_REAR
Definition IAgoraRtcEngine.h:888
VIDEO_STREAM_TYPE
The type of video streams.
Definition AgoraBase.h:1746
LOCAL_AUDIO_STREAM_REASON
Reasons for local audio state changes.
Definition AgoraBase.h:3513
DIRECT_CDN_STREAMING_STATE
The current CDN streaming state.
Definition IAgoraRtcEngine.h:4358
@ DIRECT_CDN_STREAMING_STATE_FAILED
Definition IAgoraRtcEngine.h:4381
@ DIRECT_CDN_STREAMING_STATE_RECOVERING
Definition IAgoraRtcEngine.h:4388
@ DIRECT_CDN_STREAMING_STATE_RUNNING
Definition IAgoraRtcEngine.h:4369
@ DIRECT_CDN_STREAMING_STATE_STOPPED
Definition IAgoraRtcEngine.h:4375
@ DIRECT_CDN_STREAMING_STATE_IDLE
Definition IAgoraRtcEngine.h:4363
AUDIO_AINS_MODE
AI noise suppression modes.
Definition AgoraBase.h:3139
unsigned int track_id_t
Definition AgoraMediaBase.h:29
AUDIO_PROFILE_TYPE
The audio profile.
Definition AgoraBase.h:3162
VIDEO_CODEC_TYPE
Video codec types.
Definition AgoraBase.h:1342
LOCAL_VIDEO_EVENT_TYPE
The local video event type.
Definition AgoraBase.h:3599
LOCAL_VIDEO_STREAM_STATE
Local video state types.
Definition AgoraBase.h:3575
REMOTE_VIDEO_STATE
The state of the remote video stream.
Definition AgoraBase.h:3872
AUDIO_MIXING_REASON_TYPE
The reason why the playback state of the music file changes. Reported in the onAudioMixingStateChange...
Definition IAgoraRtcEngine.h:108
@ AUDIO_MIXING_REASON_INTERRUPTED_EOF
Definition IAgoraRtcEngine.h:122
@ AUDIO_MIXING_REASON_RESUMED_BY_USER
Definition IAgoraRtcEngine.h:136
@ AUDIO_MIXING_REASON_STOPPED_BY_USER
Definition IAgoraRtcEngine.h:134
@ AUDIO_MIXING_REASON_OK
Definition IAgoraRtcEngine.h:140
@ AUDIO_MIXING_REASON_ALL_LOOPS_COMPLETED
Definition IAgoraRtcEngine.h:130
@ AUDIO_MIXING_REASON_CAN_NOT_OPEN
Definition IAgoraRtcEngine.h:113
@ AUDIO_MIXING_REASON_ONE_LOOP_COMPLETED
Definition IAgoraRtcEngine.h:126
@ AUDIO_MIXING_REASON_TOO_FREQUENT_CALL
Definition IAgoraRtcEngine.h:118
RTMP_STREAMING_EVENT
Events during the Media Push.
Definition AgoraBase.h:4426
@ AREA_CODE_GLOB
Definition AgoraBase.h:7034
static void SetFrom(Optional< T > *s, const Optional< T > &o)
Definition IAgoraRtcEngine.h:24
SCREEN_SCENARIO_TYPE
The screen sharing scenario.
Definition AgoraBase.h:3315
CLOUD_PROXY_TYPE
The cloud proxy type.
Definition IAgoraRtcEngine.h:900
@ UDP_PROXY
Definition IAgoraRtcEngine.h:910
@ NONE_PROXY
Definition IAgoraRtcEngine.h:905
RENEW_TOKEN_ERROR_CODE
Represents the error codes after calling renewToken.
Definition AgoraBase.h:7509
VIDEO_MIRROR_MODE_TYPE
Video mirror mode.
Definition AgoraBase.h:1998
@ VIDEO_MIRROR_MODE_DISABLED
Definition AgoraBase.h:2013
AUDIO_RECORDING_QUALITY_TYPE
Recording quality.
Definition AgoraBase.h:6782
RdtState
Reliable Data Transmission tunnel state.
Definition AgoraBase.h:8114
PRIORITY_TYPE
Definition IAgoraRtcEngine.h:296
@ PRIORITY_HIGH
Definition IAgoraRtcEngine.h:299
@ PRIORITY_NORMAL
Definition IAgoraRtcEngine.h:302
RTMP_STREAM_PUBLISH_REASON
Reasons for changes in the status of RTMP or RTMPS streaming.
Definition AgoraBase.h:4344
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition AgoraBase.h:8090
RTMP_STREAM_PUBLISH_STATE
States of the Media Push.
Definition AgoraBase.h:4305
LOCAL_VIDEO_STREAM_REASON
Reasons for local video state changes.
Definition AgoraBase.h:3630
CLIENT_ROLE_CHANGE_FAILED_REASON
The reason for a user role switch failure.
Definition AgoraBase.h:5277
@ __deprecated
Definition AgoraBase.h:1030
INJECT_STREAM_STATUS
Definition IAgoraRtcEngine.h:146
@ INJECT_STREAM_STATUS_STOP_SUCCESS
Definition IAgoraRtcEngine.h:170
@ INJECT_STREAM_STATUS_START_FAILED
Definition IAgoraRtcEngine.h:166
@ INJECT_STREAM_STATUS_STOP_TIMEDOUT
Definition IAgoraRtcEngine.h:182
@ INJECT_STREAM_STATUS_STOP_FAILED
Definition IAgoraRtcEngine.h:186
@ INJECT_STREAM_STATUS_START_SUCCESS
Definition IAgoraRtcEngine.h:150
@ INJECT_STREAM_STATUS_BROKEN
Definition IAgoraRtcEngine.h:190
@ INJECT_STREAM_STATUS_STOP_NOT_FOUND
Definition IAgoraRtcEngine.h:174
@ INJECT_STREAM_STATUS_START_TIMEDOUT
Definition IAgoraRtcEngine.h:162
@ INJECT_STREAM_STATUS_START_UNAUTHORIZED
Definition IAgoraRtcEngine.h:158
@ INJECT_STREAM_STATUS_START_ALREADY_EXISTS
Definition IAgoraRtcEngine.h:154
@ INJECT_STREAM_STATUS_STOP_UNAUTHORIZED
Definition IAgoraRtcEngine.h:178
VIDEO_MODULE_TYPE
Definition AgoraBase.h:2028
VIDEO_PROFILE_TYPE
Definition IAgoraRtcEngine.h:12410
@ VIDEO_PROFILE_LANDSCAPE_480P
Definition IAgoraRtcEngine.h:12446
@ VIDEO_PROFILE_PORTRAIT_180P
Definition IAgoraRtcEngine.h:12486
@ VIDEO_PROFILE_PORTRAIT_180P_4
Definition IAgoraRtcEngine.h:12490
@ VIDEO_PROFILE_LANDSCAPE_360P_7
Definition IAgoraRtcEngine.h:12436
@ VIDEO_PROFILE_LANDSCAPE_480P_8
Definition IAgoraRtcEngine.h:12454
@ VIDEO_PROFILE_LANDSCAPE_360P
Definition IAgoraRtcEngine.h:12428
@ VIDEO_PROFILE_PORTRAIT_240P
Definition IAgoraRtcEngine.h:12492
@ VIDEO_PROFILE_PORTRAIT_480P_3
Definition IAgoraRtcEngine.h:12518
@ VIDEO_PROFILE_PORTRAIT_360P_6
Definition IAgoraRtcEngine.h:12504
@ VIDEO_PROFILE_LANDSCAPE_1080P_3
Definition IAgoraRtcEngine.h:12470
@ VIDEO_PROFILE_LANDSCAPE_240P
Definition IAgoraRtcEngine.h:12422
@ VIDEO_PROFILE_PORTRAIT_480P
Definition IAgoraRtcEngine.h:12516
@ VIDEO_PROFILE_LANDSCAPE_720P_3
Definition IAgoraRtcEngine.h:12462
@ VIDEO_PROFILE_LANDSCAPE_360P_6
Definition IAgoraRtcEngine.h:12434
@ VIDEO_PROFILE_LANDSCAPE_480P_4
Definition IAgoraRtcEngine.h:12450
@ VIDEO_PROFILE_PORTRAIT_360P_10
Definition IAgoraRtcEngine.h:12512
@ VIDEO_PROFILE_DEFAULT
Definition IAgoraRtcEngine.h:12552
@ VIDEO_PROFILE_LANDSCAPE_1440P
Definition IAgoraRtcEngine.h:12474
@ VIDEO_PROFILE_PORTRAIT_480P_9
Definition IAgoraRtcEngine.h:12526
@ VIDEO_PROFILE_PORTRAIT_480P_4
Definition IAgoraRtcEngine.h:12520
@ VIDEO_PROFILE_LANDSCAPE_480P_9
Definition IAgoraRtcEngine.h:12456
@ VIDEO_PROFILE_PORTRAIT_4K_3
Definition IAgoraRtcEngine.h:12550
@ VIDEO_PROFILE_PORTRAIT_360P_7
Definition IAgoraRtcEngine.h:12506
@ VIDEO_PROFILE_PORTRAIT_240P_4
Definition IAgoraRtcEngine.h:12496
@ VIDEO_PROFILE_LANDSCAPE_360P_4
Definition IAgoraRtcEngine.h:12432
@ VIDEO_PROFILE_LANDSCAPE_180P
Definition IAgoraRtcEngine.h:12416
@ VIDEO_PROFILE_LANDSCAPE_180P_4
Definition IAgoraRtcEngine.h:12420
@ VIDEO_PROFILE_PORTRAIT_4K
Definition IAgoraRtcEngine.h:12548
@ VIDEO_PROFILE_LANDSCAPE_120P_3
Definition IAgoraRtcEngine.h:12414
@ VIDEO_PROFILE_PORTRAIT_480P_6
Definition IAgoraRtcEngine.h:12522
@ VIDEO_PROFILE_LANDSCAPE_480P_6
Definition IAgoraRtcEngine.h:12452
@ VIDEO_PROFILE_LANDSCAPE_120P
Definition IAgoraRtcEngine.h:12412
@ VIDEO_PROFILE_PORTRAIT_360P_3
Definition IAgoraRtcEngine.h:12500
@ VIDEO_PROFILE_LANDSCAPE_1080P_5
Definition IAgoraRtcEngine.h:12472
@ VIDEO_PROFILE_PORTRAIT_120P
Definition IAgoraRtcEngine.h:12482
@ VIDEO_PROFILE_LANDSCAPE_720P_6
Definition IAgoraRtcEngine.h:12466
@ VIDEO_PROFILE_PORTRAIT_120P_3
Definition IAgoraRtcEngine.h:12484
@ VIDEO_PROFILE_LANDSCAPE_480P_10
Definition IAgoraRtcEngine.h:12458
@ VIDEO_PROFILE_LANDSCAPE_480P_3
Definition IAgoraRtcEngine.h:12448
@ VIDEO_PROFILE_PORTRAIT_1440P
Definition IAgoraRtcEngine.h:12544
@ VIDEO_PROFILE_PORTRAIT_480P_8
Definition IAgoraRtcEngine.h:12524
@ VIDEO_PROFILE_LANDSCAPE_1440P_2
Definition IAgoraRtcEngine.h:12476
@ VIDEO_PROFILE_PORTRAIT_720P_6
Definition IAgoraRtcEngine.h:12536
@ VIDEO_PROFILE_PORTRAIT_360P_9
Definition IAgoraRtcEngine.h:12510
@ VIDEO_PROFILE_LANDSCAPE_360P_9
Definition IAgoraRtcEngine.h:12440
@ VIDEO_PROFILE_LANDSCAPE_240P_4
Definition IAgoraRtcEngine.h:12426
@ VIDEO_PROFILE_LANDSCAPE_720P_5
Definition IAgoraRtcEngine.h:12464
@ VIDEO_PROFILE_PORTRAIT_360P_8
Definition IAgoraRtcEngine.h:12508
@ VIDEO_PROFILE_LANDSCAPE_180P_3
Definition IAgoraRtcEngine.h:12418
@ VIDEO_PROFILE_PORTRAIT_720P_5
Definition IAgoraRtcEngine.h:12534
@ VIDEO_PROFILE_PORTRAIT_720P_3
Definition IAgoraRtcEngine.h:12532
@ VIDEO_PROFILE_PORTRAIT_360P
Definition IAgoraRtcEngine.h:12498
@ VIDEO_PROFILE_PORTRAIT_1080P_3
Definition IAgoraRtcEngine.h:12540
@ VIDEO_PROFILE_PORTRAIT_1080P
Definition IAgoraRtcEngine.h:12538
@ VIDEO_PROFILE_PORTRAIT_360P_4
Definition IAgoraRtcEngine.h:12502
@ VIDEO_PROFILE_LANDSCAPE_1080P
Definition IAgoraRtcEngine.h:12468
@ VIDEO_PROFILE_PORTRAIT_1440P_2
Definition IAgoraRtcEngine.h:12546
@ VIDEO_PROFILE_LANDSCAPE_360P_3
Definition IAgoraRtcEngine.h:12430
@ VIDEO_PROFILE_PORTRAIT_480P_10
Definition IAgoraRtcEngine.h:12528
@ VIDEO_PROFILE_LANDSCAPE_720P
Definition IAgoraRtcEngine.h:12460
@ VIDEO_PROFILE_LANDSCAPE_240P_3
Definition IAgoraRtcEngine.h:12424
@ VIDEO_PROFILE_PORTRAIT_720P
Definition IAgoraRtcEngine.h:12530
@ VIDEO_PROFILE_LANDSCAPE_4K
Definition IAgoraRtcEngine.h:12478
@ VIDEO_PROFILE_LANDSCAPE_360P_11
Definition IAgoraRtcEngine.h:12444
@ VIDEO_PROFILE_PORTRAIT_240P_3
Definition IAgoraRtcEngine.h:12494
@ VIDEO_PROFILE_LANDSCAPE_360P_8
Definition IAgoraRtcEngine.h:12438
@ VIDEO_PROFILE_LANDSCAPE_360P_10
Definition IAgoraRtcEngine.h:12442
@ VIDEO_PROFILE_PORTRAIT_360P_11
Definition IAgoraRtcEngine.h:12514
@ VIDEO_PROFILE_PORTRAIT_1080P_5
Definition IAgoraRtcEngine.h:12542
@ VIDEO_PROFILE_PORTRAIT_180P_3
Definition IAgoraRtcEngine.h:12488
@ VIDEO_PROFILE_LANDSCAPE_4K_3
Definition IAgoraRtcEngine.h:12480
REMOTE_AUDIO_STATE
Remote audio states.
Definition AgoraBase.h:3792
HEADPHONE_EQUALIZER_PRESET
Preset headphone equalizer types.
Definition AgoraBase.h:6500
AUDIO_MIXING_STATE_TYPE
The playback state of the music file.
Definition IAgoraRtcEngine.h:78
@ AUDIO_MIXING_STATE_FAILED
Definition IAgoraRtcEngine.h:101
@ AUDIO_MIXING_STATE_PAUSED
Definition IAgoraRtcEngine.h:86
@ AUDIO_MIXING_STATE_STOPPED
Definition IAgoraRtcEngine.h:93
@ AUDIO_MIXING_STATE_PLAYING
Definition IAgoraRtcEngine.h:82
NETWORK_TYPE
Network type.
Definition AgoraBase.h:5307
unsigned int uid_t
Definition AgoraMediaBase.h:28
QUALITY_ADAPT_INDICATION
Quality change of the local video in terms of target frame rate and target bit rate since last count.
Definition AgoraBase.h:3052
VOICE_AI_TUNER_TYPE
Voice AI tuner sound types.
Definition AgoraBase.h:6518
HDR_CAPABILITY
Definition AgoraBase.h:2043
ScreenCaptureSourceType
The type of the shared target. Set in ScreenCaptureSourceInfo.
Definition IAgoraRtcEngine.h:1076
@ ScreenCaptureSourceType_Screen
Definition IAgoraRtcEngine.h:1088
@ ScreenCaptureSourceType_Window
Definition IAgoraRtcEngine.h:1084
@ ScreenCaptureSourceType_Unknown
Definition IAgoraRtcEngine.h:1080
@ ScreenCaptureSourceType_Custom
Definition IAgoraRtcEngine.h:1092
REMOTE_USER_STATE
Definition AgoraBase.h:3968
VIDEO_APPLICATION_SCENARIO_TYPE
The video application scenarios.
Definition AgoraBase.h:3343
CAMERA_STABILIZATION_MODE
Camera stabilization modes.
Definition AgoraBase.h:3460
STREAM_SUBSCRIBE_STATE
The subscribing state.
Definition AgoraBase.h:7572
VIDEO_SOURCE_TYPE
The type of the video source.
Definition AgoraMediaBase.h:67
STREAM_FALLBACK_OPTIONS
Options for handling audio and video stream fallback when network conditions are weak.
Definition IAgoraRtcEngine.h:268
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_1
Definition IAgoraRtcEngine.h:288
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_4
Definition IAgoraRtcEngine.h:291
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_3
Definition IAgoraRtcEngine.h:290
@ STREAM_FALLBACK_OPTION_AUDIO_ONLY
Definition IAgoraRtcEngine.h:283
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LOW
Definition IAgoraRtcEngine.h:277
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_5
Definition IAgoraRtcEngine.h:292
@ STREAM_FALLBACK_OPTION_DISABLED
Definition IAgoraRtcEngine.h:273
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_2
Definition IAgoraRtcEngine.h:289
@ STREAM_FALLBACK_OPTION_VIDEO_STREAM_LAYER_6
Definition IAgoraRtcEngine.h:293
RTMP_STREAM_LIFE_CYCLE_TYPE
Lifecycle of the CDN live video stream.
Definition IAgoraRtcEngine.h:798
@ RTMP_STREAM_LIFE_CYCLE_BIND2OWNER
Definition IAgoraRtcEngine.h:808
@ RTMP_STREAM_LIFE_CYCLE_BIND2CHANNEL
Definition IAgoraRtcEngine.h:803
static void ReplaceBy(Optional< T > *s, const Optional< T > &o)
Definition IAgoraRtcEngine.h:31
CAPTURE_BRIGHTNESS_LEVEL_TYPE
The brightness level of the video image captured by the local camera.
Definition AgoraBase.h:3432
AUDIO_REVERB_TYPE
Audio reverberation types.
Definition IAgoraRtcEngine.h:242
@ AUDIO_REVERB_WET_DELAY
Definition IAgoraRtcEngine.h:258
@ AUDIO_REVERB_ROOM_SIZE
Definition IAgoraRtcEngine.h:254
@ AUDIO_REVERB_DRY_LEVEL
Definition IAgoraRtcEngine.h:246
@ AUDIO_REVERB_STRENGTH
Definition IAgoraRtcEngine.h:262
@ AUDIO_REVERB_WET_LEVEL
Definition IAgoraRtcEngine.h:250
UPLOAD_ERROR_REASON
Definition AgoraBase.h:7498
VIDEO_TRANSCODER_ERROR
The error code of the local video mixing failure.
Definition AgoraBase.h:4930
REMOTE_VIDEO_STATE_REASON
The reason for the remote video state change.
Definition AgoraBase.h:3904
RAW_AUDIO_FRAME_OP_MODE_TYPE
The use mode of the audio data.
Definition AgoraMediaBase.h:261
INTERFACE_ID_TYPE
The interface class.
Definition AgoraBase.h:990
@ AGORA_IID_AUDIO_DEVICE_MANAGER
Definition AgoraBase.h:994
@ AGORA_IID_VIDEO_DEVICE_MANAGER
Definition AgoraBase.h:998
VIDEO_ORIENTATION
The clockwise rotation of the video.
Definition AgoraBase.h:1086
VOICE_CONVERSION_PRESET
The options for SDK preset voice conversion effects.
Definition AgoraBase.h:6436
QUALITY_REPORT_FORMAT_TYPE
Definition IAgoraRtcEngine.h:12369
@ QUALITY_REPORT_HTML
Definition IAgoraRtcEngine.h:12375
@ QUALITY_REPORT_JSON
Definition IAgoraRtcEngine.h:12372
Definition IAgoraRtmService.h:14
CopyableAutoPtr< IString > AString
Definition AgoraBase.h:182
Definition AgoraAtomicOps.h:21
AUDIO_SESSION_OPERATION_RESTRICTION
The operation permissions of the SDK on the audio session.
Definition AgoraBase.h:909
void * view_t
Definition AgoraBase.h:935
CHANNEL_PROFILE_TYPE
The channel profile.
Definition AgoraBase.h:267
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition AgoraBase.h:275
LICENSE_ERROR_TYPE
Definition AgoraBase.h:879
Definition video_node_i.h:28
The spatial audio parameters.
Definition AgoraBase.h:8179
Layout information of a specific sub-video stream within the mixed stream.
Definition AgoraBase.h:8260
Configuration of Agora SDK log files.
Definition IAgoraLog.h:124
The advanced options for audio.
Definition IAgoraRtcEngine.h:1209
Optional< int > audioProcessingChannels
Definition IAgoraRtcEngine.h:1215
~AdvancedAudioOptions()
Definition IAgoraRtcEngine.h:1218
AdvancedAudioOptions()
Definition IAgoraRtcEngine.h:1217
Observer settings for the encoded audio.
Definition AgoraBase.h:6932
Recording configurations.
Definition AgoraBase.h:6844
The volume information of users.
Definition AgoraBase.h:4069
Image enhancement options.
Definition AgoraBase.h:5505
The camera capturer preference.
Definition IAgoraRtcEngine.h:923
CameraCapturerConfiguration()
Definition IAgoraRtcEngine.h:988
Optional< CAMERA_DIRECTION > cameraDirection
Definition IAgoraRtcEngine.h:930
Optional< CAMERA_FOCAL_LENGTH_TYPE > cameraFocalLengthType
Definition IAgoraRtcEngine.h:948
VideoFormat format
Definition IAgoraRtcEngine.h:987
Optional< const char * > cameraId
Definition IAgoraRtcEngine.h:973
Optional< bool > followEncodeDimensionRatio
Definition IAgoraRtcEngine.h:983
Optional< const char * > deviceId
Definition IAgoraRtcEngine.h:954
The channel media options.
Definition IAgoraRtcEngine.h:1254
Optional< bool > publishThirdScreenTrack
Definition IAgoraRtcEngine.h:1324
Optional< int > audioDelayMs
Definition IAgoraRtcEngine.h:1439
Optional< bool > enableMultipath
Definition IAgoraRtcEngine.h:1513
Optional< CHANNEL_TYPE > channelType
Definition IAgoraRtcEngine.h:1542
Optional< bool > publishCustomVideoTrack
Definition IAgoraRtcEngine.h:1351
Optional< video_track_id_t > customVideoTrackId
Definition IAgoraRtcEngine.h:1488
Optional< bool > enableBuiltInMediaEncryption
Definition IAgoraRtcEngine.h:1463
Optional< int > publishCustomAudioTrackId
Definition IAgoraRtcEngine.h:1344
Optional< bool > publishSecondaryScreenTrack
Definition IAgoraRtcEngine.h:1317
Optional< const char * > token
Definition IAgoraRtcEngine.h:1455
Optional< int > mediaPlayerAudioDelayMs
Definition IAgoraRtcEngine.h:1444
bool operator==(const ChannelMediaOptions &o) const
Definition IAgoraRtcEngine.h:1600
Optional< int > publishMediaPlayerId
Definition IAgoraRtcEngine.h:1413
void SetAll(const ChannelMediaOptions &change)
Definition IAgoraRtcEngine.h:1547
~ChannelMediaOptions()
Definition IAgoraRtcEngine.h:1545
Optional< bool > publishTranscodedVideoTrack
Definition IAgoraRtcEngine.h:1377
Optional< bool > publishCameraTrack
Definition IAgoraRtcEngine.h:1260
Optional< CHANNEL_PROFILE_TYPE > channelProfile
Definition IAgoraRtcEngine.h:1433
Optional< bool > publishScreenTrack
Definition IAgoraRtcEngine.h:1311
Optional< bool > publishFourthCameraTrack
Definition IAgoraRtcEngine.h:1280
Optional< bool > enableAudioRecordingOrPlayout
Definition IAgoraRtcEngine.h:1409
Optional< bool > publishMicrophoneTrack
Definition IAgoraRtcEngine.h:1286
Optional< bool > publishFourthScreenTrack
Definition IAgoraRtcEngine.h:1331
Optional< MultipathType > preferMultipathType
Definition IAgoraRtcEngine.h:1534
Optional< bool > publishScreenCaptureVideo
Definition IAgoraRtcEngine.h:1302
ChannelMediaOptions & operator=(const ChannelMediaOptions &replace)
Definition IAgoraRtcEngine.h:1661
Optional< bool > publishMixedAudioTrack
Definition IAgoraRtcEngine.h:1383
Optional< bool > autoSubscribeVideo
Definition IAgoraRtcEngine.h:1401
Optional< bool > publishCustomAudioTrack
Definition IAgoraRtcEngine.h:1339
Optional< const char * > parameters
Definition IAgoraRtcEngine.h:1502
Optional< CLIENT_ROLE_TYPE > clientRoleType
Definition IAgoraRtcEngine.h:1420
Optional< bool > publishLipSyncTrack
Definition IAgoraRtcEngine.h:1389
Optional< VIDEO_STREAM_TYPE > defaultVideoStreamType
Definition IAgoraRtcEngine.h:1429
Optional< bool > publishEncodedVideoTrack
Definition IAgoraRtcEngine.h:1357
Optional< AUDIENCE_LATENCY_LEVEL_TYPE > audienceLatencyLevel
Definition IAgoraRtcEngine.h:1425
Optional< bool > publishMediaPlayerVideoTrack
Definition IAgoraRtcEngine.h:1369
Optional< MultipathMode > downlinkMultipathMode
Definition IAgoraRtcEngine.h:1527
Optional< bool > isAudioFilterable
Definition IAgoraRtcEngine.h:1496
Optional< bool > publishScreenCaptureAudio
Definition IAgoraRtcEngine.h:1293
Optional< MultipathMode > uplinkMultipathMode
Definition IAgoraRtcEngine.h:1520
Optional< bool > publishThirdCameraTrack
Definition IAgoraRtcEngine.h:1273
Optional< bool > isInteractiveAudience
Definition IAgoraRtcEngine.h:1483
Optional< bool > publishSecondaryCameraTrack
Definition IAgoraRtcEngine.h:1266
Optional< bool > publishMediaPlayerAudioTrack
Definition IAgoraRtcEngine.h:1363
Optional< bool > autoSubscribeAudio
Definition IAgoraRtcEngine.h:1395
Optional< bool > publishRhythmPlayerTrack
Definition IAgoraRtcEngine.h:1470
ChannelMediaOptions()
Definition IAgoraRtcEngine.h:1544
Configuration of cross channel media relay.
Definition AgoraBase.h:7183
Setting of user role properties.
Definition AgoraBase.h:3085
The codec capability of the SDK.
Definition AgoraBase.h:2105
The color enhancement options.
Definition AgoraBase.h:5983
The configurations for the data stream.
Definition AgoraBase.h:2271
The audio device information.
Definition AgoraBase.h:4113
The media setting options for the host.
Definition IAgoraRtcEngine.h:4473
Optional< bool > publishMediaPlayerAudioTrack
Definition IAgoraRtcEngine.h:4503
Optional< bool > publishCustomVideoTrack
Definition IAgoraRtcEngine.h:4497
DirectCdnStreamingMediaOptions()
Definition IAgoraRtcEngine.h:4515
Optional< int > publishMediaPlayerId
Definition IAgoraRtcEngine.h:4508
Optional< bool > publishCameraTrack
Definition IAgoraRtcEngine.h:4479
void SetAll(const DirectCdnStreamingMediaOptions &change)
Definition IAgoraRtcEngine.h:4518
~DirectCdnStreamingMediaOptions()
Definition IAgoraRtcEngine.h:4516
bool operator==(const DirectCdnStreamingMediaOptions &o) const
Definition IAgoraRtcEngine.h:4530
DirectCdnStreamingMediaOptions & operator=(const DirectCdnStreamingMediaOptions &replace)
Definition IAgoraRtcEngine.h:4551
Optional< bool > publishCustomAudioTrack
Definition IAgoraRtcEngine.h:4491
Optional< bool > publishMicrophoneTrack
Definition IAgoraRtcEngine.h:4485
Optional< video_track_id_t > customVideoTrackId
Definition IAgoraRtcEngine.h:4513
The statistics of the current CDN streaming.
Definition IAgoraRtcEngine.h:4396
int videoBitrate
Definition IAgoraRtcEngine.h:4415
int audioBitrate
Definition IAgoraRtcEngine.h:4420
int videoWidth
Definition IAgoraRtcEngine.h:4400
int videoHeight
Definition IAgoraRtcEngine.h:4405
int fps
Definition IAgoraRtcEngine.h:4410
The configuration of the audio and video call loop test.
Definition AgoraBase.h:7635
Built-in encryption configurations.
Definition AgoraBase.h:7409
The context information of the extension.
Definition AgoraMediaBase.h:41
Definition IAgoraRtcEngine.h:4571
agora::media::MEDIA_SOURCE_TYPE mediaSourceType
Definition IAgoraRtcEngine.h:4575
const char * channelId
Definition IAgoraRtcEngine.h:4595
ExtensionInfo()
Definition IAgoraRtcEngine.h:4602
uid_t remoteUid
Definition IAgoraRtcEngine.h:4582
uid_t localUid
Definition IAgoraRtcEngine.h:4600
Filter effect options.
Definition AgoraBase.h:5575
FACE_SHAPE_AREA
Chooses the specific facial areas that need to be adjusted.
Definition AgoraBase.h:5581
The facial enhancement style options.
Definition AgoraBase.h:5796
Filter effect options.
Definition AgoraBase.h:5840
Focal length information supported by the camera, including the camera direction and focal length typ...
Definition AgoraBase.h:2129
Media metadata.
Definition IAgoraRtcEngine.h:4244
long long timeStampMs
Definition IAgoraRtcEngine.h:4266
unsigned int size
Definition IAgoraRtcEngine.h:4258
unsigned int uid
Definition IAgoraRtcEngine.h:4254
Metadata()
Definition IAgoraRtcEngine.h:4268
const char * channelId
Definition IAgoraRtcEngine.h:4248
unsigned char * buffer
Definition IAgoraRtcEngine.h:4262
Image configurations.
Definition IAgoraRtcEngine.h:1224
int fps
Definition IAgoraRtcEngine.h:1235
ImageTrackOptions()
Definition IAgoraRtcEngine.h:1237
const char * imageUrl
Definition IAgoraRtcEngine.h:1230
VIDEO_MIRROR_MODE_TYPE mirrorMode
Definition IAgoraRtcEngine.h:1236
InjectStreamConfig()
Definition IAgoraRtcEngine.h:784
int audioChannels
Definition IAgoraRtcEngine.h:780
int audioBitrate
Definition IAgoraRtcEngine.h:777
int height
Definition IAgoraRtcEngine.h:757
int videoFramerate
Definition IAgoraRtcEngine.h:765
AUDIO_SAMPLE_RATE_TYPE audioSampleRate
Definition IAgoraRtcEngine.h:773
int videoGop
Definition IAgoraRtcEngine.h:761
int videoBitrate
Definition IAgoraRtcEngine.h:769
int width
Definition IAgoraRtcEngine.h:753
Configurations of the last-mile network test.
Definition AgoraBase.h:5046
Results of the uplink and downlink last-mile network tests.
Definition AgoraBase.h:5115
The options for leaving a channel.
Definition IAgoraRtcEngine.h:1770
bool stopMicrophoneRecording
Definition IAgoraRtcEngine.h:1788
bool stopAudioMixing
Definition IAgoraRtcEngine.h:1776
LeaveChannelOptions()
Definition IAgoraRtcEngine.h:1790
bool stopAllEffect
Definition IAgoraRtcEngine.h:1782
Transcoding configurations for Media Push.
Definition AgoraBase.h:4651
Configuration for the Local Access Point.
Definition AgoraBase.h:7995
The configurations for mixing the lcoal audio.
Definition AgoraBase.h:5021
Local audio statistics.
Definition AgoraBase.h:4261
The configuration of the video mixing on the local client.
Definition AgoraBase.h:4896
The statistics of the local video stream.
Definition IAgoraRtcEngine.h:311
int hwEncoderAccelerating
Definition IAgoraRtcEngine.h:418
int encodedFrameCount
Definition IAgoraRtcEngine.h:394
int targetBitrate
Definition IAgoraRtcEngine.h:376
int regulatedCaptureFrameRate
Definition IAgoraRtcEngine.h:343
int captureFrameHeight
Definition IAgoraRtcEngine.h:337
int captureFrameWidth
Definition IAgoraRtcEngine.h:333
bool dualStreamEnabled
Definition IAgoraRtcEngine.h:412
int encodedBitrate
Definition IAgoraRtcEngine.h:390
VideoDimensions simulcastDimensions[SimulcastConfig::STREAM_LAYER_COUNT_MAX]
Definition IAgoraRtcEngine.h:421
int encodedFrameHeight
Definition IAgoraRtcEngine.h:367
int encodedFrameWidth
Definition IAgoraRtcEngine.h:363
CAPTURE_BRIGHTNESS_LEVEL_TYPE captureBrightnessLevel
Definition IAgoraRtcEngine.h:408
QUALITY_ADAPT_INDICATION qualityAdaptIndication
Definition IAgoraRtcEngine.h:385
int regulatedCaptureFrameHeight
Definition IAgoraRtcEngine.h:355
int captureFrameRate
Definition IAgoraRtcEngine.h:329
int sentFrameRate
Definition IAgoraRtcEngine.h:325
int rendererOutputFrameRate
Definition IAgoraRtcEngine.h:371
int encoderOutputFrameRate
Definition IAgoraRtcEngine.h:359
int targetFrameRate
Definition IAgoraRtcEngine.h:380
int encodedFrameDepth
Definition IAgoraRtcEngine.h:428
uid_t uid
Definition IAgoraRtcEngine.h:315
unsigned short txPacketLossRate
Definition IAgoraRtcEngine.h:403
int sentBitrate
Definition IAgoraRtcEngine.h:320
VIDEO_CODEC_TYPE codecType
Definition IAgoraRtcEngine.h:398
int regulatedCaptureFrameWidth
Definition IAgoraRtcEngine.h:349
The low-light enhancement options.
Definition AgoraBase.h:5874
Aggregates statistics of each network path in multipath transmission.
Definition AgoraBase.h:2781
int width
Definition IAgoraRtcEngine.h:817
int injectStreamWidth
Definition IAgoraRtcEngine.h:846
int bitrate
Definition IAgoraRtcEngine.h:829
int height
Definition IAgoraRtcEngine.h:821
bool owner
Definition IAgoraRtcEngine.h:843
int framerate
Definition IAgoraRtcEngine.h:825
PublisherConfiguration()
Definition IAgoraRtcEngine.h:865
int injectStreamHeight
Definition IAgoraRtcEngine.h:849
const char * injectStreamUrl
Definition IAgoraRtcEngine.h:852
const char * extraInfo
Definition IAgoraRtcEngine.h:863
const char * publishUrl
Definition IAgoraRtcEngine.h:856
const char * rawStreamUrl
Definition IAgoraRtcEngine.h:860
int defaultLayout
Definition IAgoraRtcEngine.h:835
int lifecycle
Definition IAgoraRtcEngine.h:838
The information about the media streams to be recorded.
Definition AgoraBase.h:8065
The location of the target area relative to the screen or window. If you do not set this parameter,...
Definition AgoraBase.h:2429
Audio statistics of the remote user.
Definition IAgoraRtcEngine.h:435
int audioLossRate
Definition IAgoraRtcEngine.h:457
int networkTransportDelay
Definition IAgoraRtcEngine.h:447
uint32_t frozenCntByCustom
Definition IAgoraRtcEngine.h:511
int qoeQuality
Definition IAgoraRtcEngine.h:533
int jitterBufferDelay
Definition IAgoraRtcEngine.h:453
uint32_t frozenRateByCustomPlcCount
Definition IAgoraRtcEngine.h:501
int receivedSampleRate
Definition IAgoraRtcEngine.h:465
int e2eDelay
Definition IAgoraRtcEngine.h:547
uint32_t frozenTimeByCustom
Definition IAgoraRtcEngine.h:517
int publishDuration
Definition IAgoraRtcEngine.h:528
uint32_t plcCount
Definition IAgoraRtcEngine.h:505
unsigned int rxAudioBytes
Definition IAgoraRtcEngine.h:542
RemoteAudioStats()
Definition IAgoraRtcEngine.h:549
int frozenRate
Definition IAgoraRtcEngine.h:480
int receivedBitrate
Definition IAgoraRtcEngine.h:469
uid_t uid
Definition IAgoraRtcEngine.h:439
int totalFrozenTime
Definition IAgoraRtcEngine.h:474
int quality
Definition IAgoraRtcEngine.h:443
int qualityChangedReason
Definition IAgoraRtcEngine.h:538
int mosValue
Definition IAgoraRtcEngine.h:496
int totalActiveTime
Definition IAgoraRtcEngine.h:524
int numChannels
Definition IAgoraRtcEngine.h:461
Statistics of the remote video stream.
Definition IAgoraRtcEngine.h:576
VIDEO_STREAM_TYPE rxStreamType
Definition IAgoraRtcEngine.h:628
int avSyncTimeMs
Definition IAgoraRtcEngine.h:645
int delay __deprecated
Definition IAgoraRtcEngine.h:588
int mosValue
Definition IAgoraRtcEngine.h:663
int decoderOutputFrameRate
Definition IAgoraRtcEngine.h:612
int totalActiveTime
Definition IAgoraRtcEngine.h:651
int e2eDelay
Definition IAgoraRtcEngine.h:593
int rendererOutputFrameRate
Definition IAgoraRtcEngine.h:616
int packetLossRate
Definition IAgoraRtcEngine.h:624
int frozenRate
Definition IAgoraRtcEngine.h:640
int publishDuration
Definition IAgoraRtcEngine.h:655
int width
Definition IAgoraRtcEngine.h:597
int decoderInputFrameRate
Definition IAgoraRtcEngine.h:608
int receivedBitrate
Definition IAgoraRtcEngine.h:605
uid_t uid
Definition IAgoraRtcEngine.h:580
int height
Definition IAgoraRtcEngine.h:601
int totalFrozenTime
Definition IAgoraRtcEngine.h:634
unsigned int rxVideoBytes
Definition IAgoraRtcEngine.h:667
int frameLossRate
Definition IAgoraRtcEngine.h:620
Configurations for the RtcEngineContext instance.
Definition IAgoraRtcEngine.h:4103
RtcEngineContext()
Definition IAgoraRtcEngine.h:4204
AUDIO_SCENARIO_TYPE audioScenario
Definition IAgoraRtcEngine.h:4135
unsigned int areaCode
Definition IAgoraRtcEngine.h:4141
IRtcEngineEventHandler * eventHandler
Definition IAgoraRtcEngine.h:4107
commons::LogConfig logConfig
Definition IAgoraRtcEngine.h:4162
CHANNEL_PROFILE_TYPE channelProfile
Definition IAgoraRtcEngine.h:4124
const char * parameters
Definition IAgoraRtcEngine.h:4202
const char * appId
Definition IAgoraRtcEngine.h:4114
bool domainLimit
Definition IAgoraRtcEngine.h:4186
bool autoRegisterAgoraExtensions
Definition IAgoraRtcEngine.h:4194
void * context
Definition IAgoraRtcEngine.h:4120
const char * license
Definition IAgoraRtcEngine.h:4129
bool useExternalEglContext
Definition IAgoraRtcEngine.h:4176
Optional< THREAD_PRIORITY_TYPE > threadPriority
Definition IAgoraRtcEngine.h:4167
Image properties.
Definition AgoraBase.h:4453
Statistics of a call session.
Definition AgoraBase.h:2828
Definition IAgoraRtcEngine.h:1033
SIZE()
Definition IAgoraRtcEngine.h:1041
int width
Definition IAgoraRtcEngine.h:1036
SIZE(int ww, int hh)
Definition IAgoraRtcEngine.h:1042
int height
Definition IAgoraRtcEngine.h:1039
The configuration of the captured screen.
Definition IAgoraRtcEngine.h:993
Rectangle screenRect
Definition IAgoraRtcEngine.h:1009
ScreenCaptureConfiguration()
Definition IAgoraRtcEngine.h:1027
int64_t displayId
Definition IAgoraRtcEngine.h:1004
ScreenCaptureParameters params
Definition IAgoraRtcEngine.h:1018
bool isCaptureWindow
Definition IAgoraRtcEngine.h:999
Rectangle regionRect
Definition IAgoraRtcEngine.h:1025
int64_t windowId
Definition IAgoraRtcEngine.h:1014
Screen sharing configurations.
Definition AgoraBase.h:7790
Screen sharing configurations.
Definition AgoraBase.h:6596
The information about the specified shareable window or screen. The information is returned in IScree...
Definition IAgoraRtcEngine.h:1098
bool minimizeWindow
Definition IAgoraRtcEngine.h:1145
const char * sourceName
Definition IAgoraRtcEngine.h:1110
bool primaryMonitor
Definition IAgoraRtcEngine.h:1132
bool isOccluded
Definition IAgoraRtcEngine.h:1133
const char * processPath
Definition IAgoraRtcEngine.h:1122
ScreenCaptureSourceInfo()
Definition IAgoraRtcEngine.h:1153
ThumbImageBuffer iconImage
Definition IAgoraRtcEngine.h:1118
ScreenCaptureSourceType type
Definition IAgoraRtcEngine.h:1102
ThumbImageBuffer thumbImage
Definition IAgoraRtcEngine.h:1114
const char * sourceTitle
Definition IAgoraRtcEngine.h:1126
int64_t sourceDisplayId
Definition IAgoraRtcEngine.h:1152
int64_t sourceId
Definition IAgoraRtcEngine.h:1106
Rectangle position
Definition IAgoraRtcEngine.h:1138
Processing properties for background images.
Definition AgoraBase.h:6108
Definition AgoraBase.h:1428
Configure video streams of different quality levels.
Definition AgoraBase.h:2344
@ STREAM_LAYER_COUNT_MAX
Definition AgoraBase.h:2381
The configuration of the low-quality video stream.
Definition AgoraBase.h:2316
The image content of the thumbnail or icon. Set in ScreenCaptureSourceInfo.
Definition IAgoraRtcEngine.h:1054
unsigned int width
Definition IAgoraRtcEngine.h:1066
unsigned int height
Definition IAgoraRtcEngine.h:1070
const char * buffer
Definition IAgoraRtcEngine.h:1058
unsigned int length
Definition IAgoraRtcEngine.h:1062
ThumbImageBuffer()
Definition IAgoraRtcEngine.h:1071
The video streams for local video mixing.
Definition AgoraBase.h:4819
The information of the user.
Definition AgoraBase.h:7693
Attributes of the video canvas object.
Definition AgoraBase.h:5366
Definition IAgoraRtcEngine.h:671
double y
Definition IAgoraRtcEngine.h:680
double alpha
Definition IAgoraRtcEngine.h:695
int zOrder
Definition IAgoraRtcEngine.h:690
double height
Definition IAgoraRtcEngine.h:686
media::base::RENDER_MODE_TYPE renderMode
Definition IAgoraRtcEngine.h:697
uid_t uid
Definition IAgoraRtcEngine.h:674
double x
Definition IAgoraRtcEngine.h:677
double width
Definition IAgoraRtcEngine.h:684
Region()
Definition IAgoraRtcEngine.h:699
VideoCompositingLayout()
Definition IAgoraRtcEngine.h:737
const char * appData
Definition IAgoraRtcEngine.h:732
int appDataLength
Definition IAgoraRtcEngine.h:735
int canvasHeight
Definition IAgoraRtcEngine.h:719
const char * backgroundColor
Definition IAgoraRtcEngine.h:722
const Region * regions
Definition IAgoraRtcEngine.h:726
int regionCount
Definition IAgoraRtcEngine.h:729
int canvasWidth
Definition IAgoraRtcEngine.h:714
Video noise reduction options.
Definition AgoraBase.h:5928
The video dimension.
Definition AgoraBase.h:1252
Video encoder configurations.
Definition AgoraBase.h:2143
The format of the video frame.
Definition AgoraBase.h:3253
Indicators during video frame rendering progress.
Definition AgoraBase.h:7841
Video subscription options.
Definition AgoraBase.h:1791
The custom background.
Definition AgoraBase.h:6013
Used to configure watermark-related information.
Definition AgoraBase.h:2673
Watermark image configurations.
Definition AgoraBase.h:2495