Agora Java API Reference for Android
|
11 #include "IAgoraRtcEngine.h"
13 #ifndef OPTIONAL_ENUM_CLASS
14 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
15 #define OPTIONAL_ENUM_CLASS enum class
17 #define OPTIONAL_ENUM_CLASS enum
21 #ifndef OPTIONAL_NULLPTR
22 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
23 #define OPTIONAL_NULLPTR nullptr
25 #define OPTIONAL_NULLPTR NULL
47 using IRtcEngineEventHandler::onRemoteAudioMixingBegin;
48 using IRtcEngineEventHandler::onRemoteAudioMixingEnd;
49 using IRtcEngineEventHandler::onAudioEffectFinished;
57 using IRtcEngineEventHandler::onVideoSourceFrameSizeChanged;
59 using IRtcEngineEventHandler::onVideoSizeChanged;
73 using IRtcEngineEventHandler::onCameraReady;
74 using IRtcEngineEventHandler::onCameraFocusAreaChanged;
75 using IRtcEngineEventHandler::onCameraExposureAreaChanged;
76 using IRtcEngineEventHandler::onVideoStopped;
81 using IRtcEngineEventHandler::onRefreshRecordingServiceStatus;
84 using IRtcEngineEventHandler::onMediaEngineLoadSuccess;
85 using IRtcEngineEventHandler::onMediaEngineStartCallSuccess;
102 using IRtcEngineEventHandler::onLocalPublishFallbackToAudioOnly;
103 using IRtcEngineEventHandler::onRemoteSubscribeFallbackToAudioOnly;
150 virtual void onWarning(conn_id_t connId,
int warn,
const char* msg) {
161 virtual void onError(conn_id_t connId,
int err,
const char* msg) {
178 virtual void onAudioQuality(conn_id_t connId, uid_t uid,
int quality,
unsigned short delay,
unsigned short lost) {
197 virtual void onAudioVolumeIndication(conn_id_t connId,
const AudioVolumeInfo* speakers,
unsigned int speakerNumber,
260 virtual void onRemoteAudioMixingBegin(conn_id_t connId) {
264 virtual void onRemoteAudioMixingEnd(conn_id_t connId) {
268 virtual void onAudioEffectFinished(conn_id_t connId,
int soundId) {
381 virtual void onVideoSourceFrameSizeChanged(conn_id_t connId, VIDEO_SOURCE_TYPE sourceType,
int width,
int height) {
437 LOCAL_VIDEO_STREAM_STATE state,
438 LOCAL_VIDEO_STREAM_ERROR errorCode) {
454 virtual void onRemoteVideoStateChanged(conn_id_t connId, uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason,
int elapsed) {
499 virtual void onUserOffline(conn_id_t connId, uid_t uid, USER_OFFLINE_REASON_TYPE reason) {
554 virtual void onApiCallExecuted(conn_id_t connId,
int err,
const char* api,
const char* result) {
612 virtual void onCameraReady(conn_id_t connId) {
616 virtual void onCameraFocusAreaChanged(conn_id_t connId,
int x,
int y,
int width,
int height) {
624 virtual void onCameraExposureAreaChanged(conn_id_t connId,
int x,
int y,
int width,
int height) {
632 virtual void onVideoStopped(conn_id_t connId) {
690 virtual void onRefreshRecordingServiceStatus(conn_id_t connId,
int status) {
707 virtual void onStreamMessage(conn_id_t connId, uid_t uid,
int streamId,
const char* data,
size_t length) {
715 virtual void onStreamMessage(uid_t uid,
int streamId,
const char* data,
size_t length, uint64_t sentTs) {
738 virtual void onStreamMessageError(conn_id_t connId, uid_t uid,
int streamId,
int code,
int missed,
int cached) {
747 virtual void onMediaEngineLoadSuccess(conn_id_t connId) {
751 virtual void onMediaEngineStartCallSuccess(conn_id_t connId) {
833 virtual void onRemoteAudioStateChanged(conn_id_t connId, uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason,
int elapsed) {
890 RTMP_STREAM_PUBLISH_STATE state,
891 RTMP_STREAM_PUBLISH_ERROR errCode){
898 virtual void onStreamPublished(conn_id_t connId,
const char* url,
int error) {
965 virtual void onChannelMediaRelayStateChanged(conn_id_t connId,
int state,
int code) {
971 virtual void onChannelMediaRelayEvent(conn_id_t connId,
int code) {
976 virtual void onLocalPublishFallbackToAudioOnly(conn_id_t connId,
bool isFallbackOrRecover) {
978 (void)isFallbackOrRecover;
981 virtual void onRemoteSubscribeFallbackToAudioOnly(conn_id_t connId, uid_t uid,
bool isFallbackOrRecover) {
984 (void)isFallbackOrRecover;
1001 unsigned short rxKBitRate) {
1023 unsigned short rxKBitRate) {
1037 CONNECTION_STATE_TYPE state,
1038 CONNECTION_CHANGED_REASON_TYPE reason) {
1062 virtual void onUserAccountUpdated(uid_t uid,
const char* userAccount){
1072 onRemoteAudioMixingBegin()
1073 onRemoteAudioMixingEnd()
1076 onBandwidthEstimationUpdated()
1079 onVideoSourceFrameSizeChanged()
1090 onChannelMediaRelayEvent()
1096 virtual void onAudioTransportQuality(uid_t uid,
unsigned int bitrate,
unsigned short delay,
1097 unsigned short lost) {
1104 virtual void onVideoTransportQuality(uid_t uid,
unsigned int bitrate,
unsigned short delay,
1105 unsigned short lost) {
1112 virtual void onRecap(
const char* recapData,
int length) {
1117 virtual void onMediaEngineEvent(
int evt) { (void)evt; }
1119 virtual bool onCustomizedSei(
const void** content,
int* length) {
1127 virtual void onExtensionEvent(
const char*
id,
const char* key,
const char* json_value) {
1133 #ifdef INTERNAL_ENGINE_STATUS
1134 virtual void onInternalEngineStatus(InternalEngineStatus state) { (void)state; }
1135 #endif // INTERNAL_ENGINE_STATUS
1147 Extension() : id(OPTIONAL_NULLPTR), path(OPTIONAL_NULLPTR), config(OPTIONAL_NULLPTR) {}
1161 unsigned int areaCode;
1169 : eventHandlerEx(NULL)
1173 , enableVideo(
false)
1174 , areaCode(AREA_CODE_GLOB)
1175 , extensions(OPTIONAL_NULLPTR)
1176 , numExtension(0) {}
virtual void onApiCallExecuted(int err, const char *api, const char *result)
Definition: IAgoraRtcEngine.h:1335
virtual void onFirstLocalAudioFramePublished(conn_id_t connId, int elapsed)
Definition: IAgoraRtcEngineEx.h:794
virtual void onUserEnableVideo(conn_id_t connId, uid_t uid, bool enabled)
Definition: IAgoraRtcEngineEx.h:527
virtual void onLocalAudioStats(conn_id_t connId, const LocalAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:568
Definition: AgoraBase.h:3513
Definition: AgoraBase.h:2818
virtual void onError(conn_id_t connId, int err, const char *msg)
Definition: IAgoraRtcEngineEx.h:161
virtual void onRemoteVideoStats(conn_id_t connId, const RemoteVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:607
virtual void onFirstLocalVideoFramePublished(conn_id_t connId, int elapsed)
Definition: IAgoraRtcEngineEx.h:376
virtual void onTranscodingUpdated(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:930
virtual void onIntraRequestReceived()
Definition: IAgoraRtcEngine.h:1075
virtual void onLeaveChannel(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:986
virtual void onFirstLocalVideoFrame(int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1124
virtual void onMediaDeviceChanged(conn_id_t connId, int deviceType)
Definition: IAgoraRtcEngineEx.h:296
virtual void onNetworkTypeChanged(conn_id_t connId, NETWORK_TYPE type)
Definition: IAgoraRtcEngineEx.h:1048
virtual void onStreamMessage(conn_id_t connId, uid_t uid, int streamId, const char *data, size_t length)
Definition: IAgoraRtcEngineEx.h:707
virtual void onAudioQuality(conn_id_t connId, uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngineEx.h:178
virtual void onRejoinChannelSuccess(conn_id_t connId, const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngineEx.h:135
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:1841
virtual void onLocalAudioStats(const LocalAudioStats &stats)
Definition: IAgoraRtcEngine.h:1348
virtual void onLastmileQuality(int quality)
Definition: IAgoraRtcEngine.h:1112
virtual void onRtmpStreamingStateChanged(conn_id_t connId, const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode)
Definition: IAgoraRtcEngineEx.h:889
virtual void onRemoteAudioStats(conn_id_t connId, const RemoteAudioStats &stats)
Definition: IAgoraRtcEngineEx.h:583
virtual void onNetworkTypeChanged(NETWORK_TYPE type)
Definition: IAgoraRtcEngine.h:1885
virtual void onUserOffline(conn_id_t connId, uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:499
Definition: IAgoraRtcEngineEx.h:34
virtual void onAudioRoutingChanged(conn_id_t connId, int routing)
Definition: IAgoraRtcEngineEx.h:960
virtual void onFirstLocalAudioFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1553
virtual void onRejoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:867
Definition: IAgoraRtcEngine.h:836
virtual void onRemoteVideoStateChanged(conn_id_t connId, uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:454
virtual void onAudioDeviceStateChanged(conn_id_t connId, const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngineEx.h:242
virtual void onStreamUnpublished(conn_id_t connId, const char *url)
Definition: IAgoraRtcEngineEx.h:914
virtual void onIntraRequestReceived(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:323
virtual void onAudioMixingFinished()
Definition: IAgoraRtcEngine.h:1019
Definition: IAgoraRtcEngineEx.h:1138
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1588
virtual void onRemoteAudioTransportStats(conn_id_t connId, uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:1000
virtual void onRemoteVideoTransportStats(conn_id_t connId, uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngineEx.h:1022
virtual void onUserMuteVideo(uid_t userId, bool muted)
Definition: IAgoraRtcEngine.h:1285
virtual void onVideoDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1037
virtual void onUserEnableLocalVideo(conn_id_t connId, uid_t uid, bool enabled)
Definition: IAgoraRtcEngineEx.h:541
virtual void onLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1185
virtual void onRequestToken(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:766
virtual void onTranscodingUpdated()
Definition: IAgoraRtcEngine.h:1726
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode)
Definition: IAgoraRtcEngine.h:1440
virtual void onRequestToken()
Definition: IAgoraRtcEngine.h:1528
virtual void onError(int err, const char *msg)
Definition: IAgoraRtcEngine.h:891
virtual void onAudioMixingStateChanged(conn_id_t connId, AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode)
Definition: IAgoraRtcEngineEx.h:652
virtual void onFirstRemoteVideoFrame(conn_id_t connId, uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:473
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled)
Definition: IAgoraRtcEngine.h:1323
virtual void onNetworkQuality(conn_id_t connId, uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngineEx.h:310
virtual void onAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume)
Definition: IAgoraRtcEngine.h:968
virtual void onConnectionBanned()
Definition: IAgoraRtcEngine.h:1469
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1266
virtual void onConnectionStateChanged(conn_id_t connId, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngineEx.h:1036
virtual void onStreamMessageError(conn_id_t connId, uid_t uid, int streamId, int code, int missed, int cached)
Definition: IAgoraRtcEngineEx.h:738
virtual void onChannelMediaRelayEvent(int code)
Definition: IAgoraRtcEngine.h:1815
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:1506
virtual void onRtmpStreamingStateChanged(const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode)
Definition: IAgoraRtcEngine.h:1654
virtual void onStreamInjectedStatus(conn_id_t connId, const char *url, uid_t uid, int status)
Definition: IAgoraRtcEngineEx.h:940
virtual void onLocalVideoStats(conn_id_t connId, const LocalVideoStats &stats)
Definition: IAgoraRtcEngineEx.h:595
virtual void onRemoteVideoStats(const RemoteVideoStats &stats)
Definition: IAgoraRtcEngine.h:1392
virtual void onTokenPrivilegeWillExpire(const char *token)
Definition: IAgoraRtcEngine.h:1544
virtual void onAudioDeviceStateChanged(const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngine.h:1006
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost)
Definition: IAgoraRtcEngine.h:910
virtual void onAudioDeviceVolumeChanged(conn_id_t connId, MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngineEx.h:869
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 onConnectionBanned(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:686
virtual void onVideoSizeChanged(conn_id_t connId, uid_t uid, int width, int height, int rotation)
Definition: IAgoraRtcEngineEx.h:418
virtual void onJoinChannelSuccess(const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:849
virtual void onStreamInjectedStatus(const char *url, uid_t uid, int status)
Definition: IAgoraRtcEngine.h:1734
virtual void onAudioMixingFinished(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:256
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngine.h:1571
virtual void onStreamMessage(uid_t userId, int streamId, const char *data, size_t length)
Definition: IAgoraRtcEngine.h:1486
Definition: IAgoraRtcEngineEx.h:1179
virtual void onVideoDeviceStateChanged(conn_id_t connId, const char *deviceId, int deviceType, int deviceState)
Definition: IAgoraRtcEngineEx.h:282
virtual void onLocalAudioStateChanged(conn_id_t connId, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)
Definition: IAgoraRtcEngineEx.h:813
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngine.h:1893
virtual void onStreamUnpublished(const char *url)
Definition: IAgoraRtcEngine.h:1711
Definition: IAgoraRtcEngine.h:239
virtual void onRemoteAudioStateChanged(conn_id_t connId, uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngineEx.h:833
virtual void onLastmileQuality(conn_id_t connId, int quality)
Definition: IAgoraRtcEngineEx.h:353
virtual void onConnectionInterrupted(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:680
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngine.h:1623
Definition: AgoraBase.h:2281
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed)
Definition: IAgoraRtcEngine.h:1222
virtual void onLastmileProbeResult(const LastmileProbeResult &result)
Definition: IAgoraRtcEngine.h:924
virtual void onConnectionLost()
Definition: IAgoraRtcEngine.h:1452
Definition: IAgoraRtcEngineEx.h:1150
virtual void onFirstRemoteVideoDecoded(conn_id_t connId, uid_t uid, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:399
virtual void onUserMuteVideo(conn_id_t connId, uid_t uid, bool muted)
Definition: IAgoraRtcEngineEx.h:513
Definition: AgoraBase.h:2040
virtual void onWarning(int warn, const char *msg)
Definition: IAgoraRtcEngine.h:881
virtual void onLocalVideoStats(const LocalVideoStats &stats)
Definition: IAgoraRtcEngine.h:1379
Definition: AgoraBase.h:2960
virtual void onAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
Definition: IAgoraRtcEngine.h:1635
virtual void onMediaDeviceChanged(int deviceType)
Definition: IAgoraRtcEngine.h:1050
virtual int setVideoProfileEx(int width, int height, int frameRate, int bitrate)=0
virtual void onStreamPublished(const char *url, int error)
Definition: IAgoraRtcEngine.h:1696
virtual void onFirstLocalVideoFramePublished(int elapsed)
Definition: IAgoraRtcEngine.h:1135
Definition: IAgoraRtcEngine.h:2773
virtual void onActiveSpeaker(uid_t userId)
Definition: IAgoraRtcEngine.h:1613
virtual void onTokenPrivilegeWillExpire(conn_id_t connId, const char *token)
Definition: IAgoraRtcEngineEx.h:784
virtual void onWarning(conn_id_t connId, int warn, const char *msg)
Definition: IAgoraRtcEngineEx.h:150
virtual void onJoinChannelSuccess(conn_id_t connId, const char *channel, uid_t uid, int elapsed)
Definition: IAgoraRtcEngineEx.h:119
virtual void onLocalVideoStateChanged(conn_id_t connId, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)
Definition: IAgoraRtcEngineEx.h:436
virtual void onFirstLocalVideoFrame(conn_id_t connId, int width, int height, int elapsed)
Definition: IAgoraRtcEngineEx.h:364
virtual void onConnectionInterrupted()
Definition: IAgoraRtcEngine.h:1465
virtual void onAudioRoutingChanged(int routing)
Definition: IAgoraRtcEngine.h:1753
virtual void onActiveSpeaker(conn_id_t connId, uid_t uid)
Definition: IAgoraRtcEngineEx.h:844
virtual void onUserJoined(conn_id_t connId, uid_t uid, int elapsed)
Definition: IAgoraRtcEngineEx.h:488
virtual void onLastmileProbeResult(conn_id_t connId, const LastmileProbeResult &result)
Definition: IAgoraRtcEngineEx.h:192
virtual int initialize(const RtcEngineContext &context)=0
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality)
Definition: IAgoraRtcEngine.h:1063
virtual void onRtcStats(conn_id_t connId, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:228
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)
Definition: IAgoraRtcEngine.h:1201
virtual void onClientRoleChanged(conn_id_t connId, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
Definition: IAgoraRtcEngineEx.h:856
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)
Definition: IAgoraRtcEngine.h:1862
virtual void onRtcStats(const RtcStats &stats)
Definition: IAgoraRtcEngine.h:995
virtual void onLeaveChannel(conn_id_t connId, const RtcStats &stats)
Definition: IAgoraRtcEngineEx.h:216
virtual void onUserJoined(uid_t uid, int elapsed)
Definition: IAgoraRtcEngine.h:1247
virtual void onApiCallExecuted(conn_id_t connId, int err, const char *api, const char *result)
Definition: IAgoraRtcEngineEx.h:554
virtual void onConnectionLost(conn_id_t connId)
Definition: IAgoraRtcEngineEx.h:665
Definition: IAgoraRtcEngine.h:288
virtual void onChannelMediaRelayStateChanged(int state, int code)
Definition: IAgoraRtcEngine.h:1787
virtual void onEncryptionError(conn_id_t connId, ENCRYPTION_ERROR_TYPE errorType)
Definition: IAgoraRtcEngineEx.h:1057
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)
Definition: IAgoraRtcEngine.h:1875