Agora Java API Reference for Android
|
10 #include "IAgoraRtcEngine.h"
44 using IRtcEngineEventHandler::eventHandlerType;
95 using IRtcEngineEventHandler::onUserAccountUpdated;
102 virtual const char* eventHandlerType()
const {
return "event_handler_ex"; }
153 unsigned int speakerNumber,
int totalVolume) {
295 LOCAL_VIDEO_STREAM_STATE state,
296 LOCAL_VIDEO_STREAM_ERROR errorCode) {
741 unsigned short rxKBitRate) {
763 unsigned short rxKBitRate) {
777 CONNECTION_STATE_TYPE state,
778 CONNECTION_CHANGED_REASON_TYPE reason) {
839 virtual void onUserAccountUpdated(
const RtcConnection& connection, uid_t remoteUid,
const char* userAccount){
947 virtual int muteRemoteAudioStreamEx(uid_t uid,
bool mute,
const RtcConnection& connection) = 0;
964 virtual int muteRemoteVideoStreamEx(uid_t uid,
bool mute,
const RtcConnection& connection) = 0;
981 virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType,
const RtcConnection& connection) = 0;
1057 virtual int setRemoteVoicePositionEx(uid_t uid,
double pan,
double gain,
const RtcConnection& connection) = 0;
1061 virtual int setRemoteRenderModeEx(uid_t uid, media::base::RENDER_MODE_TYPE renderMode,
1062 VIDEO_MIRROR_MODE_TYPE mirrorMode,
const RtcConnection& connection) = 0;
1064 virtual int enableLoopbackRecordingEx(
const RtcConnection& connection,
bool enabled,
const char* deviceName = NULL) = 0;
1066 virtual CONNECTION_STATE_TYPE getConnectionStateEx(
const RtcConnection& connection) = 0;
1070 virtual int createDataStreamEx(
int* streamId,
bool reliable,
bool ordered,
const RtcConnection& connection) = 0;
1074 virtual int sendStreamMessageEx(
int streamId,
const char* data,
size_t length,
const RtcConnection& connection) = 0;
1078 virtual int clearVideoWatermarkEx(
const RtcConnection& connection) = 0;
1080 virtual int sendCustomReportMessageEx(
const char*
id,
const char* category,
const char* event,
const char* label,
1083 virtual int enableAudioVolumeIndicationEx(
int interval,
int smooth,
bool reportVad,
const RtcConnection& connection) = 0;
virtual void onLocalAudioStateChanged(const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngineEx.h:664
virtual int startRtmpStreamWithTranscodingEx(const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
virtual void onFirstLocalVideoFrame(const RtcConnection &connection, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:227
virtual void onIntraRequestReceived(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:213
Definition: AgoraBase.h:5243
virtual void onFirstRemoteAudioDecoded(const RtcConnection &connection, uid_t uid, int elapsed)
Definition: IAgoraRtcEngineEx.h:644
Definition: AgoraBase.h:2919
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1440
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1348
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) __deprecated
Definition: IAgoraRtcEngine.h:1521
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
virtual void onRemoteAudioTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:740
virtual void onConnectionBanned(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:518
virtual int setSubscribeAudioWhitelistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2247
virtual int leaveChannelEx(const RtcConnection &connection)=0
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:1742
virtual void onUserStateChanged(const RtcConnection &connection, uid_t remoteUid, uint32_t state)
Definition: IAgoraRtcEngineEx.h:431
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngine.h:2084
virtual void onUploadLogResult(const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngineEx.h:832
virtual void onUserEnableVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:1692
Definition: AgoraBase.h:3352
virtual int resumeAllChannelMediaRelayEx(const RtcConnection &connection)=0
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:2313
virtual void onUserEnableVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated
Definition: IAgoraRtcEngineEx.h:404
Definition: IAgoraRtcEngineEx.h:42
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1967
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1227
virtual void onLocalVideoStateChanged(const RtcConnection &connection, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)
Definition: IAgoraRtcEngineEx.h:294
virtual void onActiveSpeaker(const RtcConnection &connection, uid_t uid)
Definition: IAgoraRtcEngineEx.h:695
Definition: AgoraBase.h:1650
Definition: IAgoraRtcEngine.h:1194
virtual void onUserMuteAudio(uid_t uid, bool muted)
Definition: IAgoraRtcEngine.h:1653
Definition: AgoraBase.h:1489
virtual void onFirstRemoteVideoDecoded(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:257
virtual void onStreamMessageError(const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:560
virtual void onNetworkQuality(const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:200
Definition: AgoraBase.h:1833
virtual void onEncryptionError(const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:822
virtual void onRemoteVideoStats(const RtcConnection &connection, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:485
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:2025
virtual int setSubscribeVideoWhitelistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
virtual int updateRtmpTranscodingEx(const LiveTranscoding &transcoding, const RtcConnection &connection)=0
virtual int updateChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
virtual void onUserMuteVideo(uid_t userId, bool muted) __deprecated
Definition: IAgoraRtcEngine.h:1671
virtual void onUserEnableLocalVideo(const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated
Definition: IAgoraRtcEngineEx.h:418
virtual void onRemoteAudioStats(const RtcConnection &connection, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:459
virtual void onConnectionInterrupted(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:512
virtual int muteAllRemoteAudioStreamsEx(bool mute, const RtcConnection &connection)=0
virtual void onWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngine.h:2293
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:1933
virtual void onUserMuteAudio(const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated
Definition: IAgoraRtcEngineEx.h:376
virtual void onFirstRemoteVideoFrame(const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:334
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:1330
virtual void onConnectionBanned()
Definition: IAgoraRtcEngine.h:1878
virtual int muteAllRemoteVideoStreamsEx(bool mute, const RtcConnection &connection)=0
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1637
virtual void onWlAccStats(const RtcConnection &connection, WlAccStats currentStats, WlAccStats averageStats)
Definition: IAgoraRtcEngineEx.h:802
Definition: AgoraBase.h:1803
virtual int getUserInfoByUidEx(uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
virtual int getUserInfoByUserAccountEx(const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngine.h:1914
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:1788
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:1949
virtual void onWlAccMessage(const RtcConnection &connection, WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, const char *wlAccMsg)
Definition: IAgoraRtcEngineEx.h:790
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngine.h:1272
virtual int enableWirelessAccelerate(bool enabled)=0
virtual int stopChannelMediaRelayEx(const RtcConnection &connection)=0
virtual void onRemoteAudioStats(const RemoteAudioStats &stats)
Definition: IAgoraRtcEngine.h:1756
virtual void onRtcStats(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:184
virtual void onRemoteAudioStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:684
virtual void onRemoteVideoTransportStats(const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:762
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:1774
virtual void onStreamMessage(uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngine.h:1893
virtual void onFirstLocalAudioFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:618
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1489
virtual int muteLocalAudioStreamEx(bool mute, const RtcConnection &connection)=0
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1209
Definition: IAgoraRtcEngineEx.h:20
virtual int joinChannelEx(const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
virtual int stopRtmpStreamEx(const char *url, const RtcConnection &connection)=0
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:2008
Definition: AgoraBase.h:3860
virtual void onFirstLocalVideoFramePublished(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:241
Definition: IAgoraRtcEngineEx.h:867
virtual int startChannelMediaRelayEx(const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:2321
virtual void onRequestToken(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:580
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1555
virtual void onUserJoined(const RtcConnection &connection, uid_t remoteUid, int elapsed)
Definition: IAgoraRtcEngineEx.h:349
Definition: IAgoraRtcEngine.h:249
virtual int startRtmpStreamWithoutTranscodingEx(const char *url, const RtcConnection &connection)=0
virtual void onUserStateChanged(uid_t uid, uint32_t state)
Definition: IAgoraRtcEngine.h:1702
virtual void onAudioSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2379
Definition: AgoraBase.h:5124
virtual void onWlAccStats(WlAccStats currentStats, WlAccStats averageStats)
Definition: IAgoraRtcEngine.h:2304
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngine.h:2073
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2428
virtual void onTokenPrivilegeWillExpire(const RtcConnection &connection, const char *token)
Definition: IAgoraRtcEngineEx.h:608
Definition: AgoraBase.h:2239
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:1593
virtual void onSnapshotTaken(const RtcConnection &connection, uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: IAgoraRtcEngineEx.h:858
virtual void onLocalAudioStats(const RtcConnection &connection, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:444
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:1861
virtual void onUserMuteVideo(const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated
Definition: IAgoraRtcEngineEx.h:390
virtual void onVideoSizeChanged(VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngine.h:1536
Definition: AgoraBase.h:1932
virtual void onSnapshotTaken(uid_t uid, const char *filePath, int width, int height, int errCode)
snapshot taken callback
Definition: IAgoraRtcEngine.h:2059
Definition: AgoraBase.h:1897
virtual void onJoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:110
Definition: AgoraBase.h:3080
virtual int setVideoProfileEx(int width, int height, int frameRate, int bitrate)=0
virtual int muteLocalVideoStreamEx(bool mute, const RtcConnection &connection)=0
virtual void onRejoinChannelSuccess(const RtcConnection &connection, int elapsed)
Definition: IAgoraRtcEngineEx.h:126
virtual void onRemoteVideoStateChanged(const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:313
Definition: IAgoraRtcEngine.h:3034
virtual void onAudioQuality(const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngineEx.h:144
virtual void onActiveSpeaker(uid_t userId)
Definition: IAgoraRtcEngine.h:2044
virtual void onUserOffline(const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:362
virtual void onVideoSizeChanged(const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:274
const char * channelId
Definition: IAgoraRtcEngineEx.h:31
virtual void onFirstRemoteAudioFrame(const RtcConnection &connection, uid_t userId, int elapsed)
Definition: IAgoraRtcEngineEx.h:630
virtual void onConnectionInterrupted()
Definition: IAgoraRtcEngine.h:1874
virtual void onNetworkTypeChanged(const RtcConnection &connection, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:812
virtual void onLeaveChannel(const RtcConnection &connection, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:171
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed)
Definition: IAgoraRtcEngine.h:1501
virtual int pauseAllChannelMediaRelayEx(const RtcConnection &connection)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1428
virtual void onLocalVideoStats(const RtcConnection &connection, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:473
virtual int setSubscribeVideoBlacklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
virtual void onConnectionLost(const RtcConnection &connection)
Definition: IAgoraRtcEngineEx.h:497
virtual void onVideoSubscribeStateChanged(const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2396
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1572
virtual int setSubscribeAudioBlacklistEx(uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
virtual void onLicenseValidationFailure(const RtcConnection &connection, LICENSE_ERROR_TYPE reason)
Definition: IAgoraRtcEngineEx.h:589
uid_t localUid
Definition: IAgoraRtcEngineEx.h:35
Definition: AgoraBase.h:5450
virtual void onUploadLogResult(const char *requestId, bool success, UPLOAD_ERROR_REASON reason)
Definition: IAgoraRtcEngine.h:2364
virtual void onClientRoleChangeFailed(const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole)
Definition: IAgoraRtcEngineEx.h:721
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:2268
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:1357
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1618
virtual void onStreamMessage(const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs)
Definition: IAgoraRtcEngineEx.h:536
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1977
virtual void onLicenseValidationFailure(LICENSE_ERROR_TYPE error)
Definition: IAgoraRtcEngine.h:1958
Definition: IAgoraRtcEngine.h:334
virtual void onConnectionStateChanged(const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:776
virtual void onClientRoleChanged(const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngineEx.h:707
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) __deprecated
Definition: IAgoraRtcEngine.h:1717
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)
Definition: IAgoraRtcEngine.h:2412
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1989
virtual int takeSnapshotEx(const RtcConnection &connection, uid_t uid, const char *filePath)=0
save current time video frame to jpeg and write as a jpeg
Definition: AgoraBase.h:3930
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:2281