Agora Java API Reference for Android
|
Public Member Functions | |
virtual const char * | eventHandlerType () const |
virtual void | onJoinChannelSuccess (const RtcConnection &connection, int elapsed) |
virtual void | onRejoinChannelSuccess (const RtcConnection &connection, int elapsed) |
virtual void | onAudioQuality (const RtcConnection &connection, uid_t remoteUid, int quality, unsigned short delay, unsigned short lost) |
virtual void | onAudioVolumeIndication (const RtcConnection &connection, const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume) |
virtual void | onLeaveChannel (const RtcConnection &connection, const RtcStats &stats) |
virtual void | onRtcStats (const RtcConnection &connection, const RtcStats &stats) |
virtual void | onNetworkQuality (const RtcConnection &connection, uid_t remoteUid, int txQuality, int rxQuality) |
virtual void | onIntraRequestReceived (const RtcConnection &connection) |
virtual void | onFirstLocalVideoFrame (const RtcConnection &connection, int width, int height, int elapsed) |
virtual void | onFirstLocalVideoFramePublished (const RtcConnection &connection, int elapsed) |
virtual void | onVideoSourceFrameSizeChanged (const RtcConnection &connection, VIDEO_SOURCE_TYPE sourceType, int width, int height) |
virtual void | onFirstRemoteVideoDecoded (const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed) |
virtual void | onVideoSizeChanged (const RtcConnection &connection, uid_t uid, int width, int height, int rotation) |
virtual void | onContentInspectResult (media::CONTENT_INSPECT_RESULT result) |
virtual void | onSnapshotTaken (const RtcConnection &connection, const char *filePath, int width, int height, int errCode) |
snapshot taken callback More... | |
virtual void | onLocalVideoStateChanged (const RtcConnection &connection, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode) |
virtual void | onRemoteVideoStateChanged (const RtcConnection &connection, uid_t remoteUid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
virtual void | onFirstRemoteVideoFrame (const RtcConnection &connection, uid_t remoteUid, int width, int height, int elapsed) |
virtual void | onUserJoined (const RtcConnection &connection, uid_t remoteUid, int elapsed) |
virtual void | onUserOffline (const RtcConnection &connection, uid_t remoteUid, USER_OFFLINE_REASON_TYPE reason) |
virtual void | onUserMuteAudio (const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated |
virtual void | onUserMuteVideo (const RtcConnection &connection, uid_t remoteUid, bool muted) __deprecated |
virtual void | onUserEnableVideo (const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated |
virtual void | onUserEnableLocalVideo (const RtcConnection &connection, uid_t remoteUid, bool enabled) __deprecated |
virtual void | onUserStateChanged (const RtcConnection &connection, uid_t remoteUid, uint32_t state) |
virtual void | onLocalAudioStats (const RtcConnection &connection, const LocalAudioStats &stats) |
virtual void | onRemoteAudioStats (const RtcConnection &connection, const RemoteAudioStats &stats) |
virtual void | onLocalVideoStats (const RtcConnection &connection, const LocalVideoStats &stats) |
virtual void | onRemoteVideoStats (const RtcConnection &connection, const RemoteVideoStats &stats) |
virtual void | onConnectionLost (const RtcConnection &connection) |
virtual void | onConnectionInterrupted (const RtcConnection &connection) |
virtual void | onConnectionBanned (const RtcConnection &connection) |
virtual void | onStreamMessage (const RtcConnection &connection, uid_t remoteUid, int streamId, const char *data, size_t length, uint64_t sentTs) |
virtual void | onStreamMessageError (const RtcConnection &connection, uid_t remoteUid, int streamId, int code, int missed, int cached) |
virtual void | onRequestToken (const RtcConnection &connection) |
virtual void | onTokenPrivilegeWillExpire (const RtcConnection &connection, const char *token) |
virtual void | onFirstLocalAudioFramePublished (const RtcConnection &connection, int elapsed) |
virtual void | onFirstRemoteAudioFrame (const RtcConnection &connection, uid_t userId, int elapsed) |
virtual void | onFirstRemoteAudioDecoded (const RtcConnection &connection, uid_t uid, int elapsed) |
virtual void | onLocalAudioStateChanged (const RtcConnection &connection, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) |
virtual void | onRemoteAudioStateChanged (const RtcConnection &connection, uid_t remoteUid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
virtual void | onActiveSpeaker (const RtcConnection &connection, uid_t uid) |
virtual void | onClientRoleChanged (const RtcConnection &connection, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
virtual void | onClientRoleChangeFailed (const RtcConnection &connection, CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) |
virtual void | onRemoteAudioTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onRemoteVideoTransportStats (const RtcConnection &connection, uid_t remoteUid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onConnectionStateChanged (const RtcConnection &connection, CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
virtual void | onNetworkTypeChanged (const RtcConnection &connection, NETWORK_TYPE type) |
virtual void | onEncryptionError (const RtcConnection &connection, ENCRYPTION_ERROR_TYPE errorType) |
virtual void | onUploadLogResult (const RtcConnection &connection, const char *requestId, bool success, UPLOAD_ERROR_REASON reason) |
virtual void | onUserAccountUpdated (const RtcConnection &connection, uid_t remoteUid, const char *userAccount) |
virtual const char * | eventHandlerType () const |
virtual void | onJoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onRejoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost) |
virtual void | onAudioVolumeIndication (const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume) |
virtual void | onLeaveChannel (const RtcStats &stats) |
virtual void | onRtcStats (const RtcStats &stats) |
virtual void | onNetworkQuality (uid_t uid, int txQuality, int rxQuality) |
virtual void | onIntraRequestReceived () |
virtual void | onFirstLocalVideoFrame (int width, int height, int elapsed) |
virtual void | onFirstLocalVideoFramePublished (int elapsed) |
virtual void | onVideoSourceFrameSizeChanged (VIDEO_SOURCE_TYPE sourceType, int width, int height) |
virtual void | onFirstRemoteVideoDecoded (uid_t uid, int width, int height, int elapsed) __deprecated |
virtual void | onVideoSizeChanged (uid_t uid, int width, int height, int rotation) |
virtual void | onLocalVideoStateChanged (LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) |
virtual void | onContentInspectResult (media::CONTENT_INSPECT_RESULT result) |
virtual void | onSnapshotTaken (const char *channel, uid_t uid, const char *filePath, int width, int height, int errCode) |
snapshot taken callback More... | |
virtual void | onRemoteVideoStateChanged (uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
virtual void | onFirstRemoteVideoFrame (uid_t userId, int width, int height, int elapsed) |
virtual void | onUserJoined (uid_t uid, int elapsed) |
virtual void | onUserOffline (uid_t uid, USER_OFFLINE_REASON_TYPE reason) |
virtual void | onUserMuteAudio (uid_t uid, bool muted) |
virtual void | onUserMuteVideo (uid_t userId, bool muted) __deprecated |
virtual void | onUserEnableVideo (uid_t uid, bool enabled) __deprecated |
virtual void | onUserEnableLocalVideo (uid_t uid, bool enabled) __deprecated |
virtual void | onUserStateChanged (uid_t uid, uint32_t state) |
virtual void | onLocalAudioStats (const LocalAudioStats &stats) |
virtual void | onRemoteAudioStats (const RemoteAudioStats &stats) |
virtual void | onLocalVideoStats (const LocalVideoStats &stats) |
virtual void | onRemoteVideoStats (const RemoteVideoStats &stats) |
virtual void | onConnectionLost () |
virtual void | onConnectionInterrupted () |
virtual void | onConnectionBanned () |
virtual void | onStreamMessage (uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs) |
virtual void | onStreamMessageError (uid_t userId, int streamId, int code, int missed, int cached) |
virtual void | onRequestToken () |
virtual void | onTokenPrivilegeWillExpire (const char *token) |
virtual void | onFirstLocalAudioFramePublished (int elapsed) |
virtual void | onFirstRemoteAudioFrame (uid_t uid, int elapsed) |
virtual void | onFirstRemoteAudioDecoded (uid_t uid, int elapsed) |
virtual void | onLocalAudioStateChanged (LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) |
virtual void | onRemoteAudioStateChanged (uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
virtual void | onActiveSpeaker (uid_t userId) |
virtual void | onClientRoleChanged (CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
virtual void | onClientRoleChangeFailed (CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) |
virtual void | onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onConnectionStateChanged (CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
virtual void | onNetworkTypeChanged (NETWORK_TYPE type) |
virtual void | onEncryptionError (ENCRYPTION_ERROR_TYPE errorType) |
virtual void | onUploadLogResult (const char *requestId, bool success, UPLOAD_ERROR_REASON reason) |
virtual void | onUserAccountUpdated (uid_t uid, const char *userAccount) |
virtual void | onAudioSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onVideoSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onAudioPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onVideoPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
![]() | |
virtual void | onJoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onRejoinChannelSuccess (const char *channel, uid_t uid, int elapsed) |
virtual void | onWarning (int warn, const char *msg) |
virtual void | onError (int err, const char *msg) |
virtual void | onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost) |
virtual void | onLastmileProbeResult (const LastmileProbeResult &result) |
virtual void | onAudioVolumeIndication (const AudioVolumeInfo *speakers, unsigned int speakerNumber, int totalVolume) |
virtual void | onLeaveChannel (const RtcStats &stats) |
virtual void | onRtcStats (const RtcStats &stats) |
virtual void | onAudioDeviceStateChanged (const char *deviceId, int deviceType, int deviceState) |
virtual void | onAudioMixingFinished () __deprecated |
virtual void | onAudioEffectFinished (int soundId) |
virtual void | onVideoDeviceStateChanged (const char *deviceId, int deviceType, int deviceState) |
virtual void | onMediaDeviceChanged (int deviceType) |
virtual void | onNetworkQuality (uid_t uid, int txQuality, int rxQuality) |
virtual void | onIntraRequestReceived () |
virtual void | onUplinkNetworkInfoUpdated (const UplinkNetworkInfo &info) |
virtual void | onDownlinkNetworkInfoUpdated (const DownlinkNetworkInfo &info) |
virtual void | onLastmileQuality (int quality) |
virtual void | onFirstLocalVideoFrame (int width, int height, int elapsed) |
virtual void | onFirstLocalVideoFramePublished (int elapsed) |
virtual void | onVideoSourceFrameSizeChanged (VIDEO_SOURCE_TYPE sourceType, int width, int height) |
virtual void | onFirstRemoteVideoDecoded (uid_t uid, int width, int height, int elapsed) __deprecated |
virtual void | onVideoSizeChanged (uid_t uid, int width, int height, int rotation) |
virtual void | onLocalVideoStateChanged (LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) |
virtual void | onRemoteVideoStateChanged (uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
virtual void | onFirstRemoteVideoFrame (uid_t userId, int width, int height, int elapsed) |
virtual void | onUserJoined (uid_t uid, int elapsed) |
virtual void | onUserOffline (uid_t uid, USER_OFFLINE_REASON_TYPE reason) |
virtual void | onUserMuteAudio (uid_t uid, bool muted) |
virtual void | onUserMuteVideo (uid_t userId, bool muted) __deprecated |
virtual void | onUserEnableVideo (uid_t uid, bool enabled) __deprecated |
virtual void | onUserStateChanged (uid_t uid, uint32_t state) |
virtual void | onUserEnableLocalVideo (uid_t uid, bool enabled) __deprecated |
virtual void | onApiCallExecuted (int err, const char *api, const char *result) |
virtual void | onLocalAudioStats (const LocalAudioStats &stats) |
virtual void | onRemoteAudioStats (const RemoteAudioStats &stats) |
virtual void | onLocalVideoStats (const LocalVideoStats &stats) |
virtual void | onRemoteVideoStats (const RemoteVideoStats &stats) |
virtual void | onCameraReady () |
virtual void | onCameraFocusAreaChanged (int x, int y, int width, int height) |
virtual void | onCameraExposureAreaChanged (int x, int y, int width, int height) |
virtual void | onVideoStopped () |
virtual void | onAudioMixingStateChanged (AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_ERROR_TYPE errorCode) |
virtual void | onRhythmPlayerStateChanged (RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_ERROR_TYPE errorCode) |
virtual void | onConnectionLost () |
virtual void | onConnectionInterrupted () |
virtual void | onConnectionBanned () |
virtual void | onStreamMessage (uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs) |
virtual void | onStreamMessageError (uid_t userId, int streamId, int code, int missed, int cached) |
virtual void | onRequestToken () |
virtual void | onTokenPrivilegeWillExpire (const char *token) |
virtual void | onFirstLocalAudioFramePublished (int elapsed) |
virtual void | onFirstRemoteAudioFrame (uid_t uid, int elapsed) |
virtual void | onFirstRemoteAudioDecoded (uid_t uid, int elapsed) |
virtual void | onLocalAudioStateChanged (LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) |
virtual void | onRemoteAudioStateChanged (uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
virtual void | onActiveSpeaker (uid_t userId) |
virtual void | onSnapshotTaken (const char *channel, uid_t uid, const char *filePath, int width, int height, int errCode) |
snapshot taken callback More... | |
virtual void | onClientRoleChanged (CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
virtual void | onClientRoleChangeFailed (CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) |
virtual void | onAudioDeviceVolumeChanged (MEDIA_DEVICE_TYPE deviceType, int volume, bool muted) |
virtual void | onRtmpStreamingStateChanged (const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) |
virtual void | onRtmpStreamingEvent (const char *url, RTMP_STREAMING_EVENT eventCode) |
virtual void | onStreamPublished (const char *url, int error) __deprecated |
virtual void | onStreamUnpublished (const char *url) __deprecated |
virtual void | onTranscodingUpdated () |
virtual void | onAudioRoutingChanged (int routing) |
virtual void | onChannelMediaRelayStateChanged (int state, int code) |
virtual void | onChannelMediaRelayEvent (int code) |
virtual void | onLocalPublishFallbackToAudioOnly (bool isFallbackOrRecover) |
virtual void | onRemoteSubscribeFallbackToAudioOnly (uid_t uid, bool isFallbackOrRecover) |
virtual void | onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) |
virtual void | onConnectionStateChanged (CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) |
virtual void | onNetworkTypeChanged (NETWORK_TYPE type) |
virtual void | onEncryptionError (ENCRYPTION_ERROR_TYPE errorType) |
virtual void | onPermissionError (PERMISSION_TYPE permissionType) |
virtual void | onLocalUserRegistered (uid_t uid, const char *userAccount) |
virtual void | onUserInfoUpdated (uid_t uid, const UserInfo &info) |
virtual void | onUploadLogResult (const char *requestId, bool success, UPLOAD_ERROR_REASON reason) |
virtual void | onAudioSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onVideoSubscribeStateChanged (const char *channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onAudioPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onVideoPublishStateChanged (const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onExtensionEvent (const char *provider, const char *ext_name, const char *key, const char *value) |
virtual void | onExtensionStarted (const char *provider, const char *ext_name) |
virtual void | onExtensionStopped (const char *provider, const char *ext_name) |
virtual void | onExtensionErrored (const char *provider, const char *ext_name, int error, const char *msg) |
virtual void | onUserAccountUpdated (uid_t uid, const char *userAccount) |
|
virtual |
Occurs when the local user successfully joins the specified channel.
connection | The connection of the local user. |
elapsed | The time elapsed (ms) from the local user calling joinChannel until this event occurs. |
|
virtual |
Occurs when the local user rejoins the channel after being disconnected due to network problems.
When the app loses connection with the server because of network problems, the SDK automatically tries to reconnect to the server, and triggers this callback method upon reconnection.
connection | The connection of the local user. |
elapsed | Time elapsed (ms) from starting to reconnect until this callback is triggered. |
|
virtual |
when audio quality message come, the function will be called
[in] | connection | the connection of the local user. |
[in] | remoteUid | the uid of the peer |
[in] | quality | the quality of the remote user, see QUALITY_TYPE for value definition |
[in] | delay | the average time of the audio packages delayed |
[in] | lost | the rate of the audio packages lost |
|
virtual |
Occurs when the local user successfully leaves the channel.
When the user successfully leaves the channel after calling leaveChannel, the SDK uses this callback to notify the app that the user has left the channel.
This callback also reports information such as the call duration and the statistics of data received or transmitted by the SDK.
connection | The connection of the local user. |
stats | The statistics on the call: RtcStats. |
|
virtual |
Reports the statistics of the current call.
This callback is triggered once every two seconds after the user joins the channel.
connection | The connection of the local user. |
stats | The statistics of the current call: RtcStats. |
|
virtual |
report the network quality
[in] | connection | the connection of the local user. |
[in] | remoteUid | the uid of the remote user |
[in] | txQuality | the score of the send network quality 0~5 the higher the better |
[in] | rxQuality | the score of the recv network quality 0~5 the higher the better |
|
virtual |
Occurs when intra request from remote user is received.
This callback is triggered once remote user needs one Key frame.
connection | The connection of the local user. |
|
virtual |
Occurs when the first local video frame is displayed on the video window.
connection | The connection of the local user. |
width | The width (pixels) of the video stream. |
height | The height (pixels) of the video stream. |
elapsed | The time elapsed (ms) from the local user calling joinChannel until this callback is triggered. |
|
virtual |
Occurs when the first local video frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
|
virtual |
when the first remote video frame decoded, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | width | the width of the video frame |
[in] | height | the height of the video frame |
[in] | elapsed | the time elapsed from channel joined in ms |
|
virtual |
when video size changed or rotation changed, the function will be called
[in] | uid | the uid of the remote user or local user (0) |
[in] | width | the new width of the video |
[in] | height | the new height of the video |
[in] | rotation | the rotation of the video |
|
virtual |
Reports result of Content Inspect
Reimplemented from agora::rtc::IRtcEngineEventHandler.
|
virtual |
snapshot taken callback
Occurs when takeSnapshot API result is obtained
connection | RtcConnection |
filePath | image is saveed file path |
width | image width |
height | image height |
errCode | 0 is ok negative is error |
|
virtual |
Occurs when the local video stream state changes
This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.
connection | The connection of the local user. |
state | State type #LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the error parameter for details. |
errorCode | The detailed error information: #LOCAL_VIDEO_STREAM_ERROR. |
|
virtual |
Occurs when the remote video state has changed. REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE is not 100% guaranteed. When the remote user leaves, use onUserOffline to make a business decision.
connection | The connection of the local user. |
remoteUid | ID of the user whose video state has changed. |
state | The remote video state: #REMOTE_VIDEO_STATE. |
reason | The reason of the remote video state change: #REMOTE_VIDEO_STATE_REASON. |
elapsed | The time elapsed (ms) from the local user calling ref IRtcEngine::joinChannel "joinChannel" until this callback is triggered. |
|
virtual |
when the first remote video frame displayed, the function will be called
[in] | connection | the connection of the local user. |
[in] | remoteUid | the uid of the remote user |
[in] | width | the width of the video frame |
[in] | height | the height of the video frame |
[in] | elapsed | the time elapsed from remote user called joinChannel in ms |
|
virtual |
when any other user joined in the same channel, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | elapsed | the time elapsed from remote used called joinChannel to joining completed in ms |
|
virtual |
when user offline(exit channel or offline by accident), the function will be called
[in] | connection | the connection of the local user. |
[in] | remoteUid | the uid of the remote user |
|
virtual |
when remote user muted the audio stream, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | muted | true: the remote user muted the audio stream, false: the remote user unmuted the audio stream |
|
virtual |
when remote user muted the video stream, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | muted | true: the remote user muted the video stream, false: the remote user unmuted the video stream |
|
virtual |
when remote user enable video function, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | enabled | true: the remote user has enabled video function, false: the remote user has disabled video function |
|
virtual |
when remote user enable local video function, the function will be called
[in] | remoteUid | the uid of the remote user |
[in] | enabled | true: the remote user has enabled local video function, false: the remote user has disabled local video function |
|
virtual |
Occurs when the remote user state is updated.
[in] | remoteUid | the uid of the remote user |
[in] | state | The remote user state: Just & #REMOTE_USER_STATE |
|
virtual |
Reports the statistics of the local audio stream.
The SDK triggers this callback once every two seconds.
stats | The statistics of the local audio stream. See LocalAudioStats. |
|
virtual |
Reports the statistics of the audio stream from each remote user/host.
This callback replaces the onAudioQuality callback.
The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times.
stats | Statistics of the received remote audio streams. See RemoteAudioStats. |
|
virtual |
Reports the statistics of the local video.
The SDK triggers this callback once every two seconds after the user joins the channel.
stats | The statistics of the uploading local video stream: LocalVideoStats. |
|
virtual |
Reports the statistics of the remote video.
The SDK triggers this callback once every two seconds for each remote user or broadcaster. If there are multiple users or broadcasters in the channel, the SDK triggers this callback as many times.
stats | The statistics of the remote video streams: RemoteVideoStats. |
|
virtual |
Occurs when the SDK cannot reconnect to the server 10 seconds after its connection to the server is interrupted.
The SDK triggers this callback when it cannot connect to the server 10 seconds after calling joinChannel, regardless of whether it is in the channel or not.
|
virtual |
Occurs when the connection between the SDK and the server is interrupted.
The SDK triggers this callback when it loses connection with the serer for more than 4 seconds after the connection is established. After triggering this callback, the SDK tries to reconnect to the server. If the reconnection fails within a certain period (10 seconds by default), the onConnectionLost() callback is triggered.
Once the connection is lost, the SDK continues to reconnect until the app calls leaveChannel.
|
virtual |
Occurs when your connection is banned by the Agora Server.
|
virtual |
Occurs when the user receives the data stream.
The SDK triggers this callback when the user receives the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
connection | RtcConnection |
remoteUid | uid_t |
streamId | The ID of the stream data. |
data | The data stream. |
length | The length (byte) of the data stream. |
sentTs | The time of the data stream sent. |
|
virtual |
Occurs when the local user fails to receive a remote data stream.
The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the sendStreamMessage() method.
remoteUid | ID of the remote user who sends the data stream. |
streamId | The stream ID. |
code | The error code: #ERROR_CODE_TYPE. |
missed | The number of lost messages. |
cached | The number of incoming cached messages when the data stream is interrupted. |
|
virtual |
Occurs when the token has expired.
If a token is specified when calling the joinChannel method, the token expires after a certain period of time and you need a new token to reconnect to the server.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new token to the SDK.
|
virtual |
Occurs when the token will expire in 30 seconds.
If the token you specified when calling joinChannel expires, the user will drop offline. This callback is triggered 30 seconds before the token expires, to remind you to renew the token.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new Token to the SDK.
token | The token that will expire in 30 seconds. |
|
virtual |
Occurs when the first local audio frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
|
virtual |
Occurs when the first remote audio frame is received.
connection | the RtcConnection of the local user. |
userId | ID of the remote user. |
elapsed | The time elapsed (ms) from the loca user calling joinChannel() until this callback is triggered. |
|
virtual |
Occurs when the SDK decodes the first remote audio frame for playback.
connection | the RtcConnection of the local user. |
uid | User ID of the remote user sending the audio stream. |
elapsed | The time elapsed (ms) from the loca user calling joinChannel() until this callback is triggered. |
|
virtual |
Occurs when the local audio state changes.
This callback indicates the state change of the local audio stream, including the state of the audio recording and encoding, and allows you to troubleshoot issues when exceptions occur.
error
parameter for details.state | State of the local audio. See #LOCAL_AUDIO_STREAM_STATE. |
error | The error information of the local audio. See #LOCAL_AUDIO_STREAM_ERROR. |
|
virtual |
Occurs when the remote audio state changes. REMOTE_AUDIO_STATE_REASON_REMOTE_OFFLINE is not 100% guaranteed. When the remote user leaves, use onUserOffline to make a business decision.
This callback indicates the state change of the remote audio stream.
remoteUid | ID of the remote user whose audio state changes. |
state | State of the remote audio. See #REMOTE_AUDIO_STATE. |
reason | The reason of the remote audio state change. See #REMOTE_AUDIO_STATE_REASON. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. |
|
virtual |
[in] | uid | the speaker uid who is talking in the channel |
|
virtual |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
oldRole | The old role of the user: #CLIENT_ROLE_TYPE. |
newRole | The new role of the user: #CLIENT_ROLE_TYPE. |
|
virtual |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
connection | RtcConnection |
reason | The reason of changing client role's failure: #CLIENT_ROLE_CHANGE_FAILED_REASON. |
currentRole | The current role of the user: #CLIENT_ROLE_TYPE. |
|
virtual |
Reports the transport-layer statistics of each remote audio stream.
This callback is triggered every two seconds once the user has received the audio data packet sent from a remote user.
remoteUid | ID of the remote user whose audio data packet is received. |
delay | The network time delay (ms) from the remote user sending the audio packet to the local user. |
lost | The Packet loss rate (%) of the audio packet sent from the remote user. |
rxKBitRate | Received bitrate (Kbps) of the audio packet sent from the remote user. |
|
virtual |
Reports the transport-layer statistics of each remote video stream.
This callback is triggered every two seconds once the user has received the video data packet sent from a remote user.
remoteUid | ID of the remote user whose video packet is received. |
delay | The network time delay (ms) from the remote user sending the video packet to the local user. |
lost | The packet loss rate (%) of the video packet sent from the remote user. |
rxKBitRate | The Received bitrate (Kbps) of the video packet sent from the remote user. |
|
virtual |
Occurs when the connection state of the SDK to the server is changed.
state | See #CONNECTION_STATE_TYPE. |
reason | See #CONNECTION_CHANGED_REASON_TYPE. |
|
virtual |
Occurs when the network type is changed.
type | See #NETWORK_TYPE. |
|
virtual |
Reports the error type of encryption.
connection | RtcConnection. |
errorType | See #ENCRYPTION_ERROR_TYPE. |
|
virtual |
Reports the user log upload result
requestId | RequestId of the upload |
success | Is upload success |
reason | Reason of the upload, 0: OK, 1 Network Error, 2 Server Error. |
virtual void agora::rtc::IRtcEngineEventHandler::onJoinChannelSuccess |
Occurs when the local user successfully joins the specified channel.
channel | The channel name. |
uid | The user ID.
|
elapsed | The time elapsed (ms) from the local user calling joinChannel until this event occurs. |
virtual void agora::rtc::IRtcEngineEventHandler::onRejoinChannelSuccess |
Occurs when the local user rejoins the channel after being disconnected due to network problems.
When the app loses connection with the server because of network problems, the SDK automatically tries to reconnect to the server, and triggers this callback method upon reconnection.
channel | The channel name. |
uid | The user ID. |
elapsed | Time elapsed (ms) from starting to reconnect until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onAudioQuality |
Reports the statistics of the audio stream from each remote user/broadcaster.
The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple remote users/hosts sending audio streams, the SDK triggers this callback as many times.
uid | The user ID of the speaker. |
quality | The audio quality of the user: #QUALITY_TYPE |
delay | The time delay (ms) of the audio packet from the sender to the receiver. |
lost | The audio packet loss rate (%) from the sender to the receiver. |
virtual void agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication |
Reports which users are speaking and the speaker‘s volume.
This callback reports the IDs and volumes of the loudest speakers at the moment in the channel, and whether the local user is speaking. Once enabled, this callback is triggered at the set interval, regardless of whether a user speaks or not.
The SDK triggers two independent onAudioVolumeIndication
callbacks at one time, which separately report the volume information of the local user and all the remote speakers. For more information, see the detailed parameter descriptions.
Calling the muteLocalAudioStream method affects the SDK's behavior.
muteLocalAudioStream
method, the SDK stops triggering the local user's callback.muteLocalAudioStream
method, the remote speakers' callback does not include information of this remote user; 20 seconds after all remote users call the muteLocalAudioStream
method, the SDK stops triggering the remote speakers' callback.speakers | An array containing the user ID and volume information for each speaker: AudioVolumeInfo.
|
speakerNumber | The total number of speakers. The value range is [0, 3].
|
totalVolume | The total volume after audio mixing. The value ranges between 0 (the lowest volume) and 255 (the highest volume).
|
virtual void agora::rtc::IRtcEngineEventHandler::onLeaveChannel |
Occurs when the local user successfully leaves the channel.
When the user successfully leaves the channel after calling leaveChannel, the SDK uses this callback to notify the app that the user has left the channel.
This callback also reports information such as the call duration and the statistics of data received or transmitted by the SDK.
stats | The statistics on the call: RtcStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onRtcStats |
Reports the statistics of the current call.
This callback is triggered once every two seconds after the user joins the channel.
stats | The statistics of the current call: RtcStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onNetworkQuality |
Reports the network quality of each user.
This callback is triggered once every two seconds after the user joins the channel.
uid | The user ID. If uid is 0, the SDK reports the local network quality. |
txQuality | The transmission quality of the user: #QUALITY_TYPE. |
rxQuality | The receiving quality of the user: #QUALITY_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onIntraRequestReceived |
Occurs when intra request from remote user is received.
This callback is triggered once remote user needs one Key frame.
virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFrame |
Occurs when the first local video frame is rendered on the local video view.
width | Width (px) of the first local video frame. |
height | Height (px) of the first local video frame. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. If you call the startPreview method before calling the joinChannel method, then elapsed is the time elapsed from calling the startPreview method until the SDK triggers this callback. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished |
Occurs when the first local video frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded |
Occurs when the first remote video frame is received and decoded.
This callback is triggered upon the SDK receiving and successfully decoding the first video frame from a remote video. The app can configure the user view settings in this callback.
uid | ID of the user whose video streams are received. |
width | The width (pixels) of the video stream. |
height | The height (pixels) of the video stream. |
elapsed | The time elapsed (ms) from the local user calling joinChannel until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged |
Occurs when the local video stream state changes
This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.
state | State type #LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the error parameter for details. |
error | The detailed error information: #LOCAL_VIDEO_STREAM_ERROR. |
virtual void agora::rtc::IRtcEngineEventHandler::onContentInspectResult |
Reports result of Content Inspect
virtual void agora::rtc::IRtcEngineEventHandler::onSnapshotTaken |
snapshot taken callback
Occurs when takeSnapshot API result is obtained
channel | channel name |
uid | user id |
filePath | image is saveed file path |
width | image width |
height | image height |
errCode | 0 is ok negative is error |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoStateChanged |
Occurs when the remote video state has changed.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.uid | ID of the user whose video state has changed. |
state | The remote video state: #REMOTE_VIDEO_STATE. |
reason | The reason of the remote video state change: #REMOTE_VIDEO_STATE_REASON. |
elapsed | The time elapsed (ms) from the local client calling joinChannel until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoFrame |
Occurs when the first remote video frame is rendered.
The SDK triggers this callback when the first frame of the remote video is rendered in the user's video window.
The application can retrieve the time elapsed from a user joining the channel until the first video frame is rendered.
userId | ID of the remote user sending the video stream. |
width | Width (px) of the video frame. |
height | Height (px) of the video stream. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. |
virtual void agora::rtc::IRtcEngineEventHandler::onUserJoined |
Occurs when a remote user or broadcaster joins the channel.
If other users are already in the channel, the SDK also reports to the app on the existing users.
The SDK triggers this callback under one of the following circumstances:
joinChannel
.uid | ID of the remote user or broadcaster joining the channel. |
elapsed | The time elapsed (ms) from the local user calling joinChannel or setClientRole until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onUserOffline |
Occurs when a remote user or broadcaster goes offline.
There are two reasons for a user to go offline:
uid | ID of the remote user or broadcaster who leaves the channel or drops offline. |
reason | The reason why the remote user goes offline: #USER_OFFLINE_REASON_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onUserMuteAudio |
Occurs when a remote user's audio stream playback pauses/resumes.
The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.
COMMUNICATION
profile) or hosts (in the LIVE_BROADCASTING
profile) in the channel exceeds 17.uid | User ID of the remote user. |
muted | Whether the remote user's audio stream is muted/unmuted:
|
virtual void agora::rtc::IRtcEngineEventHandler::onUserMuteVideo |
Occurs when a remote user pauses or resumes sending the video stream.
userId | ID of the remote user. |
muted | bool
|
virtual void agora::rtc::IRtcEngineEventHandler::onUserEnableVideo |
Occurs when a remote user enables or disables the video module.
Once the video function is disabled, the users cannot see any video.
uid | ID of the remote user. |
enabled | bool
|
virtual void agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo |
Occurs when a remote user enables or disables the local video function.
uid | ID of the remote user. |
enabled | bool
|
virtual void agora::rtc::IRtcEngineEventHandler::onUserStateChanged |
Occurs when the remote user state is updated.
uid | The uid of the remote user. |
state | The remote user state. Just & #REMOTE_USER_STATE |
virtual void agora::rtc::IRtcEngineEventHandler::onLocalAudioStats |
Reports the statistics of the local audio stream.
The SDK triggers this callback once every two seconds.
stats | The statistics of the local audio stream. See LocalAudioStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats |
Reports the statistics of the audio stream from each remote user/host.
This callback replaces the onAudioQuality callback.
The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times.
stats | Statistics of the received remote audio streams. See RemoteAudioStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onLocalVideoStats |
Reports the statistics of the local video stream.
The SDK triggers this callback once every two seconds for each user/host. If there are multiple users/hosts in the channel, the SDK triggers this callback as many times.
stats | Statistics of the local video stream. See LocalVideoStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoStats |
Reports the statistics of the video stream from each remote user/host.
The SDK triggers this callback once every two seconds for each remote user/host. If a channel includes multiple remote users, the SDK triggers this callback as many times.
stats | Statistics of the remote video stream. See RemoteVideoStats. |
virtual void agora::rtc::IRtcEngineEventHandler::onConnectionLost |
Occurs when the SDK cannot reconnect to the server 10 seconds after its connection to the server is interrupted.
The SDK triggers this callback when it cannot connect to the server 10 seconds after calling joinChannel
, regardless of whether it is in the channel or not.
virtual void agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted |
Occurs when the connection between the SDK and the server is interrupted.
The SDK triggers this callback when it loses connection with the serer for more than 4 seconds after the connection is established. After triggering this callback, the SDK tries to reconnect to the server. If the reconnection fails within a certain period (10 seconds by default), the onConnectionLost() callback is triggered.
Once the connection is lost, the SDK continues to reconnect until the app calls leaveChannel.
virtual void agora::rtc::IRtcEngineEventHandler::onConnectionBanned |
Occurs when your connection is banned by the Agora Server.
virtual void agora::rtc::IRtcEngineEventHandler::onStreamMessage |
Occurs when the user receives the data stream.
The SDK triggers this callback when the user receives the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
userId | ID of the user who sends the data stream. |
streamId | The ID of the stream data. |
data | The data stream. |
length | The length (byte) of the data stream. |
sentTs | The time of the data stream sent. |
virtual void agora::rtc::IRtcEngineEventHandler::onStreamMessageError |
Occurs when the user fails to receive the data stream.
The SDK triggers this callback when the user does not receive the data stream that another user sends by calling the sendStreamMessage method within 5 seconds.
userId | ID of the user who sends the data stream. |
streamId | The ID of the stream data. |
code | The error code: #ERROR_CODE_TYPE. |
missed | The number of lost messages. |
cached | The number of incoming cached messages when the data stream is interrupted. |
virtual void agora::rtc::IRtcEngineEventHandler::onRequestToken |
Occurs when the token has expired.
If a token is specified when calling the joinChannel
method, the token expires after a certain period of time and you need a new token to reconnect to the server.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new token to the SDK.
virtual void agora::rtc::IRtcEngineEventHandler::onTokenPrivilegeWillExpire |
Occurs when the token will expire in 30 seconds.
If the token you specified when calling joinChannel
expires, the user will drop offline. This callback is triggered 30 seconds before the token expires, to remind you to renew the token.
Upon receiving this callback, generate a new token at your app server and call renewToken to pass the new Token to the SDK.
token | The token that will expire in 30 seconds. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished |
Occurs when the first local audio frame is published.
elapsed | The time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame |
Occurs when the first remote audio frame is received.
uid | ID of the remote user. |
elapsed | The time elapsed (ms) from the loca user calling joinChannel() until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded |
Occurs when the SDK decodes the first remote audio frame for playback.
uid | User ID of the remote user sending the audio stream. |
elapsed | The time elapsed (ms) from the loca user calling joinChannel() until this callback is triggered. |
virtual void agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged |
Occurs when the local audio state changes.
This callback indicates the state change of the local audio stream, including the state of the audio recording and encoding, and allows you to troubleshoot issues when exceptions occur.
error
parameter for details.state | State of the local audio. See #LOCAL_AUDIO_STREAM_STATE. |
error | The error information of the local audio. See #LOCAL_AUDIO_STREAM_ERROR. |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged |
Occurs when the remote audio state changes.
This callback indicates the state change of the remote audio stream.
uid | ID of the remote user whose audio state changes. |
state | State of the remote audio. See #REMOTE_AUDIO_STATE. |
reason | The reason of the remote audio state change. See #REMOTE_AUDIO_STATE_REASON. |
elapsed | Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback. |
virtual void agora::rtc::IRtcEngineEventHandler::onActiveSpeaker |
Occurs when an active speaker is detected.
You can add relative functions on your app, for example, the active speaker, once detected, will have the portrait zoomed in.
userId | The ID of the active speaker. A uid of 0 means the local user. |
virtual void agora::rtc::IRtcEngineEventHandler::onClientRoleChanged |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
oldRole | The old role of the user: #CLIENT_ROLE_TYPE. |
newRole | The new role of the user: #CLIENT_ROLE_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onClientRoleChangeFailed |
Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.
reason | The reason of changing client role's failure: #CLIENT_ROLE_CHANGE_FAILED_REASON. |
currentRole | The current role of the user: #CLIENT_ROLE_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats |
Reports the transport-layer statistics of each remote audio stream.
This callback is triggered every two seconds once the user has received the audio data packet sent from a remote user.
uid | ID of the remote user whose audio data packet is received. |
delay | The network time delay (ms) from the remote user sending the audio packet to the local user. |
lost | The Packet loss rate (%) of the audio packet sent from the remote user. |
rxKBitRate | Received bitrate (Kbps) of the audio packet sent from the remote user. |
virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats |
Reports the transport-layer statistics of each remote video stream.
This callback is triggered every two seconds once the user has received the video data packet sent from a remote user.
uid | ID of the remote user whose video packet is received. |
delay | The network time delay (ms) from the remote user sending the video packet to the local user. |
lost | The packet loss rate (%) of the video packet sent from the remote user. |
rxKBitRate | The Received bitrate (Kbps) of the video packet sent from the remote user. |
virtual void agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged |
Occurs when the connection state of the SDK to the server is changed.
state | See #CONNECTION_STATE_TYPE. |
reason | See #CONNECTION_CHANGED_REASON_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onNetworkTypeChanged |
Occurs when the network type is changed.
type | See #NETWORK_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onEncryptionError |
Reports the error type of encryption.
errorType | See #ENCRYPTION_ERROR_TYPE. |
virtual void agora::rtc::IRtcEngineEventHandler::onUploadLogResult |
Reports the user log upload result
requestId | RequestId of the upload |
success | Is upload success |
reason | Reason of the upload, 0: OK, 1 Network Error, 2 Server Error. |
virtual void agora::rtc::IRtcEngineEventHandler::onAudioSubscribeStateChanged |
Occurs when the audio subscribe state changed.
channel | The channel name of user joined. |
uid | The remote user ID that is subscribed to. |
oldState | The old state of the audio stream subscribe : #STREAM_SUBSCRIBE_STATE. |
newState | The new state of the audio stream subscribe : #STREAM_SUBSCRIBE_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
virtual void agora::rtc::IRtcEngineEventHandler::onVideoSubscribeStateChanged |
Occurs when the video subscribe state changed.
channel | The channel name of user joined. |
uid | The remote user ID that is subscribed to. |
oldState | The old state of the video stream subscribe : #STREAM_SUBSCRIBE_STATE. |
newState | The new state of the video stream subscribe : #STREAM_SUBSCRIBE_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
virtual void agora::rtc::IRtcEngineEventHandler::onAudioPublishStateChanged |
Occurs when the audio publish state changed.
channel | The channel name of user joined. |
oldState | The old state of the audio stream publish : #STREAM_PUBLISH_STATE. |
newState | The new state of the audio stream publish : #STREAM_PUBLISH_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |
virtual void agora::rtc::IRtcEngineEventHandler::onVideoPublishStateChanged |
Occurs when the video publish state changed.
channel | The channel name of user joined. |
oldState | The old state of the video stream publish : #STREAM_PUBLISH_STATE. |
newState | The new state of the video stream publish : #STREAM_PUBLISH_STATE. |
elapseSinceLastState | The time elapsed (ms) from the old state to the new state. |