Agora RTC Objective-C API Reference Refactor

IAgoraRtcEngineEx.h
Go to the documentation of this file.
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 using IRtcEngineEventHandler::onMultipathStats;
106
107 virtual const char* eventHandlerType() const { return "event_handler_ex"; }
108
117 virtual void onJoinChannelSuccess(const RtcConnection& connection, int elapsed) {
118 (void)connection;
119 (void)elapsed;
120 }
121
131 virtual void onRejoinChannelSuccess(const RtcConnection& connection, int elapsed) {
132 (void)connection;
133 (void)elapsed;
134 }
135
152 virtual void onAudioQuality(const RtcConnection& connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) __deprecated {
153 (void)connection;
154 (void)remoteUid;
155 (void)quality;
156 (void)delay;
157 (void)lost;
158 }
186 virtual void onAudioVolumeIndication(const RtcConnection& connection, const AudioVolumeInfo* speakers,
187 unsigned int speakerNumber, int totalVolume) {
188 (void)connection;
189 (void)speakers;
190 (void)speakerNumber;
191 (void)totalVolume;
192 }
193
203 virtual void onLeaveChannel(const RtcConnection& connection, const RtcStats& stats) {
204 (void)connection;
205 (void)stats;
206 }
207
216 virtual void onRtcStats(const RtcConnection& connection, const RtcStats& stats) {
217 (void)connection;
218 (void)stats;
219 }
220
244 virtual void onNetworkQuality(const RtcConnection& connection, uid_t remoteUid, int txQuality, int rxQuality) {
245 (void)connection;
246 (void)remoteUid;
247 (void)txQuality;
248 (void)rxQuality;
249 }
250
258 virtual void onIntraRequestReceived(const RtcConnection& connection) {
259 (void)connection;
260 }
261
273 virtual void onFirstLocalVideoFramePublished(const RtcConnection& connection, int elapsed) {
274 (void)connection;
275 (void)elapsed;
276 }
277
295 virtual void onFirstRemoteVideoDecoded(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
296 (void)connection;
297 (void)remoteUid;
298 (void)width;
299 (void)height;
300 (void)elapsed;
301 }
302
313 virtual void onVideoSizeChanged(const RtcConnection& connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
314 (void)connection;
315 (void)sourceType;
316 (void)uid;
317 (void)width;
318 (void)height;
319 (void)rotation;
320 }
321
334 virtual void onRemoteVideoStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) {
335 (void)connection;
336 (void)remoteUid;
337 (void)state;
338 (void)reason;
339 (void)elapsed;
340 }
341
350 virtual void onFirstRemoteVideoFrame(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
351 (void)connection;
352 (void)remoteUid;
353 (void)width;
354 (void)height;
355 (void)elapsed;
356 }
357
378 virtual void onUserJoined(const RtcConnection& connection, uid_t remoteUid, int elapsed) {
379 (void)connection;
380 (void)remoteUid;
381 (void)elapsed;
382 }
383
399 virtual void onUserOffline(const RtcConnection& connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason) {
400 (void)connection;
401 (void)remoteUid;
402 (void)reason;
403 }
404
416 virtual void onUserMuteAudio(const RtcConnection& connection, uid_t remoteUid, bool muted) __deprecated {
417 (void)connection;
418 (void)remoteUid;
419 (void)muted;
420 }
421
437 virtual void onUserMuteVideo(const RtcConnection& connection, uid_t remoteUid, bool muted) {
438 (void)connection;
439 (void)remoteUid;
440 (void)muted;
441 }
442
456 virtual void onUserEnableVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) {
457 (void)connection;
458 (void)remoteUid;
459 (void)enabled;
460 }
461
473 virtual void onUserEnableLocalVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) __deprecated {
474 (void)connection;
475 (void)remoteUid;
476 (void)enabled;
477 }
478
486 virtual void onUserStateChanged(const RtcConnection& connection, uid_t remoteUid, uint32_t state) {
487 (void)connection;
488 (void)remoteUid;
489 (void)state;
490 }
491
500 virtual void onLocalAudioStats(const RtcConnection& connection, const LocalAudioStats& stats) {
501 (void)connection;
502 (void)stats;
503 }
504
512 virtual void onRemoteAudioStats(const RtcConnection& connection, const RemoteAudioStats& stats) {
513 (void)connection;
514 (void)stats;
515 }
516
530 virtual void onLocalVideoStats(const RtcConnection& connection, const LocalVideoStats& stats) {
531 (void)connection;
532 (void)stats;
533 }
534
544 virtual void onRemoteVideoStats(const RtcConnection& connection, const RemoteVideoStats& stats) {
545 (void)connection;
546 (void)stats;
547 }
548
559 virtual void onConnectionLost(const RtcConnection& connection) {
560 (void)connection;
561 }
562
576 virtual void onConnectionInterrupted(const RtcConnection& connection) __deprecated {
577 (void)connection;
578 }
579
584 virtual void onConnectionBanned(const RtcConnection& connection) {
585 (void)connection;
586 }
587
600 virtual void onStreamMessage(const RtcConnection& connection, uid_t remoteUid, int streamId, const char* data, size_t length, uint64_t sentTs) {
601 (void)connection;
602 (void)remoteUid;
603 (void)streamId;
604 (void)data;
605 (void)length;
606 (void)sentTs;
607 }
608
622 virtual void onStreamMessageError(const RtcConnection& connection, uid_t remoteUid, int streamId, int code, int missed, int cached) {
623 (void)connection;
624 (void)remoteUid;
625 (void)streamId;
626 (void)code;
627 (void)missed;
628 (void)cached;
629 }
630
641 virtual void onRequestToken(const RtcConnection& connection) {
642 (void)connection;
643 }
644
650 virtual void onLicenseValidationFailure(const RtcConnection& connection, LICENSE_ERROR_TYPE reason) {
651 (void)connection;
652 (void)reason;
653 }
654
666 virtual void onTokenPrivilegeWillExpire(const RtcConnection& connection, const char* token) {
667 (void)connection;
668 (void)token;
669 }
670
682 virtual void onFirstLocalAudioFramePublished(const RtcConnection& connection, int elapsed) {
683 (void)connection;
684 (void)elapsed;
685 }
686
695 virtual void onFirstRemoteAudioFrame(const RtcConnection& connection, uid_t userId, int elapsed) __deprecated {
696 (void)connection;
697 (void)userId;
698 (void)elapsed;
699 }
700
718 virtual void onFirstRemoteAudioDecoded(const RtcConnection& connection, uid_t uid, int elapsed) __deprecated {
719 (void)connection;
720 (void)uid;
721 (void)elapsed;
722 }
723
739 virtual void onLocalAudioStateChanged(const RtcConnection& connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason) {
740 (void)connection;
741 (void)state;
742 (void)reason;
743 }
744
762 virtual void onRemoteAudioStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
763 (void)connection;
764 (void)remoteUid;
765 (void)state;
766 (void)reason;
767 (void)elapsed;
768 }
769
784 virtual void onActiveSpeaker(const RtcConnection& connection, uid_t uid) {
785 (void)connection;
786 (void)uid;
787 }
788
797 virtual void onClientRoleChanged(const RtcConnection& connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
798 (void)connection;
799 (void)oldRole;
800 (void)newRole;
801 (void)newRoleOptions;
802 }
803
812 virtual void onClientRoleChangeFailed(const RtcConnection& connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) {
813 (void)connection;
814 (void)reason;
815 (void)currentRole;
816 }
817
833 virtual void onRemoteAudioTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
834 unsigned short rxKBitRate) __deprecated {
835 (void)connection;
836 (void)remoteUid;
837 (void)delay;
838 (void)lost;
839 (void)rxKBitRate;
840 }
841
860 virtual void onRemoteVideoTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
861 unsigned short rxKBitRate) __deprecated {
862 (void)connection;
863 (void)remoteUid;
864 (void)delay;
865 (void)lost;
866 (void)rxKBitRate;
867 }
868
878 virtual void onConnectionStateChanged(const RtcConnection& connection,
879 CONNECTION_STATE_TYPE state,
880 CONNECTION_CHANGED_REASON_TYPE reason) {
881 (void)connection;
882 (void)state;
883 (void)reason;
884 }
885
893 virtual void onWlAccMessage(const RtcConnection& connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char* wlAccMsg) {
894 (void)connection;
895 (void)reason;
896 (void)action;
897 (void)wlAccMsg;
898 }
899
906 virtual void onWlAccStats(const RtcConnection& connection, WlAccStats currentStats, WlAccStats averageStats) {
907 (void)connection;
908 (void)currentStats;
909 (void)averageStats;
910 }
911
921 virtual void onNetworkTypeChanged(const RtcConnection& connection, NETWORK_TYPE type) {
922 (void)connection;
923 (void)type;
924 }
925
933 virtual void onEncryptionError(const RtcConnection& connection, ENCRYPTION_ERROR_TYPE errorType) {
934 (void)connection;
935 (void)errorType;
936 }
944 virtual void onUploadLogResult(const RtcConnection& connection, const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
945 (void)connection;
946 (void)requestId;
947 (void)success;
948 (void)reason;
949 }
950
958 virtual void onUserAccountUpdated(const RtcConnection& connection, uid_t remoteUid, const char* remoteUserAccount){
959 (void)connection;
960 (void)remoteUid;
961 (void)remoteUserAccount;
962 }
963
981 virtual void onSnapshotTaken(const RtcConnection& connection, uid_t uid, const char* filePath, int width, int height, int errCode) {
982 (void)uid;
983 (void)filePath;
984 (void)width;
985 (void)height;
986 (void)errCode;
987 }
988
997 virtual void onVideoRenderingTracingResult(const RtcConnection& connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {
998 (void)uid;
999 (void)currentEvent;
1000 (void)tracingInfo;
1001 }
1002
1009 virtual void onSetRtmFlagResult(const RtcConnection& connection, int code) {
1010 (void)connection;
1011 (void)code;
1012 }
1023 virtual void onTranscodedStreamLayoutInfo(const RtcConnection& connection, uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
1024 (void)uid;
1025 (void)width;
1026 (void)height;
1027 (void)layoutCount;
1028 (void)layoutlist;
1029 }
1030
1040 virtual void onAudioMetadataReceived(const RtcConnection& connection, uid_t uid, const char* metadata, size_t length) {
1041 (void)metadata;
1042 (void)length;
1043 }
1044
1053 virtual void onMultipathStats(const RtcConnection& connection, const MultipathStats& stats) {
1054 (void)stats;
1055 (void)connection;
1056 }
1057 };
1058
1059 class IRtcEngineEx : public IRtcEngine {
1060 public:
1113 virtual int joinChannelEx(const char* token, const RtcConnection& connection,
1114 const ChannelMediaOptions& options,
1115 IRtcEngineEventHandler* eventHandler) = 0;
1116
1131 virtual int leaveChannelEx(const RtcConnection& connection) = 0;
1132
1142 virtual int leaveChannelEx(const RtcConnection& connection, const LeaveChannelOptions& options) = 0;
1143
1169 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount) = 0;
1170
1191 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount, const LeaveChannelOptions& options) = 0;
1192
1202 virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions& options, const RtcConnection& connection) = 0;
1220 virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration& config, const RtcConnection& connection) = 0;
1242 virtual int setupRemoteVideoEx(const VideoCanvas& canvas, const RtcConnection& connection) = 0;
1260 virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1278 virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1297 virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection& connection) = 0;
1311 virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection& connection) = 0;
1312
1326 virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection& connection) = 0;
1327
1341 virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection& connection) = 0;
1342
1356 virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection& connection) = 0;
1357
1358
1374 virtual int setSubscribeAudioBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1375
1392 virtual int setSubscribeAudioAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1393
1409 virtual int setSubscribeVideoBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1410
1427 virtual int setSubscribeVideoAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1439 virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions& options, const RtcConnection& connection) = 0;
1461 virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection& connection) = 0;
1472 virtual int setRemoteUserSpatialAudioParamsEx(uid_t uid, const agora::SpatialAudioParams& params, const RtcConnection& connection) = 0;
1494 virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode,
1495 VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection& connection) = 0;
1515 virtual int enableLoopbackRecordingEx(const RtcConnection& connection, bool enabled, const char* deviceName = NULL) = 0;
1516
1531 virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection& connection) = 0;
1532
1546 virtual int muteRecordingSignalEx(bool mute, const RtcConnection& connection) = 0;
1547
1567 virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection& connection) = 0;
1568
1573 virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection& connection) = 0;
1596 virtual int enableEncryptionEx(const RtcConnection& connection, bool enabled, const EncryptionConfig& config) = 0;
1629 virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
1640 virtual int createDataStreamEx(int* streamId, const DataStreamConfig& config, const RtcConnection& connection) = 0;
1672 virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
1699 virtual int addVideoWatermarkEx(const char* watermarkUrl, const WatermarkOptions& options, const RtcConnection& connection) = 0;
1708 virtual int clearVideoWatermarkEx(const RtcConnection& connection) = 0;
1718 virtual int sendCustomReportMessageEx(const char* id, const char* category, const char* event, const char* label,
1719 int value, const RtcConnection& connection) = 0;
1720
1747 virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection& connection) = 0;
1748
1758 virtual int startRtmpStreamWithoutTranscodingEx(const char* url, const RtcConnection& connection) = 0;
1759
1770 virtual int startRtmpStreamWithTranscodingEx(const char* url, const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
1771
1782 virtual int updateRtmpTranscodingEx(const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
1783
1791 virtual int stopRtmpStreamEx(const char* url, const RtcConnection& connection) = 0;
1792
1806 virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration& configuration, const RtcConnection& connection) = 0;
1807
1822 virtual int stopChannelMediaRelayEx(const RtcConnection& connection) = 0;
1823
1835 virtual int pauseAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
1836
1848 virtual int resumeAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
1849
1863 virtual int getUserInfoByUserAccountEx(const char* userAccount, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
1864
1878 virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
1879
1895 virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig& streamConfig,
1896 const RtcConnection& connection) = 0;
1908 virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode,
1909 const SimulcastStreamConfig& streamConfig,
1910 const RtcConnection& connection) = 0;
1911
1927 virtual int setSimulcastConfigEx(const SimulcastConfig& simulcastConfig,
1928 const RtcConnection& connection) = 0;
1929
1946 virtual int setHighPriorityUserListEx(uid_t* uidList, int uidNum,
1947 STREAM_FALLBACK_OPTIONS option,
1948 const RtcConnection& connection) = 0;
1949
1979 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0;
1980
2006 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const media::SnapshotConfig& config) = 0;
2007
2018 virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection& connection) = 0;
2019
2036 virtual int startMediaRenderingTracingEx(const RtcConnection& connection) = 0;
2037
2046 virtual int setParametersEx(const RtcConnection& connection, const char* parameters) = 0;
2047
2065 virtual int getCallIdEx(agora::util::AString& callId, const RtcConnection& connection) = 0;
2066
2078 virtual int sendAudioMetadataEx(const RtcConnection& connection, const char* metadata, size_t length) = 0;
2079
2087 virtual int enableVideoImageSourceEx(bool enable, const ImageTrackOptions& options, const RtcConnection& connection) = 0;
2088
2116 virtual int preloadEffectEx(const RtcConnection& connection, int soundId, const char* filePath, int startPos = 0) = 0;
2117
2159 virtual int playEffectEx(const RtcConnection& connection, int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false, int startPos = 0) = 0;
2160 };
2161
2162 } // namespace rtc
2163 } // namespace agora
agora::rtc::IRtcEngineEventHandlerEx::onAudioQuality
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) 1
Definition: IAgoraRtcEngineEx.h:152
agora::rtc::IRtcEngineEventHandlerEx::onLicenseValidationFailure
virtual void onLicenseValidationFailure(const RtcConnection &connection, LICENSE_ERROR_TYPE reason)
Definition: IAgoraRtcEngineEx.h:650
agora::rtc::WLACC_MESSAGE_REASON
WLACC_MESSAGE_REASON
Definition: AgoraBase.h:4693
agora::rtc::UPLOAD_ERROR_REASON
UPLOAD_ERROR_REASON
Definition: AgoraBase.h:6727
agora::rtc::IRtcEngineEventHandler::onRequestToken
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:2353
agora::VideoLayout
Definition: AgoraBase.h:7250
agora::rtc::UserInfo
Definition: AgoraBase.h:6835
agora::rtc::IRtcEngineEventHandler::onLocalAudioStats
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:2131
agora::rtc::IRtcEngineEx::resumeAllChannelMediaRelayEx
virtual int resumeAllChannelMediaRelayEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUserStateChanged
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition: IAgoraRtcEngine.h:2093
agora::rtc::AudioVolumeInfo
Definition: AgoraBase.h:3538
agora::rtc::VIDEO_SOURCE_TYPE
VIDEO_SOURCE_TYPE
Definition: AgoraMediaBase.h:68
agora::rtc::IRtcEngineEventHandlerEx::onRtcStats
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:216
agora::rtc::REMOTE_AUDIO_STATE
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:3262
agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2737
agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:273
agora::rtc::IRtcEngineEventHandler::onConnectionBanned
virtual void onConnectionBanned() 1
Definition: IAgoraRtcEngine.h:2303
agora::rtc::IRtcEngineEventHandler::eventHandlerType
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:1566
agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoTransportStats
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngineEx.h:860
agora::rtc::IRtcEngineEx::muteAllRemoteVideoStreamsEx
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(const RtcConnection &connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngineEx.h:997
agora::rtc::IRtcEngineEventHandlerEx::onWlAccMessage
virtual void onWlAccMessage(const RtcConnection &connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngineEx.h:893
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:2934
agora::rtc::IRtcEngineEx::takeSnapshotEx
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const media::SnapshotConfig &config)=0
agora::rtc::IRtcEngineEx::setSubscribeAudioAllowlistEx
virtual int setSubscribeAudioAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::USER_OFFLINE_REASON_TYPE
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:853
agora::rtc::RtcConnection::channelId
const char * channelId
Definition: IAgoraRtcEngineEx.h:31
agora::rtc::uid_t
unsigned int uid_t
Definition: AgoraMediaBase.h:28
agora::rtc::IRtcEngineEventHandlerEx::onUserMuteAudio
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) 1
Definition: IAgoraRtcEngineEx.h:416
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngineEx.h:718
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:981
agora::rtc::IRtcEngineEventHandler::onClientRoleChanged
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngine.h:2523
agora::rtc::IRtcEngineEx::getUserInfoByUidEx
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onRejoinChannelSuccess
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:131
agora::rtc::IRtcEngineEventHandler::onLocalVideoStats
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:2148
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::onUserInfoUpdated
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Definition: IAgoraRtcEngine.h:2824
agora::rtc::IRtcEngineEx::muteRemoteVideoStreamEx
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onConnectionStateChanged
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:878
agora::rtc::LiveTranscoding
Definition: AgoraBase.h:4098
agora::rtc::IRtcEngineEventHandler::onWlAccMessage
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngine.h:2749
agora::rtc::IRtcEngineEx::leaveChannelEx
virtual int leaveChannelEx(const RtcConnection &connection, const LeaveChannelOptions &options)=0
agora::rtc::IRtcEngineEx::startMediaRenderingTracingEx
virtual int startMediaRenderingTracingEx(const RtcConnection &connection)=0
Start tracing media rendering events.
agora::rtc::IRtcEngineEventHandler::onUserOffline
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2030
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:313
agora::rtc::IRtcEngineEventHandler::onAudioPublishStateChanged
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2918
agora::rtc::IRtcEngineEventHandlerEx::onAudioMetadataReceived
virtual void onAudioMetadataReceived(const RtcConnection &connection, uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngineEx.h:1040
agora::rtc::IRtcEngineEventHandlerEx::onClientRoleChangeFailed
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngineEx.h:812
agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioStats
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:512
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:2902
agora::rtc::IRtcEngineEventHandler::onAudioQuality
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) 1
Definition: IAgoraRtcEngine.h:1639
agora::rtc::IRtcEngineEventHandlerEx::onConnectionBanned
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:584
agora::rtc::IRtcEngineEventHandlerEx
Definition: IAgoraRtcEngineEx.h:42
agora::rtc::IRtcEngineEventHandlerEx::onUserAccountUpdated
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *remoteUserAccount)
Definition: IAgoraRtcEngineEx.h:958
agora::rtc::IRtcEngineEx::enableContentInspectEx
virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::eventHandlerType
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngineEx.h:107
agora::rtc::VideoEncoderConfiguration
Definition: AgoraBase.h:1925
agora::rtc::IRtcEngineEventHandler
Definition: IAgoraRtcEngine.h:1562
agora::rtc::IRtcEngineEx::sendStreamMessageEx
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onAudioMetadataReceived
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition: IAgoraRtcEngine.h:2967
agora::rtc::IRtcEngineEventHandler::onUserEnableVideo
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:2083
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1614
agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted
virtual void onConnectionInterrupted(const RtcConnection &connection) 1
Definition: IAgoraRtcEngineEx.h:576
agora::rtc::IRtcEngineEventHandler::onVideoRenderingTracingResult
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition: IAgoraRtcEngine.h:2847
agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1681
agora::rtc::IRtcEngineEx::setSimulcastConfigEx
virtual int setSimulcastConfigEx(const SimulcastConfig &simulcastConfig, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::enableLoopbackRecordingEx
virtual int enableLoopbackRecordingEx(const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) 1
Definition: IAgoraRtcEngine.h:2108
agora::rtc::IRtcEngineEx::adjustUserPlaybackSignalVolumeEx
virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection &connection)=0
agora::rtc::SimulcastStreamConfig
Definition: AgoraBase.h:2138
agora::rtc::IRtcEngineEx::muteRemoteAudioStreamEx
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::createDataStreamEx
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUploadLogResult
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2870
agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStats
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:500
agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1593
agora::rtc::IRtcEngineEventHandlerEx::onActiveSpeaker
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:784
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed) 1
Definition: IAgoraRtcEngineEx.h:695
agora::rtc::IRtcEngineEx::setDualStreamModeEx
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
agora::rtc::VIDEO_MIRROR_MODE_TYPE
VIDEO_MIRROR_MODE_TYPE
Definition: AgoraBase.h:1823
agora::rtc::IRtcEngineEx::enableEncryptionEx
virtual int enableEncryptionEx(const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStats
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:2161
agora::rtc::CLIENT_ROLE_TYPE
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2627
agora::rtc::IRtcEngineEventHandler::onStreamMessageError
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:2336
agora::rtc::IRtcEngineEx::enableAudioVolumeIndicationEx
virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IRtcEngineEx::startOrUpdateChannelMediaRelayEx
virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
agora::rtc::ENCRYPTION_ERROR_TYPE
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:6702
agora::rtc::WLACC_SUGGEST_ACTION
WLACC_SUGGEST_ACTION
Definition: AgoraBase.h:4707
agora::rtc::IRtcEngineEventHandlerEx::onNetworkTypeChanged
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:921
agora::rtc::IRtcEngineEventHandler::onSnapshotTaken
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Definition: IAgoraRtcEngine.h:2508
agora::rtc::IRtcEngineEventHandlerEx::onStreamMessageError
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:622
agora::rtc::SIMULCAST_STREAM_MODE
SIMULCAST_STREAM_MODE
Definition: AgoraBase.h:2120
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:334
agora::rtc::REMOTE_VIDEO_STATE
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:3346
agora::rtc::IRtcEngineEventHandlerEx::onEncryptionError
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:933
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:600
agora::rtc::CONNECTION_CHANGED_REASON_TYPE
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:4548
agora::rtc::IRtcEngineEx::startRtmpStreamWithoutTranscodingEx
virtual int startRtmpStreamWithoutTranscodingEx(const char *url, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::adjustRecordingSignalVolumeEx
virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection &connection)=0
agora::rtc::DataStreamConfig
Definition: AgoraBase.h:2093
agora::rtc::IRtcEngineEx::setHighPriorityUserListEx
virtual int setHighPriorityUserListEx(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUserJoined
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:2011
agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:682
agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioTransportStats
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngineEx.h:833
agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngineEx.h:739
agora::rtc::IRtcEngineEx::joinChannelEx
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
agora::rtc::IRtcEngineEx::enableDualStreamModeEx
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::getUserInfoByUserAccountEx
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::setParametersEx
virtual int setParametersEx(const RtcConnection &connection, const char *parameters)=0
agora::rtc::IRtcEngineEventHandler::onNetworkTypeChanged
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2774
agora::rtc::IRtcEngineEx::getConnectionStateEx
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onRemoteVideoStateChanged
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1971
agora::rtc::LeaveChannelOptions
Definition: IAgoraRtcEngine.h:1523
agora::rtc::IRtcEngineEventHandlerEx::onUserEnableLocalVideo
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) 1
Definition: IAgoraRtcEngineEx.h:473
agora::rtc::IRtcEngineEventHandlerEx::onUserStateChanged
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition: IAgoraRtcEngineEx.h:486
agora::rtc::IRtcEngineEx::enableVideoImageSourceEx
virtual int enableVideoImageSourceEx(bool enable, const ImageTrackOptions &options, const RtcConnection &connection)=0
enable or disable video image source to replace the current video source published or resume it
agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:2389
agora::rtc::ChannelMediaRelayConfiguration
Definition: AgoraBase.h:6432
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:762
agora::rtc::IRtcEngineEventHandlerEx::onUserOffline
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:399
agora::rtc::IRtcEngineEventHandlerEx::onUserEnableVideo
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition: IAgoraRtcEngineEx.h:456
agora::rtc::IRtcEngineEventHandlerEx::onUploadLogResult
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngineEx.h:944
agora::rtc::IRtcEngineEventHandlerEx::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngineEx.h:186
agora::rtc::IRtcEngineEx::addVideoWatermarkEx
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::getCallIdEx
virtual int getCallIdEx(agora::util::AString &callId, const RtcConnection &connection)=0
agora::rtc::RtcConnection
Definition: IAgoraRtcEngineEx.h:20
agora::rtc::IRtcEngineEventHandlerEx::onLeaveChannel
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:203
agora::media::base::RENDER_MODE_TYPE
RENDER_MODE_TYPE
Definition: AgoraMediaBase.h:532
agora::rtc::IRtcEngineEx::muteLocalAudioStreamEx
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection &connection)=0
agora::rtc::WlAccStats
Definition: AgoraBase.h:4731
agora::rtc::IRtcEngineEventHandler::onTranscodedStreamLayoutInfo
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition: IAgoraRtcEngine.h:2951
agora::rtc::IRtcEngineEx
Definition: IAgoraRtcEngineEx.h:1059
agora::rtc::IRtcEngineEx::setRemoteVideoSubscriptionOptionsEx
virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:1954
agora::rtc::MEDIA_TRACE_EVENT
MEDIA_TRACE_EVENT
Definition: AgoraBase.h:6993
IAgoraRtcEngine.h
agora::rtc::IRtcEngineEx::clearVideoWatermarkEx
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) 1
Definition: IAgoraRtcEngine.h:1889
agora::rtc::IRtcEngineEx::muteLocalVideoStreamEx
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onUserMuteAudio
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2047
agora::rtc::IRtcEngineEventHandlerEx::onClientRoleChanged
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition: IAgoraRtcEngineEx.h:797
agora::rtc::IRtcEngineEx::stopRtmpStreamEx
virtual int stopRtmpStreamEx(const char *url, 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:1904
agora::rtc::LocalVideoStats
Definition: IAgoraRtcEngine.h:275
agora::rtc::MultipathStats
Aggregates statistics for all network paths used in multipath transmission.
Definition: AgoraBase.h:2381
agora::rtc::IRtcEngineEventHandlerEx::onConnectionLost
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:559
agora::rtc::STREAM_FALLBACK_OPTIONS
STREAM_FALLBACK_OPTIONS
Definition: IAgoraRtcEngine.h:234
agora::rtc::EncryptionConfig
Definition: AgoraBase.h:6642
agora::rtc::IRtcEngineEventHandlerEx::onWlAccStats
virtual void onWlAccStats(const RtcConnection &connection, WlAccStats currentStats, WlAccStats averageStats)
Definition: IAgoraRtcEngineEx.h:906
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngine.h:2409
agora::rtc::REMOTE_AUDIO_STATE_REASON
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:3296
agora::rtc::IRtcEngineEventHandler::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:2366
agora::rtc::IRtcEngineEventHandlerEx::onSetRtmFlagResult
virtual void onSetRtmFlagResult(const RtcConnection &connection, int code)
Definition: IAgoraRtcEngineEx.h:1009
agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) 1
Definition: IAgoraRtcEngine.h:2421
agora::rtc::IRtcEngineEx::updateRtmpTranscodingEx
virtual int updateRtmpTranscodingEx(const LiveTranscoding &transcoding, const RtcConnection &connection)=0
agora::media::SnapshotConfig
Definition: AgoraMediaBase.h:1225
agora::rtc::IRtcEngineEventHandler::onUserMuteVideo
virtual void onUserMuteVideo(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:2066
agora::rtc::RemoteAudioStats
Definition: IAgoraRtcEngine.h:366
agora::rtc::IRtcEngineEx::createDataStreamEx
virtual int createDataStreamEx(int *streamId, const DataStreamConfig &config, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEx::leaveChannelWithUserAccountEx
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount)=0
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2461
agora::rtc::IRtcEngineEventHandler::onUserAccountUpdated
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2835
agora::rtc::VIDEO_STREAM_TYPE
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1578
agora::rtc::IRtcEngineEx::leaveChannelEx
virtual int leaveChannelEx(const RtcConnection &connection)=0
agora::rtc::RtcStats
Definition: AgoraBase.h:2428
agora::rtc::IRtcEngineEventHandler::onSetRtmFlagResult
virtual void onSetRtmFlagResult(int code)
Definition: IAgoraRtcEngine.h:3032
agora::rtc::IRtcEngineEx::setVideoEncoderConfigurationEx
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onRequestToken
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:641
agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1577
agora::rtc::WatermarkOptions
Definition: AgoraBase.h:2285
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:1023
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3715
agora::rtc::SimulcastConfig
Definition: AgoraBase.h:2162
agora::rtc::LOCAL_AUDIO_STREAM_STATE
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:3014
__deprecated
#define __deprecated
Definition: AgoraBase.h:74
agora::rtc::IRtcEngineEventHandlerEx::onUserMuteVideo
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted)
Definition: IAgoraRtcEngineEx.h:437
agora::rtc::IRtcEngineEx::muteRecordingSignalEx
virtual int muteRecordingSignalEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted
virtual void onConnectionInterrupted() 1
Definition: IAgoraRtcEngine.h:2298
agora::rtc::IRtcEngineEventHandlerEx::onUserJoined
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:378
agora::rtc::ChannelMediaOptions
Definition: IAgoraRtcEngine.h:1060
agora::rtc::IRtcEngine
Definition: IAgoraRtcEngine.h:3825
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:2885
agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:2120
agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngine.h:2698
agora::rtc::IRtcEngineEx::pauseAllChannelMediaRelayEx
virtual int pauseAllChannelMediaRelayEx(const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onMultipathStats
virtual void onMultipathStats(const RtcConnection &connection, const MultipathStats &stats)
Report the multipath transmission statistics.
Definition: IAgoraRtcEngineEx.h:1053
agora::rtc::REMOTE_VIDEO_STATE_REASON
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:3377
agora::rtc::IRtcEngineEventHandlerEx::onIntraRequestReceived
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:258
agora::rtc::RtcConnection::RtcConnection
RtcConnection()
Definition: IAgoraRtcEngineEx.h:37
agora::rtc::IRtcEngineEventHandler::onClientRoleChangeFailed
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2536
agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition: IAgoraRtcEngine.h:2440
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:156
agora::rtc::NETWORK_TYPE
NETWORK_TYPE
Definition: AgoraBase.h:4749
agora::rtc::IRtcEngineEx::muteAllRemoteAudioStreamsEx
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:350
agora::rtc::IRtcEngineEventHandler::onWlAccStats
virtual void onWlAccStats(const WlAccStats &currentStats, const WlAccStats &averageStats)
Definition: IAgoraRtcEngine.h:2760
agora::rtc::IRtcEngineEx::setSubscribeVideoAllowlistEx
virtual int setSubscribeVideoAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onStreamMessage
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:2316
agora::rtc::IRtcEngineEx::updateChannelMediaOptionsEx
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onNetworkQuality
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1788
agora::rtc::IRtcEngineEx::startRtmpStreamWithTranscodingEx
virtual int startRtmpStreamWithTranscodingEx(const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandlerEx::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:666
agora::rtc::RtcConnection::localUid
uid_t localUid
Definition: IAgoraRtcEngineEx.h:35
agora::rtc::IRtcEngineEventHandler::onLicenseValidationFailure
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:2375
agora::rtc::RtcConnection::RtcConnection
RtcConnection(const char *channel_id, uid_t local_uid)
Definition: IAgoraRtcEngineEx.h:38
agora::rtc::IRtcEngineEx::stopChannelMediaRelayEx
virtual int stopChannelMediaRelayEx(const RtcConnection &connection)=0
agora::media::ContentInspectConfig
Definition: AgoraMediaBase.h:1201
agora::rtc::IRtcEngineEventHandlerEx::onLocalVideoStats
virtual void onLocalVideoStats(const RtcConnection &connection, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:530
agora::rtc::IRtcEngineEventHandlerEx::onJoinChannelSuccess
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:117
agora::rtc::ImageTrackOptions
Definition: IAgoraRtcEngine.h:1045
agora::rtc::IRtcEngineEx::sendAudioMetadataEx
virtual int sendAudioMetadataEx(const RtcConnection &connection, const char *metadata, size_t length)=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::IRtcEngineEventHandlerEx::onNetworkQuality
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:244
agora::rtc::IRtcEngineEx::setRemoteVideoStreamTypeEx
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
agora::LICENSE_ERROR_TYPE
LICENSE_ERROR_TYPE
Definition: AgoraBase.h:763
agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoStats
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:544
agora::rtc::IRtcEngineEx::leaveChannelWithUserAccountEx
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount, const LeaveChannelOptions &options)=0
agora::rtc::IRtcEngineEventHandler::onMultipathStats
virtual void onMultipathStats(const MultipathStats &stats)
Report the multipath transmission statistics.
Definition: IAgoraRtcEngine.h:3043
agora::rtc::CLIENT_ROLE_CHANGE_FAILED_REASON
CLIENT_ROLE_CHANGE_FAILED_REASON
Definition: AgoraBase.h:4669
agora::rtc::IRtcEngineEventHandler::onLeaveChannel
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1696
agora::rtc::IRtcEngineEventHandler::onEncryptionError
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2785
agora::rtc::VideoRenderingTracingInfo
Definition: AgoraBase.h:7007
agora::rtc::IRtcEngineEventHandler::onRtcStats
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1705
agora::rtc::IRtcEngineEx::takeSnapshotEx
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const char *filePath)=0
agora::rtc::IRtcEngineEventHandler::onActiveSpeaker
virtual void onActiveSpeaker(uid_t uid)
Definition: IAgoraRtcEngine.h:2481
agora::rtc::IRtcEngineEventHandler::onConnectionLost
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:2285
agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1868
agora::rtc::RemoteVideoStats
Definition: IAgoraRtcEngine.h:492
agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1985
agora::rtc::ClientRoleOptions
Definition: AgoraBase.h:2675
agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:295
agora::rtc::IRtcEngineEx::setRemoteVoicePositionEx
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection &connection)=0
agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) 1
Definition: IAgoraRtcEngine.h:2722
agora::rtc::IRtcEngineEx::setupRemoteVideoEx
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
agora::rtc::VideoCanvas
Definition: AgoraBase.h:4805
agora::rtc::IRtcEngineEventHandler::onIntraRequestReceived
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1800
agora::rtc::LOCAL_AUDIO_STREAM_REASON
LOCAL_AUDIO_STREAM_REASON
Definition: AgoraBase.h:3036