Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
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
12namespace agora {
13namespace rtc {
14
15// OPTIONAL_ENUM_CLASS RTC_EVENT;
16
24 const char* channelId;
29
31 RtcConnection(const char* channel_id, uid_t local_uid)
32 : channelId(channel_id), localUid(local_uid) {}
33};
34
39 public:
104
105 virtual const char* eventHandlerType() const { return "event_handler_ex"; }
106
115 virtual void onJoinChannelSuccess(const RtcConnection& connection, int elapsed) {
116 (void)connection;
117 (void)elapsed;
118 }
119
129 virtual void onRejoinChannelSuccess(const RtcConnection& connection, int elapsed) {
130 (void)connection;
131 (void)elapsed;
132 }
133
150 virtual void onAudioQuality(const RtcConnection& connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) __deprecated {
151 (void)connection;
152 (void)remoteUid;
153 (void)quality;
154 (void)delay;
155 (void)lost;
156 }
157
184 virtual void onAudioVolumeIndication(const RtcConnection& connection, const AudioVolumeInfo* speakers,
185 unsigned int speakerNumber, int totalVolume) {
186 (void)connection;
187 (void)speakers;
188 (void)speakerNumber;
189 (void)totalVolume;
190 }
191
201 virtual void onLeaveChannel(const RtcConnection& connection, const RtcStats& stats) {
202 (void)connection;
203 (void)stats;
204 }
205
214 virtual void onRtcStats(const RtcConnection& connection, const RtcStats& stats) {
215 (void)connection;
216 (void)stats;
217 }
218
242 virtual void onNetworkQuality(const RtcConnection& connection, uid_t remoteUid, int txQuality, int rxQuality) {
243 (void)connection;
244 (void)remoteUid;
245 (void)txQuality;
246 (void)rxQuality;
247 }
248
256 virtual void onIntraRequestReceived(const RtcConnection& connection) {
257 (void)connection;
258 }
259
271 virtual void onFirstLocalVideoFramePublished(const RtcConnection& connection, int elapsed) {
272 (void)connection;
273 (void)elapsed;
274 }
275
293 virtual void onFirstRemoteVideoDecoded(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
294 (void)connection;
295 (void)remoteUid;
296 (void)width;
297 (void)height;
298 (void)elapsed;
299 }
300
311 virtual void onVideoSizeChanged(const RtcConnection& connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation) {
312 (void)connection;
313 (void)sourceType;
314 (void)uid;
315 (void)width;
316 (void)height;
317 (void)rotation;
318 }
319
332 virtual void onRemoteVideoStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) {
333 (void)connection;
334 (void)remoteUid;
335 (void)state;
336 (void)reason;
337 (void)elapsed;
338 }
339
348 virtual void onFirstRemoteVideoFrame(const RtcConnection& connection, uid_t remoteUid, int width, int height, int elapsed) {
349 (void)connection;
350 (void)remoteUid;
351 (void)width;
352 (void)height;
353 (void)elapsed;
354 }
355
376 virtual void onUserJoined(const RtcConnection& connection, uid_t remoteUid, int elapsed) {
377 (void)connection;
378 (void)remoteUid;
379 (void)elapsed;
380 }
381
397 virtual void onUserOffline(const RtcConnection& connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason) {
398 (void)connection;
399 (void)remoteUid;
400 (void)reason;
401 }
402
414 virtual void onUserMuteAudio(const RtcConnection& connection, uid_t remoteUid, bool muted) __deprecated {
415 (void)connection;
416 (void)remoteUid;
417 (void)muted;
418 }
419
435 virtual void onUserMuteVideo(const RtcConnection& connection, uid_t remoteUid, bool muted) {
436 (void)connection;
437 (void)remoteUid;
438 (void)muted;
439 }
440
454 virtual void onUserEnableVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) {
455 (void)connection;
456 (void)remoteUid;
457 (void)enabled;
458 }
459
471 virtual void onUserEnableLocalVideo(const RtcConnection& connection, uid_t remoteUid, bool enabled) __deprecated {
472 (void)connection;
473 (void)remoteUid;
474 (void)enabled;
475 }
476
484 virtual void onUserStateChanged(const RtcConnection& connection, uid_t remoteUid, uint32_t state) {
485 (void)connection;
486 (void)remoteUid;
487 (void)state;
488 }
489
498 virtual void onLocalAudioStats(const RtcConnection& connection, const LocalAudioStats& stats) {
499 (void)connection;
500 (void)stats;
501 }
502
510 virtual void onRemoteAudioStats(const RtcConnection& connection, const RemoteAudioStats& stats) {
511 (void)connection;
512 (void)stats;
513 }
514
529 virtual void onLocalVideoStats(const RtcConnection& connection, VIDEO_SOURCE_TYPE sourceType, 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
644 virtual void onRdtMessage(const RtcConnection& connection, uid_t userId, RdtStreamType type, const char *data, size_t length) {
645 (void)connection;
646 (void)userId;
647 (void)type;
648 (void)data;
649 (void)length;
650 }
651
661 virtual void onRdtStateChanged(const RtcConnection& connection, uid_t userId, RdtState state) {
662 (void)connection;
663 (void)userId;
664 (void)state;
665 }
666
679 virtual void onMediaControlMessage(const RtcConnection& connection, uid_t userId, const char* data, size_t length) {
680 (void)connection;
681 (void)userId;
682 (void)data;
683 (void)length;
684 }
685
696 virtual void onRequestToken(const RtcConnection& connection) {
697 (void)connection;
698 }
699
705 virtual void onLicenseValidationFailure(const RtcConnection& connection, LICENSE_ERROR_TYPE reason) {
706 (void)connection;
707 (void)reason;
708 }
709
721 virtual void onTokenPrivilegeWillExpire(const RtcConnection& connection, const char* token) {
722 (void)connection;
723 (void)token;
724 }
725
737 virtual void onFirstLocalAudioFramePublished(const RtcConnection& connection, int elapsed) {
738 (void)connection;
739 (void)elapsed;
740 }
741
750 virtual void onFirstRemoteAudioFrame(const RtcConnection& connection, uid_t userId, int elapsed) __deprecated {
751 (void)connection;
752 (void)userId;
753 (void)elapsed;
754 }
755
773 virtual void onFirstRemoteAudioDecoded(const RtcConnection& connection, uid_t uid, int elapsed) __deprecated {
774 (void)connection;
775 (void)uid;
776 (void)elapsed;
777 }
778
795 (void)connection;
796 (void)state;
797 (void)reason;
798 }
799
817 virtual void onRemoteAudioStateChanged(const RtcConnection& connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) {
818 (void)connection;
819 (void)remoteUid;
820 (void)state;
821 (void)reason;
822 (void)elapsed;
823 }
824
839 virtual void onActiveSpeaker(const RtcConnection& connection, uid_t uid) {
840 (void)connection;
841 (void)uid;
842 }
843
852 virtual void onClientRoleChanged(const RtcConnection& connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions& newRoleOptions) {
853 (void)connection;
854 (void)oldRole;
855 (void)newRole;
856 (void)newRoleOptions;
857 }
858
868 (void)connection;
869 (void)reason;
870 (void)currentRole;
871 }
872
888 virtual void onRemoteAudioTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
889 unsigned short rxKBitRate) __deprecated {
890 (void)connection;
891 (void)remoteUid;
892 (void)delay;
893 (void)lost;
894 (void)rxKBitRate;
895 }
896
915 virtual void onRemoteVideoTransportStats(const RtcConnection& connection, uid_t remoteUid, unsigned short delay, unsigned short lost,
916 unsigned short rxKBitRate) __deprecated {
917 (void)connection;
918 (void)remoteUid;
919 (void)delay;
920 (void)lost;
921 (void)rxKBitRate;
922 }
923
933 virtual void onConnectionStateChanged(const RtcConnection& connection,
936 (void)connection;
937 (void)state;
938 (void)reason;
939 }
940
950 virtual void onNetworkTypeChanged(const RtcConnection& connection, NETWORK_TYPE type) {
951 (void)connection;
952 (void)type;
953 }
954
962 virtual void onEncryptionError(const RtcConnection& connection, ENCRYPTION_ERROR_TYPE errorType) {
963 (void)connection;
964 (void)errorType;
965 }
966
973 virtual void onUploadLogResult(const RtcConnection& connection, const char* requestId, bool success, UPLOAD_ERROR_REASON reason) {
974 (void)connection;
975 (void)requestId;
976 (void)success;
977 (void)reason;
978 }
979
987 virtual void onUserAccountUpdated(const RtcConnection& connection, uid_t remoteUid, const char* remoteUserAccount){
988 (void)connection;
989 (void)remoteUid;
990 (void)remoteUserAccount;
991 }
992
1010 virtual void onSnapshotTaken(const RtcConnection& connection, uid_t uid, const char* filePath, int width, int height, int errCode) {
1011 (void)uid;
1012 (void)filePath;
1013 (void)width;
1014 (void)height;
1015 (void)errCode;
1016 }
1017
1026 virtual void onVideoRenderingTracingResult(const RtcConnection& connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo) {
1027 (void)uid;
1028 (void)currentEvent;
1029 (void)tracingInfo;
1030 }
1031
1038 virtual void onSetRtmFlagResult(const RtcConnection& connection, int code) {
1039 (void)connection;
1040 (void)code;
1041 }
1042
1052 virtual void onTranscodedStreamLayoutInfo(const RtcConnection& connection, uid_t uid, int width, int height, int layoutCount,const VideoLayout* layoutlist) {
1053 (void)uid;
1054 (void)width;
1055 (void)height;
1056 (void)layoutCount;
1057 (void)layoutlist;
1058 }
1059
1069 virtual void onAudioMetadataReceived(const RtcConnection& connection, uid_t uid, const char* metadata, size_t length) {
1070 (void)metadata;
1071 (void)length;
1072 }
1073
1086 virtual void onMultipathStats(const RtcConnection& connection, const MultipathStats& stats) {
1087 (void)stats;
1088 (void)connection;
1089 }
1090
1101 virtual void onRenewTokenResult(const RtcConnection& connection, const char* token, RENEW_TOKEN_ERROR_CODE code) {
1102 (void)token;
1103 (void)code;
1104 }
1105};
1106
1107class IRtcEngineEx : public IRtcEngine {
1108public:
1171 virtual int joinChannelEx(const char* token, const RtcConnection& connection,
1172 const ChannelMediaOptions& options,
1173 IRtcEngineEventHandler* eventHandler) = 0;
1174
1208 virtual int leaveChannelEx(const RtcConnection& connection) = 0;
1209
1248 virtual int leaveChannelEx(const RtcConnection& connection, const LeaveChannelOptions& options) = 0;
1249
1275 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount) = 0;
1276
1297 virtual int leaveChannelWithUserAccountEx(const char* channelId, const char* userAccount, const LeaveChannelOptions& options) = 0;
1298
1319 virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions& options, const RtcConnection& connection) = 0;
1339 virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration& config, const RtcConnection& connection) = 0;
1368 virtual int setupRemoteVideoEx(const VideoCanvas& canvas, const RtcConnection& connection) = 0;
1387 virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1406 virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection& connection) = 0;
1446 virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection& connection) = 0;
1466 virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection& connection) = 0;
1467
1486 virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection& connection) = 0;
1487
1510 virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection& connection) = 0;
1511
1528 virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection& connection) = 0;
1529
1530
1559 virtual int setSubscribeAudioBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1560
1588 virtual int setSubscribeAudioAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1589
1618 virtual int setSubscribeVideoBlocklistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1619
1647 virtual int setSubscribeVideoAllowlistEx(uid_t* uidList, int uidNumber, const RtcConnection& connection) = 0;
1663 virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions& options, const RtcConnection& connection) = 0;
1691 virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection& connection) = 0;
1702 virtual int setRemoteUserSpatialAudioParamsEx(uid_t uid, const agora::SpatialAudioParams& params, const RtcConnection& connection) = 0;
1725 VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection& connection) = 0;
1726
1745 virtual int setRemoteRenderRotationEx(uid_t uid, VIDEO_ORIENTATION rotation, const RtcConnection& connection) = 0;
1746
1774 virtual int enableLoopbackRecordingEx(const RtcConnection& connection, bool enabled, const char* deviceName = NULL) = 0;
1775
1790 virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection& connection) = 0;
1791
1805 virtual int muteRecordingSignalEx(bool mute, const RtcConnection& connection) = 0;
1806
1827 virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection& connection) = 0;
1828
1865 virtual int enableEncryptionEx(const RtcConnection& connection, bool enabled, const EncryptionConfig& config) = 0;
1900 virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
1925 virtual int createDataStreamEx(int* streamId, const DataStreamConfig& config, const RtcConnection& connection) = 0;
1962 virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
1963
1978 virtual int sendRdtMessageEx(uid_t uid, RdtStreamType type, const char *data, size_t length, const RtcConnection& connection) = 0;
1979
1993 virtual int sendMediaControlMessageEx(uid_t uid, const char *data, size_t length, const RtcConnection& connection) = 0;
1994
2038 virtual int addVideoWatermarkEx(const char* watermarkUrl, const WatermarkOptions& options, const RtcConnection& connection) = 0;
2039
2055 virtual int addVideoWatermarkEx(const WatermarkConfig& config, const RtcConnection& connection) = 0;
2056
2072 virtual int removeVideoWatermarkEx(const char* id, const RtcConnection& connection) = 0;
2073
2083 virtual int clearVideoWatermarkEx(const RtcConnection& connection) = 0;
2095 virtual int sendCustomReportMessageEx(const char* id, const char* category, const char* event, const char* label,
2096 int value, const RtcConnection& connection) = 0;
2097
2131 virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection& connection) = 0;
2132
2164 virtual int startRtmpStreamWithoutTranscodingEx(const char* url, const RtcConnection& connection) = 0;
2165
2199 virtual int startRtmpStreamWithTranscodingEx(const char* url, const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
2200
2218 virtual int updateRtmpTranscodingEx(const LiveTranscoding& transcoding, const RtcConnection& connection) = 0;
2219
2240 virtual int stopRtmpStreamEx(const char* url, const RtcConnection& connection) = 0;
2241
2278 virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration& configuration, const RtcConnection& connection) = 0;
2279
2302 virtual int stopChannelMediaRelayEx(const RtcConnection& connection) = 0;
2303
2321 virtual int pauseAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
2322
2339 virtual int resumeAllChannelMediaRelayEx(const RtcConnection& connection) = 0;
2340
2355 virtual int getUserInfoByUserAccountEx(const char* userAccount, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
2356
2371 virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo* userInfo, const RtcConnection& connection) = 0;
2372
2402 virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig& streamConfig,
2403 const RtcConnection& connection) = 0;
2439 const SimulcastStreamConfig& streamConfig,
2440 const RtcConnection& connection) = 0;
2441
2463 virtual int setSimulcastConfigEx(const SimulcastConfig& simulcastConfig,
2464 const RtcConnection& connection) = 0;
2465
2482 virtual int setHighPriorityUserListEx(uid_t* uidList, int uidNum,
2484 const RtcConnection& connection) = 0;
2485
2518 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const char* filePath) = 0;
2519
2547 virtual int takeSnapshotEx(const RtcConnection& connection, uid_t uid, const media::SnapshotConfig& config) = 0;
2548
2573 virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection& connection) = 0;
2574
2605 virtual int startMediaRenderingTracingEx(const RtcConnection& connection) = 0;
2606
2615 virtual int setParametersEx(const RtcConnection& connection, const char* parameters) = 0;
2616
2630 virtual int getCallIdEx(agora::util::AString& callId, const RtcConnection& connection) = 0;
2631
2643 virtual int sendAudioMetadataEx(const RtcConnection& connection, const char* metadata, size_t length) = 0;
2644
2675 virtual int preloadEffectEx(const RtcConnection& connection, int soundId, const char* filePath, int startPos = 0) = 0;
2676
2724 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;
2725};
2726
2727} // namespace rtc
2728} // namespace agora
The IRtcEngineEventHandlerEx class.
Definition IAgoraRtcEngineEx.h:38
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition IAgoraRtcEngineEx.h:397
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition IAgoraRtcEngineEx.h:115
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition IAgoraRtcEngineEx.h:293
virtual void onConnectionLost(const RtcConnection &connection)
Definition IAgoraRtcEngineEx.h:558
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition IAgoraRtcEngineEx.h:867
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition IAgoraRtcEngineEx.h:950
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Definition IAgoraRtcEngineEx.h:852
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed) __deprecated
Definition IAgoraRtcEngineEx.h:750
virtual void onVideoRenderingTracingResult(const RtcConnection &connection, uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Definition IAgoraRtcEngineEx.h:1026
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition IAgoraRtcEngineEx.h:933
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition IAgoraRtcEngineEx.h:201
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition IAgoraRtcEngineEx.h:348
virtual void onSnapshotTaken(const RtcConnection &connection, uid_t uid, const char *filePath, int width, int height, int errCode)
Definition IAgoraRtcEngineEx.h:1010
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition IAgoraRtcEngineEx.h:721
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition IAgoraRtcEngineEx.h:214
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition IAgoraRtcEngineEx.h:621
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition IAgoraRtcEngineEx.h:599
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition IAgoraRtcEngineEx.h:332
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed) __deprecated
Definition IAgoraRtcEngineEx.h:773
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition IAgoraRtcEngineEx.h:484
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition IAgoraRtcEngineEx.h:454
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition IAgoraRtcEngineEx.h:256
virtual void onRenewTokenResult(const RtcConnection &connection, const char *token, RENEW_TOKEN_ERROR_CODE code)
Definition IAgoraRtcEngineEx.h:1101
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Definition IAgoraRtcEngineEx.h:794
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition IAgoraRtcEngineEx.h:242
virtual void onRequestToken(const RtcConnection &connection)
Definition IAgoraRtcEngineEx.h:696
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated
Definition IAgoraRtcEngineEx.h:471
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) __deprecated
Definition IAgoraRtcEngineEx.h:150
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition IAgoraRtcEngineEx.h:888
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition IAgoraRtcEngineEx.h:376
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition IAgoraRtcEngineEx.h:129
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition IAgoraRtcEngineEx.h:817
virtual void onMultipathStats(const RtcConnection &connection, const MultipathStats &stats)
Callback for multipath transmission statistics.
Definition IAgoraRtcEngineEx.h:1086
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition IAgoraRtcEngineEx.h:510
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated
Definition IAgoraRtcEngineEx.h:414
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *remoteUserAccount)
Definition IAgoraRtcEngineEx.h:987
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted)
Definition IAgoraRtcEngineEx.h:435
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition IAgoraRtcEngineEx.h:839
virtual void onAudioMetadataReceived(const RtcConnection &connection, uid_t uid, const char *metadata, size_t length)
Definition IAgoraRtcEngineEx.h:1069
virtual void onTranscodedStreamLayoutInfo(const RtcConnection &connection, uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Definition IAgoraRtcEngineEx.h:1052
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition IAgoraRtcEngineEx.h:184
virtual void onConnectionInterrupted(const RtcConnection &connection) __deprecated
Definition IAgoraRtcEngineEx.h:575
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition IAgoraRtcEngineEx.h:271
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition IAgoraRtcEngineEx.h:962
virtual void onLocalVideoStats(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, const LocalVideoStats &stats)
Definition IAgoraRtcEngineEx.h:529
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Definition IAgoraRtcEngineEx.h:915
virtual void onConnectionBanned(const RtcConnection &connection)
Definition IAgoraRtcEngineEx.h:583
virtual void onVideoSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition IAgoraRtcEngineEx.h:311
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition IAgoraRtcEngineEx.h:498
virtual void onRdtStateChanged(const RtcConnection &connection, uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition IAgoraRtcEngineEx.h:661
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition IAgoraRtcEngineEx.h:973
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition IAgoraRtcEngineEx.h:543
virtual void onMediaControlMessage(const RtcConnection &connection, uid_t userId, const char *data, size_t length)
Occurs when the local user receives media control message sent by a remote user.
Definition IAgoraRtcEngineEx.h:679
virtual void onRdtMessage(const RtcConnection &connection, uid_t userId, RdtStreamType type, const char *data, size_t length)
Occurs when the local user receives data via Reliable Data Transmission (RDT) from a remote user.
Definition IAgoraRtcEngineEx.h:644
virtual const char * eventHandlerType() const
Definition IAgoraRtcEngineEx.h:105
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition IAgoraRtcEngineEx.h:737
virtual void onLicenseValidationFailure(const RtcConnection &connection, LICENSE_ERROR_TYPE reason)
Definition IAgoraRtcEngineEx.h:705
virtual void onSetRtmFlagResult(const RtcConnection &connection, int code)
Definition IAgoraRtcEngineEx.h:1038
Definition IAgoraRtcEngine.h:1803
virtual void onUserMuteAudio(uid_t uid, bool muted)
Occurs when a remote user (in the communication profile) or a host (in the live streaming profile) st...
Definition IAgoraRtcEngine.h:2456
virtual void onFirstLocalAudioFramePublished(int elapsed)
Occurs when the first audio frame is published.
Definition IAgoraRtcEngine.h:2955
virtual void onStreamMessage(uid_t uid, int streamId, const char *data, size_t length, uint64_t sentTs)
Occurs when the local user receives the data stream from the remote user.
Definition IAgoraRtcEngine.h:2803
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Reports the statistics of the local audio stream.
Definition IAgoraRtcEngine.h:2562
virtual const char * eventHandlerType() const
Definition IAgoraRtcEngine.h:1807
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) __deprecated
Occurs when the SDK receives the first audio frame from a specific remote user.
Definition IAgoraRtcEngine.h:2996
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Occurs when a specific remote user enables/disables the local video capturing function.
Definition IAgoraRtcEngine.h:2533
virtual void onFirstRemoteVideoFrame(uid_t uid, int width, int height, int elapsed)
Occurs when the renderer receives the first frame of the remote video.
Definition IAgoraRtcEngine.h:2379
virtual void onUserStateChanged(uid_t uid, REMOTE_USER_STATE state)
Definition IAgoraRtcEngine.h:2508
virtual void onIntraRequestReceived()
Definition IAgoraRtcEngine.h:2134
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Reports the transport-layer statistics of each remote audio stream.
Definition IAgoraRtcEngine.h:3294
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reason)
Occurs when the local audio stream state changes.
Definition IAgoraRtcEngine.h:3017
virtual void onMultipathStats(const MultipathStats &stats)
Callback for multipath transmission statistics.
Definition IAgoraRtcEngine.h:3687
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Reports the statistics of the local video stream.
Definition IAgoraRtcEngine.h:2577
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
Occurs when the local user does not receive the data stream from the remote user.
Definition IAgoraRtcEngine.h:2828
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Occurs when the video size or rotation of a specified user changes.
Definition IAgoraRtcEngine.h:2261
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition IAgoraRtcEngine.h:2934
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)
Occurs when the local video stream state changes.
Definition IAgoraRtcEngine.h:2336
virtual void onAudioMetadataReceived(uid_t uid, const char *metadata, size_t length)
Definition IAgoraRtcEngine.h:3597
virtual void onTranscodedStreamLayoutInfo(uid_t uid, int width, int height, int layoutCount, const VideoLayout *layoutlist)
Occurs when the local user receives a mixed video stream carrying layout information.
Definition IAgoraRtcEngine.h:3581
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) __deprecated
Occurs when the SDK decodes the first remote audio frame for playback.
Definition IAgoraRtcEngine.h:2980
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition IAgoraRtcEngine.h:3486
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)
Occurs when the user role or the audience latency level changes.
Definition IAgoraRtcEngine.h:3130
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
Reports the result of taking a video snapshot.
Definition IAgoraRtcEngine.h:3099
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Reports the statistics of the video stream sent by each remote users.
Definition IAgoraRtcEngine.h:2593
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Occurs when the first video frame is published.
Definition IAgoraRtcEngine.h:2216
virtual void onRdtStateChanged(uid_t userId, RdtState state)
Occurs when the RDT tunnel state changed.
Definition IAgoraRtcEngine.h:2864
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Occurs when switching a user role fails.
Definition IAgoraRtcEngine.h:3150
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Reports the last mile network quality of each user in the channel.
Definition IAgoraRtcEngine.h:2122
virtual void onUserMuteVideo(uid_t uid, bool muted)
Occurs when a remote user stops or resumes publishing the video stream.
Definition IAgoraRtcEngine.h:2478
virtual void onMediaControlMessage(uid_t userId, const char *data, size_t length)
Occurs when the local user receives media control message sent by a remote user.
Definition IAgoraRtcEngine.h:2880
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user rejoins the channel.
Definition IAgoraRtcEngine.h:1849
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Occurs when a remote user enables or disables the video module.
Definition IAgoraRtcEngine.h:2498
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves...
Definition IAgoraRtcEngine.h:2434
virtual void onConnectionBanned() __deprecated
Occurs when the connection is banned by the Agora server.
Definition IAgoraRtcEngine.h:2784
virtual void onUserJoined(uid_t uid, int elapsed)
Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins ...
Definition IAgoraRtcEngine.h:2410
virtual void onLeaveChannel(const RtcStats &stats)
Occurs when a user leaves a channel.
Definition IAgoraRtcEngine.h:1995
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Occurs when the remote audio state changes.
Definition IAgoraRtcEngine.h:3041
virtual void onRequestToken()
Occurs when the token expires.
Definition IAgoraRtcEngine.h:2903
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Reports the volume information of users.
Definition IAgoraRtcEngine.h:1974
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) __deprecated
Reports the transport-layer statistics of each remote video stream.
Definition IAgoraRtcEngine.h:3318
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Occurs when a user joins a channel.
Definition IAgoraRtcEngine.h:1829
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERROR_CODE code)
Callback for renewToken call result.
Definition IAgoraRtcEngine.h:3704
virtual void onConnectionLost()
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the se...
Definition IAgoraRtcEngine.h:2757
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) __deprecated
Reports the statistics of the audio stream sent by each remote user.
Definition IAgoraRtcEngine.h:1917
virtual void onRdtMessage(uid_t userId, RdtStreamType type, const char *data, size_t length)
Occurs when the local user receives data via Reliable Data Transmission (RDT) from a remote user.
Definition IAgoraRtcEngine.h:2849
virtual void onTokenPrivilegeWillExpire(const char *token)
Occurs when the token expires in 30 seconds.
Definition IAgoraRtcEngine.h:2925
virtual void onConnectionInterrupted() __deprecated
Occurs when the connection between the SDK and the server is interrupted.
Definition IAgoraRtcEngine.h:2777
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition IAgoraRtcEngine.h:3436
virtual void onUserInfoUpdated(uid_t uid, const UserInfo &info)
Occurs when the SDK gets the user ID and user account of the remote user.
Definition IAgoraRtcEngine.h:3425
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Reports the built-in encryption errors.
Definition IAgoraRtcEngine.h:3368
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Occurs when the first remote video frame is received and decoded.
Definition IAgoraRtcEngine.h:2242
virtual void onRtcStats(const RtcStats &stats)
Reports the statistics about the current call.
Definition IAgoraRtcEngine.h:2007
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the audio subscribing state changes.
Definition IAgoraRtcEngine.h:3502
virtual void onActiveSpeaker(uid_t uid)
Occurs when the most active remote speaker is detected.
Definition IAgoraRtcEngine.h:3065
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Occurs when the remote video stream state changes.
Definition IAgoraRtcEngine.h:2356
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the video publishing state changes.
Definition IAgoraRtcEngine.h:3554
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Occurs when the video subscribing state changes.
Definition IAgoraRtcEngine.h:3520
virtual void onSetRtmFlagResult(int code)
Definition IAgoraRtcEngine.h:3672
virtual void onVideoRenderingTracingResult(uid_t uid, MEDIA_TRACE_EVENT currentEvent, VideoRenderingTracingInfo tracingInfo)
Video frame rendering event callback.
Definition IAgoraRtcEngine.h:3457
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Occurs when the network connection state changes.
Definition IAgoraRtcEngine.h:3336
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Occurs when the audio publishing state changes.
Definition IAgoraRtcEngine.h:3537
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Occurs when the local network type changes.
Definition IAgoraRtcEngine.h:3354
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Reports the transport-layer statistics of each remote audio stream.
Definition IAgoraRtcEngine.h:2549
Definition IAgoraRtcEngineEx.h:1107
virtual int setSubscribeVideoBlocklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the blocklist of subscriptions for video streams.
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection &connection)=0
Stops or resumes subscribing to the audio streams of all remote users.
virtual int preloadEffectEx(const RtcConnection &connection, int soundId, const char *filePath, int startPos=0)=0
Preloads a specified sound effect to a channel.
virtual int setRemoteVideoSubscriptionOptionsEx(uid_t uid, const VideoSubscriptionOptions &options, const RtcConnection &connection)=0
Sets options for subscribing to remote video streams.
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
Gets the user information by passing in the user ID. It is same as agora::rtc::IRtcEngine::getUserInf...
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
Sets the video stream type to subscribe to.
virtual int setParametersEx(const RtcConnection &connection, const char *parameters)=0
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
Adds a watermark image to the local video.
virtual int leaveChannelEx(const RtcConnection &connection)=0
Leaves a channel.
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
Creates a data stream.
virtual int enableContentInspectEx(bool enabled, const media::ContentInspectConfig &config, const RtcConnection &connection)=0
Enables or disables video screenshot and upload.
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const media::SnapshotConfig &config)=0
Gets a video screenshot of the specified observation point using the connection ID.
virtual int setSubscribeAudioAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the allowlist of subscriptions for audio streams.
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
Enables or disables dual-stream mode on the sender side.
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection &connection)=0
Stops or resumes subscribing to the video streams of all remote users.
virtual int createDataStreamEx(int *streamId, const DataStreamConfig &config, const RtcConnection &connection)=0
Creates a data stream.
virtual int getCallIdEx(agora::util::AString &callId, const RtcConnection &connection)=0
Gets the call ID with the connection ID.
virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
Sets the video display mode of a specified remote user.
virtual int updateRtmpTranscodingEx(const LiveTranscoding &transcoding, const RtcConnection &connection)=0
Updates the transcoding configuration.
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
Sets the dual-stream mode on the sender side.
virtual int setSubscribeVideoAllowlistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the allowlist of subscriptions for video streams.
virtual int setRemoteUserSpatialAudioParamsEx(uid_t uid, const agora::SpatialAudioParams &params, const RtcConnection &connection)=0
virtual int stopRtmpStreamEx(const char *url, const RtcConnection &connection)=0
Stops pushing media streams to a CDN.
virtual int sendRdtMessageEx(uid_t uid, RdtStreamType type, const char *data, size_t length, const RtcConnection &connection)=0
Send Reliable message to remote uid in channel.
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
Updates the channel media options after joining the channel.
virtual int setRemoteVoicePositionEx(uid_t uid, double pan, double gain, const RtcConnection &connection)=0
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
virtual int leaveChannelEx(const RtcConnection &connection, const LeaveChannelOptions &options)=0
Sets channel options and leaves the channel.
virtual int addVideoWatermarkEx(const WatermarkConfig &config, const RtcConnection &connection)=0
Adds a watermark image to the local video.
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
Initializes the video view of a remote user.
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
Gets the user information by passing in the user account. It is same as agora::rtc::IRtcEngine::getUs...
virtual int adjustRecordingSignalVolumeEx(int volume, const RtcConnection &connection)=0
virtual int startRtmpStreamWithoutTranscodingEx(const char *url, const RtcConnection &connection)=0
Starts pushing media streams to a CDN without transcoding.
virtual int setSimulcastConfigEx(const SimulcastConfig &simulcastConfig, const RtcConnection &connection)=0
Sets the simulcast video stream configuration.
virtual int startRtmpStreamWithTranscodingEx(const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
Starts Media Push and sets the transcoding configuration.
virtual int enableEncryptionEx(const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
Enables or disables the built-in encryption.
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0
Removes the watermark image from the video stream.
virtual int pauseAllChannelMediaRelayEx(const RtcConnection &connection)=0
Pauses the media stream relay to all target channels.
virtual int startOrUpdateChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
Starts relaying media streams across channels or updates channels for media relay.
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const char *filePath)=0
Takes a snapshot of a video stream using connection ID.
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount)=0
virtual int sendAudioMetadataEx(const RtcConnection &connection, const char *metadata, size_t length)=0
virtual int muteRecordingSignalEx(bool mute, const RtcConnection &connection)=0
virtual int stopChannelMediaRelayEx(const RtcConnection &connection)=0
Stops the media stream relay. Once the relay stops, the host quits all the target channels.
virtual int muteRemoteVideoStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
Stops or resumes receiving the video stream of a specified user.
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
Gets the current connection state of the SDK.
virtual int startMediaRenderingTracingEx(const RtcConnection &connection)=0
Enables tracing the video frame rendering process.
virtual int sendMediaControlMessageEx(uid_t uid, const char *data, size_t length, const RtcConnection &connection)=0
Send media control message.
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
Sends data stream messages.
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection &connection)=0
Stops or resumes publishing the local video stream.
virtual int enableLoopbackRecordingEx(const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
Enables loopback audio capturing.
virtual int adjustUserPlaybackSignalVolumeEx(uid_t uid, int volume, const RtcConnection &connection)=0
Adjusts the playback signal volume of a specified remote user.
virtual int setRemoteRenderRotationEx(uid_t uid, VIDEO_ORIENTATION rotation, const RtcConnection &connection)=0
virtual int sendCustomReportMessageEx(const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
Agora supports reporting and analyzing customized messages.
virtual int removeVideoWatermarkEx(const char *id, const RtcConnection &connection)=0
Removes the specified watermark image from the local or remote video stream.
virtual int setSubscribeAudioBlocklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
Sets the blocklist of subscriptions for audio streams.
virtual int enableAudioVolumeIndicationEx(int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
Enables the reporting of users' volume indication.
virtual int setHighPriorityUserListEx(uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option, const RtcConnection &connection)=0
virtual int muteRemoteAudioStreamEx(uid_t uid, bool mute, const RtcConnection &connection)=0
Stops or resumes receiving the audio stream of a specified user.
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
Joins a channel.
virtual int leaveChannelWithUserAccountEx(const char *channelId, const char *userAccount, const LeaveChannelOptions &options)=0
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
Sets the video encoder configuration.
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
Plays a specified sound effect in a channel.
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection &connection)=0
Stops or resumes publishing the local audio stream.
virtual int resumeAllChannelMediaRelayEx(const RtcConnection &connection)=0
Resumes the media stream relay to all target channels.
Definition IAgoraRtcEngine.h:4628
RENDER_MODE_TYPE
Video display modes.
Definition AgoraMediaBase.h:588
Definition AgoraExtensions.h:5
MEDIA_TRACE_EVENT
The rendering state of the media frame.
Definition AgoraBase.h:7827
SIMULCAST_STREAM_MODE
The mode in which the video stream is sent.
Definition AgoraBase.h:2296
LOCAL_AUDIO_STREAM_STATE
The state of the local audio.
Definition AgoraBase.h:3491
CONNECTION_CHANGED_REASON_TYPE
Reasons causing the change of the connection state.
Definition AgoraBase.h:5139
ENCRYPTION_ERROR_TYPE
Encryption error type.
Definition AgoraBase.h:7473
CLIENT_ROLE_TYPE
The user role in the interactive live streaming.
Definition AgoraBase.h:3037
CONNECTION_STATE_TYPE
Connection states.
Definition AgoraBase.h:4528
REMOTE_AUDIO_STATE_REASON
The reason for the remote audio state change.
Definition AgoraBase.h:3826
USER_OFFLINE_REASON_TYPE
Reasons for a user being offline.
Definition AgoraBase.h:969
VIDEO_STREAM_TYPE
The type of video streams.
Definition AgoraBase.h:1746
LOCAL_AUDIO_STREAM_REASON
Reasons for local audio state changes.
Definition AgoraBase.h:3513
REMOTE_VIDEO_STATE
The state of the remote video stream.
Definition AgoraBase.h:3872
RENEW_TOKEN_ERROR_CODE
Represents the error codes after calling renewToken.
Definition AgoraBase.h:7509
VIDEO_MIRROR_MODE_TYPE
Video mirror mode.
Definition AgoraBase.h:1998
RdtState
Reliable Data Transmission tunnel state.
Definition AgoraBase.h:8114
RdtStreamType
Reliable Data Transmission Tunnel message stream type.
Definition AgoraBase.h:8090
CLIENT_ROLE_CHANGE_FAILED_REASON
The reason for a user role switch failure.
Definition AgoraBase.h:5277
@ __deprecated
Definition AgoraBase.h:1030
REMOTE_AUDIO_STATE
Remote audio states.
Definition AgoraBase.h:3792
NETWORK_TYPE
Network type.
Definition AgoraBase.h:5307
unsigned int uid_t
Definition AgoraMediaBase.h:28
VIDEO_SOURCE_TYPE
The type of the video source.
Definition AgoraMediaBase.h:67
STREAM_FALLBACK_OPTIONS
Options for handling audio and video stream fallback when network conditions are weak.
Definition IAgoraRtcEngine.h:268
UPLOAD_ERROR_REASON
Definition AgoraBase.h:7498
REMOTE_VIDEO_STATE_REASON
The reason for the remote video state change.
Definition AgoraBase.h:3904
VIDEO_ORIENTATION
The clockwise rotation of the video.
Definition AgoraBase.h:1086
CopyableAutoPtr< IString > AString
Definition AgoraBase.h:182
Definition AgoraAtomicOps.h:21
LICENSE_ERROR_TYPE
Definition AgoraBase.h:879
The spatial audio parameters.
Definition AgoraBase.h:8179
Layout information of a specific sub-video stream within the mixed stream.
Definition AgoraBase.h:8260
Screenshot and upload configuration.
Definition AgoraMediaBase.h:1338
The snapshot configuration.
Definition AgoraMediaBase.h:1378
The volume information of users.
Definition AgoraBase.h:4069
The channel media options.
Definition IAgoraRtcEngine.h:1254
Configuration of cross channel media relay.
Definition AgoraBase.h:7183
Setting of user role properties.
Definition AgoraBase.h:3085
The configurations for the data stream.
Definition AgoraBase.h:2271
Built-in encryption configurations.
Definition AgoraBase.h:7409
The options for leaving a channel.
Definition IAgoraRtcEngine.h:1770
Transcoding configurations for Media Push.
Definition AgoraBase.h:4651
Local audio statistics.
Definition AgoraBase.h:4261
The statistics of the local video stream.
Definition IAgoraRtcEngine.h:311
Aggregates statistics of each network path in multipath transmission.
Definition AgoraBase.h:2781
Audio statistics of the remote user.
Definition IAgoraRtcEngine.h:435
Statistics of the remote video stream.
Definition IAgoraRtcEngine.h:576
Contains connection information.
Definition IAgoraRtcEngineEx.h:20
RtcConnection()
Definition IAgoraRtcEngineEx.h:30
RtcConnection(const char *channel_id, uid_t local_uid)
Definition IAgoraRtcEngineEx.h:31
uid_t localUid
Definition IAgoraRtcEngineEx.h:28
const char * channelId
Definition IAgoraRtcEngineEx.h:24
Statistics of a call session.
Definition AgoraBase.h:2828
Configure video streams of different quality levels.
Definition AgoraBase.h:2344
The configuration of the low-quality video stream.
Definition AgoraBase.h:2316
The information of the user.
Definition AgoraBase.h:7693
Attributes of the video canvas object.
Definition AgoraBase.h:5366
Video encoder configurations.
Definition AgoraBase.h:2143
Indicators during video frame rendering progress.
Definition AgoraBase.h:7841
Video subscription options.
Definition AgoraBase.h:1791
Used to configure watermark-related information.
Definition AgoraBase.h:2673
Watermark image configurations.
Definition AgoraBase.h:2495