Agora C++ API Reference for All Platforms
|
10 #include "IAgoraRtcEngine.h"
12 #ifndef OPTIONAL_ENUM_CLASS
13 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
14 #define OPTIONAL_ENUM_CLASS enum class
16 #define OPTIONAL_ENUM_CLASS enum
20 #ifndef OPTIONAL_NULLPTR
21 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
22 #define OPTIONAL_NULLPTR nullptr
24 #define OPTIONAL_NULLPTR NULL
131 unsigned int speakerNumber,
int totalVolume) {
641 unsigned short rxKBitRate) {
663 unsigned short rxKBitRate) {
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngineEx.h:578
virtual void onFirstLocalVideoFrame(const RtcConnection &connection, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:202
virtual void onUserAccountUpdated(uid_t uid, const char *userAccount)
Definition: IAgoraRtcEngine.h:2003
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2543
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:191
Definition: AgoraBase.h:2832
virtual int sendStreamMessageEx(int streamId, const char *data, size_t length, const RtcConnection &connection)=0
RtcEngineContextEx(const RtcEngineContext &ctx)
Definition: IAgoraRtcEngineEx.h:714
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1075
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:991
virtual void onFirstLocalVideoFrame(int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1124
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:640
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:470
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:1825
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:2590
virtual int leaveChannelEx(const RtcConnection &connection)=0
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:1348
virtual int enableLoopbackRecordingEx(bool enabled, const RtcConnection &connection)=0
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngine.h:843
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:1869
virtual int addVideoWatermarkEx(const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
virtual int setRemoteVoicePositionEx(uid_t remoteUid, double pan, double gain, const RtcConnection &connection)=0
Definition: IAgoraRtcEngineEx.h:58
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1549
virtual void onVideoSourceFrameSizeChanged(VIDEO_SOURCE_TYPE sourceType, int width, int height)
Definition: IAgoraRtcEngine.h:1139
virtual void onVideoSizeChanged(uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1167
virtual void onLocalVideoStateChanged(const RtcConnection &connection, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)
Definition: IAgoraRtcEngineEx.h:275
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:609
Definition: AgoraBase.h:1797
Definition: IAgoraRtcEngine.h:839
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:237
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:511
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:2693
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:178
VIDEO_MIRROR_MODE_TYPE
Definition: AgoraBase.h:1779
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:697
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:437
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1584
virtual int muteRemoteVideoStreamEx(uid_t remoteUid, bool mute, const RtcConnection &connection)=0
virtual void onUserMuteVideo(uid_t userId, bool muted)
Definition: IAgoraRtcEngine.h:1285
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition: IAgoraRtcEngineEx.h:385
Definition: AgoraAtomicOps.h:21
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:1972
virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1185
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:413
virtual void onConnectionInterrupted(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:464
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:1524
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:2665
virtual void onUserAccountUpdated(const RtcConnection &connection, uid_t remoteUid, const char *userAccount)
Definition: IAgoraRtcEngineEx.h:702
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:1323
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:315
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:973
virtual void onConnectionBanned()
Definition: IAgoraRtcEngine.h:1469
virtual void onAudioVolumeIndication(const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngineEx.h:130
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1266
virtual int createDataStreamEx(int *streamId, DataStreamConfig &config, const RtcConnection &connection)=0
Definition: AgoraBase.h:1937
NETWORK_TYPE
Definition: AgoraBase.h:3630
virtual int sendCustomReportMessageEx(const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
virtual void onUserEnableVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:1307
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:1505
virtual void onVideoSourceFrameSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, int width, int height)
Definition: IAgoraRtcEngineEx.h:219
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:1392
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:1540
virtual int setupRemoteVideoEx(const VideoCanvas &canvas, const RtcConnection &connection)=0
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngine.h:915
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1160
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:1362
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:162
virtual int muteRemoteAudioStreamEx(uid_t remoteUid, bool mute, const RtcConnection &connection)=0
RtcConnection(const char *channel_id, uid_t local_uid)
Definition: IAgoraRtcEngineEx.h:54
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:598
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:662
virtual void onStreamMessage(uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:1484
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:559
RtcConnection()
Definition: IAgoraRtcEngineEx.h:53
Definition: IAgoraRtcEngineEx.h:36
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
CONNECTION_CHANGED_REASON_TYPE
Definition: AgoraBase.h:3547
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1567
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:214
Definition: IAgoraRtcEngineEx.h:718
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:1877
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:2625
LOCAL_VIDEO_STREAM_ERROR
Definition: AgoraBase.h:2565
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:531
virtual CONNECTION_STATE_TYPE getConnectionStateEx(const RtcConnection &connection)=0
virtual int setRemoteRenderModeEx(uid_t remoteUid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
virtual const char * eventHandlerType() const
Definition: IAgoraRtcEngineEx.h:107
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:330
VIDEO_SOURCE_TYPE
Definition: AgoraBase.h:2226
Definition: IAgoraRtcEngine.h:232
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:1924
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngine.h:1619
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:549
Definition: AgoraBase.h:2285
virtual int updateChannelMediaOptionsEx(const ChannelMediaOptions &options, const RtcConnection &connection)=0
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1222
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:398
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:1452
Definition: IAgoraRtcEngineEx.h:709
Definition: AgoraBase.h:2049
USER_OFFLINE_REASON_TYPE
Definition: AgoraBase.h:1157
virtual void onLocalVideoStats(const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:1379
Definition: AgoraBase.h:2013
Definition: AgoraBase.h:2974
virtual int setVideoEncoderConfigurationEx(const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
Definition: IAgoraRtcEngine.h:2130
virtual void onFirstLocalVideoFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1135
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:294
Definition: IAgoraRtcEngine.h:2414
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngineEx.h:122
virtual void onActiveSpeaker(uid_t userId)
Definition: IAgoraRtcEngine.h:1609
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:343
const char * channelId
Definition: IAgoraRtcEngineEx.h:47
virtual void onConnectionInterrupted()
Definition: IAgoraRtcEngine.h:1465
bool useStringUid
Definition: IAgoraRtcEngineEx.h:710
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:688
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:149
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2491
virtual void onVideoSizeChanged(const RtcConnection &connection, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:256
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted)
Definition: IAgoraRtcEngineEx.h:357
virtual int initialize(const RtcEngineContext &context)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1063
unsigned int uid_t
Definition: AgoraMediaBase.h:25
virtual void onLocalVideoStats(const RtcConnection &connection, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:425
RtcEngineContextEx()
Definition: IAgoraRtcEngineEx.h:712
virtual int createDataStreamEx(int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:449
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:1941
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1201
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2269
uid_t localUid
Definition: IAgoraRtcEngineEx.h:51
ENCRYPTION_ERROR_TYPE
Definition: AgoraBase.h:4743
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled)
Definition: IAgoraRtcEngineEx.h:371
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:1846
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1000
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1247
CONNECTION_STATE_TYPE
Definition: AgoraBase.h:3137
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngineEx.h:487
virtual int initialize(const RtcEngineContextEx &context)=0
Definition: video_node_i.h:27
Definition: IAgoraRtcEngine.h:281
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:676
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngineEx.h:621
LOCAL_AUDIO_STREAM_ERROR
Definition: AgoraBase.h:2513
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:1957
Definition: AgoraBase.h:3664
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1859
virtual int clearVideoWatermarkEx(const RtcConnection &connection)=0