Agora C++ API Reference for All Platforms

IAgoraRtcEngineEx.h
1 //
2 // Agora Media SDK
3 //
4 // Created by Sting Feng in 2015-05.
5 // Updated by Tommy Miao in 2020-11.
6 // Copyright (c) 2015 Agora IO. All rights reserved.
7 //
8 #pragma once
9
10 #include "IAgoraRtcEngine.h"
11
12 namespace agora {
13 namespace rtc {
14
15 // OPTIONAL_ENUM_CLASS RTC_EVENT;
16
20 struct RtcConnection {
31 const char* channelId;
35 uid_t localUid;
36
37 RtcConnection() : channelId(NULL), localUid(0) {}
38 RtcConnection(const char* channel_id, uid_t local_uid)
39 : channelId(channel_id), localUid(local_uid) {}
40 };
41
42 class IRtcEngineEventHandlerEx : public IRtcEngineEventHandler {
43 public:
44 using IRtcEngineEventHandler::eventHandlerType;
45 using IRtcEngineEventHandler::onJoinChannelSuccess;
46 using IRtcEngineEventHandler::onRejoinChannelSuccess;
47 using IRtcEngineEventHandler::onAudioQuality;
48 using IRtcEngineEventHandler::onAudioVolumeIndication;
49 using IRtcEngineEventHandler::onLeaveChannel;
50 using IRtcEngineEventHandler::onRtcStats;
51 using IRtcEngineEventHandler::onNetworkQuality;
52 using IRtcEngineEventHandler::onIntraRequestReceived;
53 using IRtcEngineEventHandler::onFirstLocalVideoFramePublished;
54 using IRtcEngineEventHandler::onFirstRemoteVideoDecoded;
55 using IRtcEngineEventHandler::onVideoSizeChanged;
56 using IRtcEngineEventHandler::onLocalVideoStateChanged;
57 using IRtcEngineEventHandler::onRemoteVideoStateChanged;
58 using IRtcEngineEventHandler::onFirstRemoteVideoFrame;
59 using IRtcEngineEventHandler::onUserJoined;
60 using IRtcEngineEventHandler::onUserOffline;
61 using IRtcEngineEventHandler::onUserMuteAudio;
62 using IRtcEngineEventHandler::onUserMuteVideo;
63 using IRtcEngineEventHandler::onUserEnableVideo;
64 using IRtcEngineEventHandler::onUserEnableLocalVideo;
65 using IRtcEngineEventHandler::onUserStateChanged;
66 using IRtcEngineEventHandler::onLocalAudioStats;
67 using IRtcEngineEventHandler::onRemoteAudioStats;
68 using IRtcEngineEventHandler::onLocalVideoStats;
69 using IRtcEngineEventHandler::onRemoteVideoStats;
70 using IRtcEngineEventHandler::onConnectionLost;
71 using IRtcEngineEventHandler::onConnectionInterrupted;
72 using IRtcEngineEventHandler::onConnectionBanned;
73 using IRtcEngineEventHandler::onStreamMessage;
74 using IRtcEngineEventHandler::onStreamMessageError;
75 using IRtcEngineEventHandler::onRequestToken;
76 using IRtcEngineEventHandler::onTokenPrivilegeWillExpire;
77 using IRtcEngineEventHandler::onLicenseValidationFailure;
78 using IRtcEngineEventHandler::onFirstLocalAudioFramePublished;
79 using IRtcEngineEventHandler::onFirstRemoteAudioFrame;
80 using IRtcEngineEventHandler::onFirstRemoteAudioDecoded;
81 using IRtcEngineEventHandler::onLocalAudioStateChanged;
82 using IRtcEngineEventHandler::onRemoteAudioStateChanged;
83 using IRtcEngineEventHandler::onActiveSpeaker;
84 using IRtcEngineEventHandler::onClientRoleChanged;
85 using IRtcEngineEventHandler::onClientRoleChangeFailed;
86 using IRtcEngineEventHandler::onRemoteAudioTransportStats;
87 using IRtcEngineEventHandler::onRemoteVideoTransportStats;
88 using IRtcEngineEventHandler::onConnectionStateChanged;
89 using IRtcEngineEventHandler::onWlAccMessage;
90 using IRtcEngineEventHandler::onWlAccStats;
91 using IRtcEngineEventHandler::onNetworkTypeChanged;
92 using IRtcEngineEventHandler::onEncryptionError;
93 using IRtcEngineEventHandler::onUploadLogResult;
94 using IRtcEngineEventHandler::onUserInfoUpdated;
95 using IRtcEngineEventHandler::onUserAccountUpdated;
96 using IRtcEngineEventHandler::onAudioSubscribeStateChanged;
97 using IRtcEngineEventHandler::onVideoSubscribeStateChanged;
98 using IRtcEngineEventHandler::onAudioPublishStateChanged;
99 using IRtcEngineEventHandler::onVideoPublishStateChanged;
100 using IRtcEngineEventHandler::onSnapshotTaken;
101 using IRtcEngineEventHandler::onVideoRenderingTracingResult;
102 using IRtcEngineEventHandler::onSetRtmFlagResult;
103 using IRtcEngineEventHandler::onTranscodedStreamLayoutInfo;
104 using IRtcEngineEventHandler::onAudioMetadataReceived;
105
106 virtual const char* eventHandlerType() const { return "event_handler_ex"; }
107
116 virtual void onJoinChannelSuccess(const RtcConnection& connection, int elapsed) {
117 (void)connection;
118 (void)elapsed;
119 }
120
130 virtual void onRejoinChannelSuccess(const RtcConnection& connection, int elapsed) {
131 (void)connection;
132 (void)elapsed;
133 }
134
151 virtual void onAudioQuality(const RtcConnection& connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) __deprecated {
152 (void)connection;
153 (void)remoteUid;
154 (void)quality;
155 (void)delay;
156 (void)lost;
157 }
185 virtual void onAudioVolumeIndication(const RtcConnection& connection, const AudioVolumeInfo* speakers,
186 unsigned int speakerNumber, int totalVolume) {
187 (void)connection;
188 (void)speakers;
189 (void)speakerNumber;
190 (void)totalVolume;
191 }
192
202 virtual void onLeaveChannel(const RtcConnection& connection, const RtcStats& stats) {
203 (void)connection;
204 (void)stats;
205 }
206
215 virtual void onRtcStats(const RtcConnection& connection, const RtcStats& stats) {
216 (void)connection;
217 (void)stats;
218 }
219
243 virtual void onNetworkQuality(const RtcConnection& connection, uid_t remoteUid, int txQuality, int rxQuality) {
244 (void)connection;
245 (void)remoteUid;
246 (void)txQuality;
247 (void)rxQuality;
248 }
249
257 virtual void onIntraRequestReceived(const RtcConnection& connection) {
258 (void)connection;
259 }
260
272 virtual void onFirstLocalVideoFramePublished(const RtcConnection& connection, int elapsed) {
273 (void)connection;
274 (void)elapsed;
275 }
276
294 virtual void onFirstRemoteVideoDecoded(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
295 (void)connection;
296 (void)remoteUid;
297 (void)width;
298 (void)height;
299 (void)elapsed;
300 }
301
312 virtual void onVideoSizeChanged(const RtcConnection& connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
313 (void)connection;
314 (void)sourceType;
315 (void)uid;
316 (void)width;
317 (void)height;
318 (void)rotation;
319 }
320
333 virtual void onRemoteVideoStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) {
334 (void)connection;
335 (void)remoteUid;
336 (void)state;
337 (void)reason;
338 (void)elapsed;
339 }
340
349 virtual void onFirstRemoteVideoFrame(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
350 (void)connection;
351 (void)remoteUid;
352 (void)width;
353 (void)height;
354 (void)elapsed;
355 }
356
377 virtual void onUserJoined(const RtcConnection& connection, uid_t remoteUid, int elapsed) {
378 (void)connection;
379 (void)remoteUid;
380 (void)elapsed;
381 }
382
398 virtual void onUserOffline(const RtcConnection& connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason) {
399 (void)connection;
400 (void)remoteUid;
401 (void)reason;
402 }
403
415 virtual void onUserMuteAudio(const RtcConnection& connection, uid_t remoteUid, bool muted) __deprecated {
416 (void)connection;
417 (void)remoteUid;
418 (void)muted;
419 }
420
436 virtual void onUserMuteVideo(const RtcConnection& connection, uid_t remoteUid, bool muted) {
437 (void)connection;
438 (void)remoteUid;
439 (void)muted;
440 }
441
455 virtual void onUserEnableVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) {
456 (void)connection;
457 (void)remoteUid;
458 (void)enabled;
459 }
460
472 virtual void onUserEnableLocalVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) __deprecated {
473 (void)connection;
474 (void)remoteUid;
475 (void)enabled;
476 }
477
485 virtual void onUserStateChanged(const RtcConnection& connection, uid_t remoteUid, uint32_t state) {
486 (void)connection;
487 (void)remoteUid;
488 (void)state;
489 }
490
499 virtual void onLocalAudioStats(const RtcConnection& connection, const LocalAudioStats& stats) {
500 (void)connection;
501 (void)stats;
502 }
503
511 virtual void onRemoteAudioStats(const RtcConnection& connection, const RemoteAudioStats& stats) {
512 (void)connection;
513 (void)stats;
514 }
515
529 virtual void onLocalVideoStats(const RtcConnection& connection, const LocalVideoStats& stats) {
530 (void)connection;
531 (void)stats;
532 }
533
543 virtual void onRemoteVideoStats(const RtcConnection& connection, const RemoteVideoStats& stats) {
544 (void)connection;
545 (void)stats;
546 }
547
558 virtual void onConnectionLost(const RtcConnection& connection) {
559 (void)connection;
560 }
561
575 virtual void onConnectionInterrupted(const RtcConnection& connection) __deprecated {
576 (void)connection;
577 }
578
583 virtual void onConnectionBanned(const RtcConnection& connection) {
584 (void)connection;
585 }
586
599 virtual void onStreamMessage(const RtcConnection& connection, uid_t remoteUid, int streamId, const char* data, size_t length, uint64_t sentTs) {
600 (void)connection;
601 (void)remoteUid;
602 (void)streamId;
603 (void)data;
604 (void)length;
605 (void)sentTs;
606 }
607
621 virtual void onStreamMessageError(const RtcConnection& connection, uid_t remoteUid, int streamId, int code, int missed, int cached) {
622 (void)connection;
623 (void)remoteUid;
624 (void)streamId;
625 (void)code;
626 (void)missed;
627 (void)cached;
628 }
629
640 virtual void onRequestToken(const RtcConnection& connection) {
641 (void)connection;
642 }
643
649 virtual void onLicenseValidationFailure(const RtcConnection& connection, LICENSE_ERROR_TYPE reason) {
650 (void)connection;
651 (void)reason;
652 }
653
665 virtual void onTokenPrivilegeWillExpire(const RtcConnection& connection, const char* token) {
666 (void)connection;
667 (void)token;
668 }
669
681 virtual void onFirstLocalAudioFramePublished(const RtcConnection& connection, int elapsed) {
682 (void)connection;
683 (void)elapsed;
684 }
685
694 virtual void onFirstRemoteAudioFrame(const RtcConnection& connection, uid_t userId, int elapsed) __deprecated {
695 (void)connection;
696 (void)userId;
697 (void)elapsed;
698 }
699
717 virtual void onFirstRemoteAudioDecoded(const RtcConnection& connection, uid_t uid, int elapsed) __deprecated {
718 (void)connection;
719 (void)uid;
720 (void)elapsed;
721 }
722
738 virtual void onLocalAudioStateChanged(const RtcConnection& connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason) {
739 (void)connection;
740 (void)state;
741 (void)reason;
742 }
743
761 virtual void onRemoteAudioStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
762 (void)connection;
763 (void)remoteUid;
764 (void)state;
765 (void)reason;
766 (void)elapsed;
767 }
768
783 virtual void onActiveSpeaker(const RtcConnection& connection, uid_t uid) {
784 (void)connection;
785 (void)uid;
786 }
787
796 virtual void onClientRoleChanged(const RtcConnection& connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
797 (void)connection;
798 (void)oldRole;
799 (void)newRole;
800 (void)newRoleOptions;
801 }
802
811 virtual void onClientRoleChangeFailed(const RtcConnection& connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) {
812 (void)connection;
813 (void)reason;
814 (void)currentRole;
815 }
816
832 virtual void onRemoteAudioTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
833 unsigned short rxKBitRate) __deprecated {
834 (void)connection;
835 (void)remoteUid;
836 (void)delay;
837 (void)lost;
838 (void)rxKBitRate;
839 }
840
859 virtual void onRemoteVideoTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
860 unsigned short rxKBitRate) __deprecated {
861 (void)connection;
862 (void)remoteUid;
863 (void)delay;
864 (void)lost;
865 (void)rxKBitRate;
866 }
867
877 virtual void onConnectionStateChanged(const RtcConnection& connection,
878 CONNECTION_STATE_TYPE state,
879 CONNECTION_CHANGED_REASON_TYPE reason) {
880 (void)connection;
881 (void)state;
882 (void)reason;
883 }
884
892 virtual void onWlAccMessage(const RtcConnection& connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char* wlAccMsg) {
893 (void)connection;
894 (void)reason;
895 (void)action;
896 (void)wlAccMsg;
897 }
898
905 virtual void onWlAccStats(const RtcConnection& connection, WlAccStats currentStats, WlAccStats averageStats) {
906 (void)connection;
907 (void)currentStats;
908 (void)averageStats;
909 }
910
920 virtual void onNetworkTypeChanged(const RtcConnection& connection, NETWORK_TYPE type) {
921 (void)connection;
922 (void)type;
923 }
924
932 virtual void onEncryptionError(const RtcConnection& connection, ENCRYPTION_ERROR_TYPE errorType) {
933 (void)connection;
934 (void)errorType;
935 }
943 virtual void onUploadLogResult(const RtcConnection& connection, const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
944 (void)connection;
945 (void)requestId;
946 (void)success;
947 (void)reason;
948 }
949
957 virtual void onUserAccountUpdated(const RtcConnection& connection, uid_t remoteUid, const char* remoteUserAccount){
958 (void)connection;
959 (void)remoteUid;
960 (void)remoteUserAccount;
961 }
962
980 virtual void onSnapshotTaken(const RtcConnection& connection, uid_t uid, const char* filePath, int width, int height, int errCode) {
981 (void)uid;
982 (void)filePath;
983 (void)width;
984 (void)height;
985 (void)errCode;
986 }
987
996 virtual void onVideoRenderingTracingResult(const RtcConnection& connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {
997 (void)uid;
998 (void)currentEvent;
999 (void)tracingInfo;
1000 }
1001
1008 virtual void onSetRtmFlagResult(const RtcConnection& connection, int code) {
1009 (void)connection;
1010 (void)code;
1011 }
1022 virtual void onTranscodedStreamLayoutInfo(const RtcConnection& connection, uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
1023 (void)uid;
1024 (void)width;
1025 (void)height;
1026 (void)layoutCount;
1027 (void)layoutlist;
1028 }
1029
1039 virtual void onAudioMetadataReceived(const RtcConnection& connection, uid_t uid, const char* metadata, size_t length) {
1040 (void)metadata;
1041 (void)length;
1042 }
1043 };
1044
1045 class IRtcEngineEx : public IRtcEngine {
1046 public:
1099 virtual int joinChannelEx(const char* token, const RtcConnection& connection,
1100 const ChannelMediaOptions& options,
1101 IRtcEngineEventHandler* eventHandler) = 0;
1102
1117 virtual int leaveChannelEx(const RtcConnection& connection) = 0;
1118
1128 virtual int leaveChannelEx(const RtcConnection& connection, const LeaveChannelOptions& options) = 0;
1129
1155 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount) = 0;
1156
1177 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount, const LeaveChannelOptions& options) = 0;
1178
1188 virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions& options, const RtcConnection& connection) = 0;
1206 virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration& config, const RtcConnection& connection) = 0;
1228 virtual int setupRemoteVideoEx(const VideoCanvas& canvas, const RtcConnection& connection) = 0;
1246 virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1264 virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1283 virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection& connection) = 0;
1297 virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection& connection) = 0;
1298
1312 virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection& connection) = 0;
1313
1327 virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection& connection) = 0;
1328
1342 virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection& connection) = 0;
1343
1344
1360 virtual int setSubscribeAudioBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1361
1378 virtual int setSubscribeAudioAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1379
1395 virtual int setSubscribeVideoBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1396
1413 virtual int setSubscribeVideoAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1425 virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions& options, const RtcConnection& connection) = 0;
1447 virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection& connection) = 0;
1458 virtual int setRemoteUserSpatialAudioParamsEx(uid_t uid, const agora::SpatialAudioParams& params, const RtcConnection& connection) = 0;
1480 virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode,
1481 VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection& connection) = 0;
1501 virtual int enableLoopbackRecordingEx(const RtcConnection& connection, bool enabled, const char* deviceName = NULL) = 0;
1502
1517 virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection& connection) = 0;
1518
1532 virtual int muteRecordingSignalEx(bool mute, const RtcConnection& connection) = 0;
1533
1553 virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection& connection) = 0;
1554
1559 virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection& connection) = 0;
1582 virtual int enableEncryptionEx(const RtcConnection& connection, bool enabled, const EncryptionConfig& config) = 0;
1615 virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
1626 virtual int createDataStreamEx(int* streamId, const DataStreamConfig& config, const RtcConnection& connection) = 0;
1658 virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
1685 virtual int addVideoWatermarkEx(const char* watermarkUrl, const WatermarkOptions& options, const RtcConnection& connection) = 0;
1694 virtual int clearVideoWatermarkEx(const RtcConnection& connection) = 0;
1704 virtual int sendCustomReportMessageEx(const char* id, const char* category, const char* event, const char* label,
1705 int value, const RtcConnection& connection) = 0;
1706
1733 virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection& connection) = 0;
1734
1744 virtual int startRtmpStreamWithoutTranscodingEx(const char* url, const RtcConnection& connection) = 0;
1745
1756 virtual int startRtmpStreamWithTranscodingEx(const char* url, const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
1757
1768 virtual int updateRtmpTranscodingEx(const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
1769
1777 virtual int stopRtmpStreamEx(const char* url, const RtcConnection& connection) = 0;
1778
1792 virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration& configuration, const RtcConnection& connection) = 0;
1793
1808 virtual int stopChannelMediaRelayEx(const RtcConnection& connection) = 0;
1809
1821 virtual int pauseAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
1822
1834 virtual int resumeAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
1835
1849 virtual int getUserInfoByUserAccountEx(const char* userAccount, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
1850
1864 virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
1865
1881 virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig& streamConfig,
1882 const RtcConnection& connection) = 0;
1894 virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode,
1895 const SimulcastStreamConfig& streamConfig,
1896 const RtcConnection& connection) = 0;
1897
1913 virtual int setSimulcastConfigEx(const SimulcastConfig& simulcastConfig,
1914 const RtcConnection& connection) = 0;
1915
1932 virtual int setHighPriorityUserListEx(uid_t* uidList, int uidNum,
1933 STREAM_FALLBACK_OPTIONS option,
1934 const RtcConnection& connection) = 0;
1935
1965 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0;
1966
1992 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const media::SnapshotConfig& config) = 0;
1993
2004 virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection& connection) = 0;
2005
2022 virtual int startMediaRenderingTracingEx(const RtcConnection& connection) = 0;
2023
2032 virtual int setParametersEx(const RtcConnection& connection, const char* parameters) = 0;
2033
2051 virtual int getCallIdEx(agora::util::AString& callId, const RtcConnection& connection) = 0;
2052
2064 virtual int sendAudioMetadataEx(const RtcConnection& connection, const char* metadata, size_t length) = 0;
2065 };
2066
2067 } // namespace rtc
2068 } // namespace agora
agora::rtc::IRtcEngineEx::muteRemoteVideoStreamEx
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
agora::VideoLayout
Definition: AgoraBase.h:6908
agora::rtc::IRtcEngineEx::startRtmpStreamWithTranscodingEx
virtual int startRtmpStreamWithTranscodingEx(const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::takeSnapshotEx
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const media::SnapshotConfig &config)=0
agora::rtc::IRtcEngineEventHandlerEx::onAudioQuality
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) __deprecated
Definition: IAgoraRtcEngineEx.h:151
agora::rtc::IRtcEngineEventHandler::onUserAccountUpdated
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2763
agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted
virtual void onConnectionInterrupted(const RtcConnection &connection) __deprecated
Definition: IAgoraRtcEngineEx.h:575
agora::rtc::IRtcEngineEventHandlerEx::onIntraRequestReceived
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:257
agora::rtc::IRtcEngineEx::setRemoteVoicePositionEx
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection &connection)=0
agora::rtc::UserInfo
Definition: AgoraBase.h:6474
agora::rtc::AudioVolumeInfo
Definition: AgoraBase.h:3407
agora::rtc::IRtcEngineEx::sendStreamMessageEx
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setRemoteVideoStreamTypeEx
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onIntraRequestReceived
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1745
agora::rtc::IRtcEngineEventHandler::onLeaveChannel
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1641
agora::rtc::IRtcEngineEventHandler::onStreamMessage
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:2244
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:1834
agora::rtc::WLACC_MESSAGE_REASON
WLACC_MESSAGE_REASON
Definition: AgoraBase.h:4562
agora::rtc::IRtcEngineEx::setRemoteVideoSubscriptionOptionsEx
virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setDualStreamModeEx
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2626
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2349
agora::rtc::IRtcEngineEventHandlerEx::onConnectionBanned
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:583
agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:1882
agora::rtc::REMOTE_AUDIO_STATE
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:3131
agora::rtc::IRtcEngineEx::leaveChannelEx
virtual int leaveChannelEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2775
agora::rtc::IRtcEngineEventHandler::onLocalAudioStats
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:2059
agora::rtc::IRtcEngineEventHandlerEx::onUserStateChanged
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition: IAgoraRtcEngineEx.h:485
agora::rtc::IRtcEngineEventHandler::onClientRoleChangeFailed
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2464
agora::rtc::IRtcEngineEventHandlerEx::onUploadLogResult
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngineEx.h:943
agora::rtc::LiveTranscoding
Definition: AgoraBase.h:3967
agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngine.h:2650
agora::rtc::IRtcEngineEventHandler::eventHandlerType
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:1511
agora::rtc::IRtcEngineEx::enableEncryptionEx
virtual int enableEncryptionEx(const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
agora::rtc::IRtcEngineEx::resumeAllChannelMediaRelayEx
virtual int resumeAllChannelMediaRelayEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::adjustUserPlaybackSignalVolumeEx
virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setRemoteUserSpatialAudioParamsEx
virtual int setRemoteUserSpatialAudioParamsEx(uid_t uid, const agora::SpatialAudioParams &params, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUserInfoUpdated
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Definition: IAgoraRtcEngine.h:2752
agora::rtc::IRtcEngineEventHandler::onNetworkTypeChanged
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2702
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:2337
agora::rtc::SIMULCAST_STREAM_MODE
SIMULCAST_STREAM_MODE
Definition: AgoraBase.h:2119
agora::rtc::IRtcEngineEx::addVideoWatermarkEx
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx
Definition: IAgoraRtcEngineEx.h:42
agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2317
agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1538
agora::rtc::IRtcEngineEventHandlerEx::onActiveSpeaker
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:783
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1924
agora::rtc::IRtcEngineEventHandler
Definition: IAgoraRtcEngine.h:1507
agora::rtc::IRtcEngineEx::leaveChannelWithUserAccountEx
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount, const LeaveChannelOptions &options)=0
agora::rtc::IRtcEngineEventHandler::onUserMuteAudio
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1975
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1613
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed) __deprecated
Definition: IAgoraRtcEngineEx.h:717
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:294
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed) __deprecated
Definition: IAgoraRtcEngineEx.h:694
agora::rtc::IRtcEngineEventHandlerEx::onStreamMessageError
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:621
agora::rtc::REMOTE_VIDEO_STATE_REASON
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:3246
agora::rtc::IRtcEngineEventHandlerEx::onNetworkQuality
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:243
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2137
agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted
virtual void onConnectionInterrupted() __deprecated
Definition: IAgoraRtcEngine.h:2226
agora::rtc::VIDEO_MIRROR_MODE_TYPE
VIDEO_MIRROR_MODE_TYPE
Definition: AgoraBase.h:1822
agora::rtc::IRtcEngineEventHandlerEx::onEncryptionError
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:932
agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoStats
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:543
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2389
agora::rtc::IRtcEngineEx::updateRtmpTranscodingEx
virtual int updateRtmpTranscodingEx(const LiveTranscoding &transcoding, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setHighPriorityUserListEx
virtual int setHighPriorityUserListEx(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onUserEnableLocalVideo
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated
Definition: IAgoraRtcEngineEx.h:472
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioStats
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:511
agora::rtc::IRtcEngineEx::setSubscribeVideoBlocklistEx
virtual int setSubscribeVideoBlocklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::muteAllRemoteAudioStreamsEx
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onWlAccMessage
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngine.h:2677
agora::rtc::IRtcEngineEventHandler::onRequestToken
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:2281
agora::rtc::REMOTE_VIDEO_STATE
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:3215
agora::rtc::IRtcEngineEventHandler::onUserStateChanged
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2021
agora::rtc::IRtcEngineEventHandlerEx::onUserMuteAudio
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated
Definition: IAgoraRtcEngineEx.h:415
agora::rtc::STREAM_FALLBACK_OPTIONS
STREAM_FALLBACK_OPTIONS
Definition: IAgoraRtcEngine.h:234
agora::rtc::WLACC_SUGGEST_ACTION
WLACC_SUGGEST_ACTION
Definition: AgoraBase.h:4576
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:349
agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1626
agora::rtc::IRtcEngineEventHandler::onStreamMessageError
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:2264
agora::rtc::IRtcEngineEx::muteAllRemoteVideoStreamsEx
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngineEx.h:185
agora::rtc::IRtcEngineEventHandler::onUserOffline
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1958
agora::rtc::IRtcEngineEventHandlerEx::onWlAccStats
virtual void onWlAccStats(const RtcConnection &connection, WlAccStats currentStats, WlAccStats averageStats)
Definition: IAgoraRtcEngineEx.h:905
agora::rtc::DataStreamConfig
Definition: AgoraBase.h:2092
agora::rtc::IRtcEngineEx::getUserInfoByUidEx
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::getUserInfoByUserAccountEx
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
agora::rtc::NETWORK_TYPE
NETWORK_TYPE
Definition: AgoraBase.h:4618
agora::rtc::IRtcEngineEx::sendCustomReportMessageEx
virtual int sendCustomReportMessageEx(const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUserEnableVideo
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:2011
agora::rtc::IRtcEngineEx::setSubscribeVideoAllowlistEx
virtual int setSubscribeVideoAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onAudioQuality
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
Definition: IAgoraRtcEngine.h:1584
agora::rtc::IRtcEngineEx::sendAudioMetadataEx
virtual int sendAudioMetadataEx(const RtcConnection &connection, const char *metadata, size_t length)=0
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStats
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:2089
agora::rtc::IRtcEngineEventHandler::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:2294
agora::rtc::IRtcEngineEx::setupRemoteVideoEx
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onWlAccMessage
virtual void onWlAccMessage(const RtcConnection &connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngineEx.h:892
agora::rtc::LeaveChannelOptions
Definition: IAgoraRtcEngine.h:1468
agora::rtc::IRtcEngineEx::stopChannelMediaRelayEx
virtual int stopChannelMediaRelayEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:2048
agora::rtc::IRtcEngineEventHandlerEx::onClientRoleChanged
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngineEx.h:796
agora::rtc::__deprecated
@ __deprecated
Definition: AgoraBase.h:894
agora::rtc::IRtcEngineEventHandlerEx::onRtcStats
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:215
agora::rtc::ChannelMediaRelayConfiguration
Definition: AgoraBase.h:6072
agora::rtc::RtcConnection::RtcConnection
RtcConnection(const char *channel_id, uid_t local_uid)
Definition: IAgoraRtcEngineEx.h:38
agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioStateChanged
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:761
agora::rtc::IRtcEngineEventHandler::onLocalVideoStats
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:2076
agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:681
agora::rtc::IRtcEngineEventHandler::onActiveSpeaker
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2409
agora::rtc::RtcConnection::RtcConnection
RtcConnection()
Definition: IAgoraRtcEngineEx.h:37
agora::rtc::IRtcEngineEx::muteLocalAudioStreamEx
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onAudioMetadataReceived
virtual void onAudioMetadataReceived(const RtcConnection &connection, uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngineEx.h:1039
agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1522
agora::rtc::IRtcEngineEx::leaveChannelEx
virtual int leaveChannelEx(const RtcConnection &connection, const LeaveChannelOptions &options)=0
agora::rtc::RtcConnection
Definition: IAgoraRtcEngineEx.h:20
agora::rtc::IRtcEngineEx::startOrUpdateChannelMediaRelayEx
virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::joinChannelEx
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
agora::rtc::CONNECTION_CHANGED_REASON_TYPE
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4417
agora::rtc::IRtcEngineEx::stopRtmpStreamEx
virtual int stopRtmpStreamEx(const char *url, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onAudioMetadataReceived
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:2895
agora::rtc::WlAccStats
Definition: AgoraBase.h:4600
agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:272
agora::rtc::IRtcEngineEx
Definition: IAgoraRtcEngineEx.h:1045
agora::rtc::IRtcEngineEx::createDataStreamEx
virtual int createDataStreamEx(int *streamId, const DataStreamConfig &config, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setRemoteRenderModeEx
virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setSubscribeAudioBlocklistEx
virtual int setSubscribeAudioBlocklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::getCallIdEx
virtual int getCallIdEx(agora::util::AString &callId, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onConnectionBanned
virtual void onConnectionBanned() __deprecated
Definition: IAgoraRtcEngine.h:2231
agora::rtc::IRtcEngineEx::enableDualStreamModeEx
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onEncryptionError
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2713
agora::rtc::REMOTE_AUDIO_STATE_REASON
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:3165
agora::rtc::IRtcEngineEventHandlerEx::onRequestToken
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:640
agora::rtc::IRtcEngineEx::getConnectionStateEx
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onWlAccStats
virtual void onWlAccStats(const WlAccStats &currentStats, const WlAccStats &averageStats)
Definition: IAgoraRtcEngine.h:2688
agora::rtc::IRtcEngineEventHandlerEx::eventHandlerType
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngineEx.h:106
agora::rtc::IRtcEngineEx::adjustRecordingSignalVolumeEx
virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onUserJoined
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:377
agora::rtc::VIDEO_SOURCE_TYPE
VIDEO_SOURCE_TYPE
Definition: AgoraMediaBase.h:68
agora::rtc::LocalVideoStats
Definition: IAgoraRtcEngine.h:275
agora::rtc::IRtcEngineEx::startRtmpStreamWithoutTranscodingEx
virtual int startRtmpStreamWithoutTranscodingEx(const char *url, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::muteRemoteAudioStreamEx
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2368
agora::media::base::RENDER_MODE_TYPE
RENDER_MODE_TYPE
Definition: AgoraMediaBase.h:592
agora::rtc::IRtcEngineEventHandler::onAudioSubscribeStateChanged
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2813
agora::rtc::IRtcEngineEx::muteRecordingSignalEx
virtual int muteRecordingSignalEx(bool mute, const RtcConnection &connection)=0
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:6282
agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioTransportStats
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngineEx.h:832
agora::media::SnapshotConfig
Definition: AgoraMediaBase.h:1213
agora::rtc::IRtcEngineEventHandler::onVideoPublishStateChanged
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2862
agora::rtc::IRtcEngineEventHandlerEx::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:665
agora::rtc::RemoteAudioStats
Definition: IAgoraRtcEngine.h:366
agora::rtc::IRtcEngineEx::updateChannelMediaOptionsEx
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onSnapshotTaken
virtual void onSnapshotTaken(const RtcConnection &connection, uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngineEx.h:980
agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStats
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:499
agora::LICENSE_ERROR_TYPE
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:762
agora::rtc::IRtcEngineEventHandler::onConnectionLost
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:2213
agora::rtc::IRtcEngineEventHandler::onUserMuteVideo
virtual void onUserMuteVideo(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1994
agora::rtc::IRtcEngineEx::setSimulcastConfigEx
virtual int setSimulcastConfigEx(const SimulcastConfig &simulcastConfig, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onVideoSizeChanged
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1849
agora::rtc::IRtcEngineEventHandlerEx::onSetRtmFlagResult
virtual void onSetRtmFlagResult(const RtcConnection &connection, int code)
Definition: IAgoraRtcEngineEx.h:1008
agora::rtc::RtcStats
Definition: AgoraBase.h:2321
agora::rtc::IRtcEngineEx::setParametersEx
virtual int setParametersEx(const RtcConnection &connection, const char *parameters)=0
agora::rtc::USER_OFFLINE_REASON_TYPE
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:852
agora::rtc::IRtcEngineEventHandler::onSnapshotTaken
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngine.h:2436
agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoTransportStats
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition: IAgoraRtcEngineEx.h:859
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1913
agora::rtc::WatermarkOptions
Definition: AgoraBase.h:2284
agora::rtc::IRtcEngineEventHandlerEx::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:116
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3584
agora::rtc::SimulcastConfig
Definition: AgoraBase.h:2161
agora::rtc::IRtcEngineEventHandler::onClientRoleChanged
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngine.h:2451
agora::rtc::LOCAL_AUDIO_STREAM_REASON
LOCAL_AUDIO_STREAM_REASON
Definition: AgoraBase.h:2928
agora::rtc::IRtcEngineEx::muteLocalVideoStreamEx
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setVideoEncoderConfigurationEx
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onRejoinChannelSuccess
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:130
agora::rtc::IRtcEngineEx::startMediaRenderingTracingEx
virtual int startMediaRenderingTracingEx(const RtcConnection &connection)=0
Start tracing media rendering events.
agora::rtc::VIDEO_STREAM_TYPE
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1577
agora::rtc::ChannelMediaOptions
Definition: IAgoraRtcEngine.h:1059
agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoStateChanged
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:333
agora::rtc::IRtcEngine
Definition: IAgoraRtcEngine.h:3539
agora::rtc::IRtcEngineEventHandlerEx::onUserOffline
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:398
agora::rtc::IRtcEngineEventHandlerEx::onVideoSizeChanged
virtual void onVideoSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:312
agora::rtc::UPLOAD_ERROR_REASON
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:6366
agora::rtc::IRtcEngineEx::enableContentInspectEx
virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection &connection)=0
agora::rtc::RtcConnection::channelId
const char * channelId
Definition: IAgoraRtcEngineEx.h:31
agora::rtc::IRtcEngineEventHandler::onTranscodedStreamLayoutInfo
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngine.h:2879
agora::rtc::MEDIA_TRACE_EVENT
MEDIA_TRACE_EVENT
Definition: AgoraBase.h:6651
agora::rtc::IRtcEngineEventHandlerEx::onUserAccountUpdated
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *remoteUserAccount)
Definition: IAgoraRtcEngineEx.h:957
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:156
agora::rtc::IRtcEngineEx::setSubscribeAudioAllowlistEx
virtual int setSubscribeAudioAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::enableLoopbackRecordingEx
virtual int enableLoopbackRecordingEx(const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
agora::rtc::IRtcEngineEventHandlerEx::onNetworkTypeChanged
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:920
agora::rtc::IRtcEngineEventHandlerEx::onLeaveChannel
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:202
agora::rtc::LOCAL_AUDIO_STREAM_STATE
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2906
agora::rtc::IRtcEngineEventHandlerEx::onUserMuteVideo
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted)
Definition: IAgoraRtcEngineEx.h:436
agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1813
agora::media::ContentInspectConfig
Definition: AgoraMediaBase.h:354
agora::rtc::IRtcEngineEventHandler::onSetRtmFlagResult
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:2960
agora::rtc::IRtcEngineEx::pauseAllChannelMediaRelayEx
virtual int pauseAllChannelMediaRelayEx(const RtcConnection &connection)=0
agora::rtc::CLIENT_ROLE_CHANGE_FAILED_REASON
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4538
agora::rtc::IRtcEngineEventHandler::onNetworkQuality
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1733
agora::rtc::uid_t
unsigned int uid_t
Definition: AgoraMediaBase.h:28
agora::rtc::IRtcEngineEventHandlerEx::onLocalVideoStats
virtual void onLocalVideoStats(const RtcConnection &connection, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:529
agora::rtc::IRtcEngineEx::createDataStreamEx
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onConnectionLost
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:558
agora::rtc::IRtcEngineEventHandler::onVideoSubscribeStateChanged
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2830
agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngineEx.h:738
agora::rtc::IRtcEngineEventHandlerEx::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(const RtcConnection &connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngineEx.h:996
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStateChanged
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1899
agora::rtc::CLIENT_ROLE_TYPE
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2520
agora::rtc::IRtcEngineEventHandlerEx::onLicenseValidationFailure
virtual void onLicenseValidationFailure(const RtcConnection &connection, LICENSE_ERROR_TYPE reason)
Definition: IAgoraRtcEngineEx.h:649
agora::rtc::RtcConnection::localUid
uid_t localUid
Definition: IAgoraRtcEngineEx.h:35
agora::rtc::ENCRYPTION_ERROR_TYPE
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:6341
agora::SpatialAudioParams
Definition: AgoraBase.h:6871
agora::rtc::IRtcEngineEventHandler::onUploadLogResult
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2798
agora::rtc::IRtcEngineEx::leaveChannelWithUserAccountEx
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount)=0
agora::rtc::IRtcEngineEventHandlerEx::onUserEnableVideo
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition: IAgoraRtcEngineEx.h:455
agora::rtc::IRtcEngineEx::enableAudioVolumeIndicationEx
virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onClientRoleChangeFailed
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngineEx.h:811
agora::rtc::IRtcEngineEventHandler::onRtcStats
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1650
agora::rtc::IRtcEngineEventHandler::onUserJoined
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1939
agora::rtc::CONNECTION_STATE_TYPE
CONNECTION_STATE_TYPE
Definition: AgoraBase.h:3850
agora::rtc::IRtcEngineEventHandlerEx::onTranscodedStreamLayoutInfo
virtual void onTranscodedStreamLayoutInfo(const RtcConnection &connection, uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngineEx.h:1022
agora::rtc::IRtcEngineEventHandlerEx::onStreamMessage
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngineEx.h:599
agora::rtc::VideoRenderingTracingInfo
Definition: AgoraBase.h:6665
agora::rtc::IRtcEngineEventHandler::onLicenseValidationFailure
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2303
rtc
Definition: video_node_i.h:28
agora::rtc::RemoteVideoStats
Definition: IAgoraRtcEngine.h:492
agora::rtc::ClientRoleOptions
Definition: AgoraBase.h:2568
agora::rtc::IRtcEngineEventHandlerEx::onConnectionStateChanged
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:877
agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:2036
agora::rtc::IRtcEngineEventHandler::onAudioPublishStateChanged
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2846
agora::rtc::IRtcEngineEx::takeSnapshotEx
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const char *filePath)=0
agora::rtc::VideoCanvas
Definition: AgoraBase.h:4674
agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2665
agora::rtc::IRtcEngineEx::clearVideoWatermarkEx
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0