Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::rtc::IRtcEngineEventHandlerEx Class Reference

Inherits agora::rtc::IRtcEngineEventHandler.

Inherited by agora::rtc::IRtcEngineEventHandlerInternal.

Public Member Functions

virtual const char * eventHandlerType () const
 
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 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 onUserMuteVideo (const RtcConnection &connection, uid_t remoteUid, bool muted)
 
virtual void onUserEnableVideo (const RtcConnection &connection, uid_t remoteUid, bool enabled)
 
virtual void onUserEnableLocalVideo (const RtcConnection &connection, uid_t remoteUid, bool enabled)
 
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 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 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 onUserAccountUpdated (const RtcConnection &connection, uid_t remoteUid, const char *userAccount)
 
virtual const char * eventHandlerType () const
 
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)
 
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 onUserMuteVideo (uid_t userId, bool muted)
 
virtual void onUserEnableVideo (uid_t uid, bool enabled)
 
virtual void onUserEnableLocalVideo (uid_t uid, bool enabled)
 
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 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 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 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)
 
- Public Member Functions inherited from agora::rtc::IRtcEngineEventHandler
virtual ~IRtcEngineEventHandler ()
 
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 ()
 
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)
 
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 onUserMuteVideo (uid_t userId, bool muted)
 
virtual void onUserEnableVideo (uid_t uid, bool enabled)
 
virtual void onUserEnableLocalVideo (uid_t uid, bool enabled)
 
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 onFacePositionChanged (int imageWidth, int imageHeight, const Rectangle *vecRectangle, const int *vecDistance, int numFaces)
 
virtual void onVideoStopped ()
 
virtual void onAudioMixingStateChanged (AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_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 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 onAudioDeviceVolumeChanged (MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)
 
virtual void onRtmpStreamingStateChanged (const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode)
 
virtual void onStreamPublished (const char *url, int error)
 
virtual void onStreamUnpublished (const char *url)
 
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 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_name, const char *ext_name, const char *key, const char *json_value)
 
virtual void onExtensionStarted (const char *provider_name, const char *ext_name)
 
virtual void onExtensionStopped (const char *provider_name, const char *ext_name)
 
virtual void onExtensionErrored (const char *provider_name, const char *ext_name, int error, const char *msg)
 
virtual void onUserAccountUpdated (uid_t uid, const char *userAccount)
 

Member Function Documentation

◆ eventHandlerType() [1/2]

virtual const char* agora::rtc::IRtcEngineEventHandlerEx::eventHandlerType ( ) const
inlinevirtual

◆ onAudioQuality() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onAudioQuality ( const RtcConnection connection,
uid_t  remoteUid,
int  quality,
unsigned short  delay,
unsigned short  lost 
)
inlinevirtual

when audio quality message come, the function will be called

Parameters
[in]connectionthe connection of the local user.
[in]remoteUidthe uid of the peer
[in]qualitythe quality of the remote user, see QUALITY_TYPE for value definition
[in]delaythe average time of the audio packages delayed
[in]lostthe rate of the audio packages lost

◆ onAudioVolumeIndication() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onAudioVolumeIndication ( const RtcConnection connection,
const AudioVolumeInfo speakers,
unsigned int  speakerNumber,
int  totalVolume 
)
inlinevirtual

◆ onLeaveChannel() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onLeaveChannel ( const RtcConnection connection,
const RtcStats stats 
)
inlinevirtual

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.

Parameters
connectionThe connection of the local user.
statsThe statistics on the call: RtcStats.

◆ onRtcStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRtcStats ( const RtcConnection connection,
const RtcStats stats 
)
inlinevirtual

Reports the statistics of the current call.

This callback is triggered once every two seconds after the user joins the channel.

Parameters
connectionThe connection of the local user.
statsThe statistics of the current call: RtcStats.

◆ onNetworkQuality() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onNetworkQuality ( const RtcConnection connection,
uid_t  remoteUid,
int  txQuality,
int  rxQuality 
)
inlinevirtual

report the network quality

Parameters
[in]connectionthe connection of the local user.
[in]remoteUidthe uid of the remote user
[in]txQualitythe score of the send network quality 0~5 the higher the better
[in]rxQualitythe score of the recv network quality 0~5 the higher the better

◆ onIntraRequestReceived() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onIntraRequestReceived ( const RtcConnection connection)
inlinevirtual

Occurs when intra request from remote user is received.

This callback is triggered once remote user needs one Key frame.

Parameters
connectionThe connection of the local user.

◆ onFirstLocalVideoFrame() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalVideoFrame ( const RtcConnection connection,
int  width,
int  height,
int  elapsed 
)
inlinevirtual

Occurs when the first local video frame is displayed on the video window.

Parameters
connectionThe connection of the local user.
widthThe width (pixels) of the video stream.
heightThe height (pixels) of the video stream.
elapsedThe time elapsed (ms) from the local user calling joinChannel until this callback is triggered.

◆ onFirstLocalVideoFramePublished() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalVideoFramePublished ( const RtcConnection connection,
int  elapsed 
)
inlinevirtual

Occurs when the first local video frame is published.

Parameters
elapsedThe time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback.

◆ onVideoSourceFrameSizeChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onVideoSourceFrameSizeChanged ( const RtcConnection connection,
VIDEO_SOURCE_TYPE  sourceType,
int  width,
int  height 
)
inlinevirtual

◆ onFirstRemoteVideoDecoded() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoDecoded ( const RtcConnection connection,
uid_t  remoteUid,
int  width,
int  height,
int  elapsed 
)
inlinevirtual

when the first remote video frame decoded, the function will be called

Parameters
[in]remoteUidthe uid of the remote user
[in]widththe width of the video frame
[in]heightthe height of the video frame
[in]elapsedthe time elapsed from channel joined in ms

◆ onVideoSizeChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onVideoSizeChanged ( const RtcConnection connection,
uid_t  uid,
int  width,
int  height,
int  rotation 
)
inlinevirtual

when video size changed or rotation changed, the function will be called

Parameters
[in]uidthe uid of the remote user or local user (0)
[in]widththe new width of the video
[in]heightthe new height of the video
[in]rotationthe rotation of the video

◆ onLocalVideoStateChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onLocalVideoStateChanged ( const RtcConnection connection,
LOCAL_VIDEO_STREAM_STATE  state,
LOCAL_VIDEO_STREAM_ERROR  errorCode 
)
inlinevirtual

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.

Note
For some device models, the SDK will not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
Parameters
connectionThe connection of the local user.
stateState type LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the error parameter for details.
errorThe detailed error information: LOCAL_VIDEO_STREAM_ERROR.

◆ onRemoteVideoStateChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoStateChanged ( const RtcConnection connection,
uid_t  remoteUid,
REMOTE_VIDEO_STATE  state,
REMOTE_VIDEO_STATE_REASON  reason,
int  elapsed 
)
inlinevirtual

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.

Parameters
connectionThe connection of the local user.
remoteUidID of the user whose video state has changed.
stateThe remote video state: REMOTE_VIDEO_STATE.
reasonThe reason of the remote video state change: REMOTE_VIDEO_STATE_REASON.
elapsedThe time elapsed (ms) from the local user calling ref IRtcEngine::joinChannel "joinChannel" until this callback is triggered.

◆ onFirstRemoteVideoFrame() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onFirstRemoteVideoFrame ( const RtcConnection connection,
uid_t  remoteUid,
int  width,
int  height,
int  elapsed 
)
inlinevirtual

when the first remote video frame displayed, the function will be called

Parameters
[in]connectionthe connection of the local user.
[in]remoteUidthe uid of the remote user
[in]widththe width of the video frame
[in]heightthe height of the video frame
[in]elapsedthe time elapsed from remote user called joinChannel in ms

◆ onUserJoined() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserJoined ( const RtcConnection connection,
uid_t  remoteUid,
int  elapsed 
)
inlinevirtual

when any other user joined in the same channel, the function will be called

Parameters
[in]remoteUidthe uid of the remote user
[in]elapsedthe time elapsed from remote used called joinChannel to joining completed in ms

◆ onUserOffline() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserOffline ( const RtcConnection connection,
uid_t  remoteUid,
USER_OFFLINE_REASON_TYPE  reason 
)
inlinevirtual

when user offline(exit channel or offline by accident), the function will be called

Parameters
[in]connectionthe connection of the local user.
[in]remoteUidthe uid of the remote user

◆ onUserMuteVideo() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserMuteVideo ( const RtcConnection connection,
uid_t  remoteUid,
bool  muted 
)
inlinevirtual

when remote user muted the video stream, the function will be called

Deprecated:
Use onRemoteVideoStateChanged instead of.
Parameters
[in]remoteUidthe uid of the remote user
[in]mutedtrue: the remote user muted the video stream, false: the remote user unmuted the video stream

◆ onUserEnableVideo() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserEnableVideo ( const RtcConnection connection,
uid_t  remoteUid,
bool  enabled 
)
inlinevirtual

when remote user enable video function, the function will be called

Deprecated:
Use onRemoteVideoStateChanged instead of.
Parameters
[in]remoteUidthe uid of the remote user
[in]enabledtrue: the remote user has enabled video function, false: the remote user has disabled video function

◆ onUserEnableLocalVideo() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserEnableLocalVideo ( const RtcConnection connection,
uid_t  remoteUid,
bool  enabled 
)
inlinevirtual

when remote user enable local video function, the function will be called

Deprecated:
Use onRemoteVideoStateChanged instead of.
Parameters
[in]remoteUidthe uid of the remote user
[in]enabledtrue: the remote user has enabled local video function, false: the remote user has disabled local video function

◆ onLocalAudioStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStats ( const RtcConnection connection,
const LocalAudioStats stats 
)
inlinevirtual

Reports the statistics of the local audio stream.

The SDK triggers this callback once every two seconds.

Parameters
statsThe statistics of the local audio stream. See LocalAudioStats.

◆ onRemoteAudioStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioStats ( const RtcConnection connection,
const RemoteAudioStats stats 
)
inlinevirtual

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.

Parameters
statsStatistics of the received remote audio streams. See RemoteAudioStats.

◆ onLocalVideoStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onLocalVideoStats ( const RtcConnection connection,
const LocalVideoStats stats 
)
inlinevirtual

Reports the statistics of the local video.

The SDK triggers this callback once every two seconds after the user joins the channel.

Parameters
statsThe statistics of the uploading local video stream: LocalVideoStats.

◆ onRemoteVideoStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoStats ( const RtcConnection connection,
const RemoteVideoStats stats 
)
inlinevirtual

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.

Parameters
statsThe statistics of the remote video streams: RemoteVideoStats.

◆ onConnectionLost() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onConnectionLost ( const RtcConnection connection)
inlinevirtual

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.

◆ onConnectionInterrupted() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onConnectionInterrupted ( const RtcConnection connection)
inlinevirtual

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.

◆ onConnectionBanned() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onConnectionBanned ( const RtcConnection connection)
inlinevirtual

Occurs when your connection is banned by the Agora Server.

◆ onStreamMessage() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onStreamMessage ( const RtcConnection connection,
uid_t  remoteUid,
int  streamId,
const char *  data,
size_t  length,
uint64_t  sentTs 
)
inlinevirtual

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.

Parameters
userIdID of the user who sends the data stream.
streamIdThe ID of the stream data.
dataThe data stream.
lengthThe length (byte) of the data stream.
sentTsThe time of the data stream sent.

◆ onStreamMessageError() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onStreamMessageError ( const RtcConnection connection,
uid_t  remoteUid,
int  streamId,
int  code,
int  missed,
int  cached 
)
inlinevirtual

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.

Parameters
remoteUidID of the remote user who sends the data stream.
streamIdThe stream ID.
codeThe error code: ERROR_CODE_TYPE.
missedThe number of lost messages.
cachedThe number of incoming cached messages when the data stream is interrupted.

◆ onRequestToken() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRequestToken ( const RtcConnection connection)
inlinevirtual

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.

See also
How to generate a token.

◆ onTokenPrivilegeWillExpire() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onTokenPrivilegeWillExpire ( const RtcConnection connection,
const char *  token 
)
inlinevirtual

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.

See also
How to generate a token.
Parameters
tokenThe token that will expire in 30 seconds.

◆ onFirstLocalAudioFramePublished() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onFirstLocalAudioFramePublished ( const RtcConnection connection,
int  elapsed 
)
inlinevirtual

Occurs when the first local audio frame is published.

Parameters
elapsedThe time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback.

◆ onLocalAudioStateChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onLocalAudioStateChanged ( const RtcConnection connection,
LOCAL_AUDIO_STREAM_STATE  state,
LOCAL_AUDIO_STREAM_ERROR  error 
)
inlinevirtual

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.

Note
When the state is LOCAL_AUDIO_STREAM_STATE_FAILED (3), see the error parameter for details.
Parameters
stateState of the local audio. See LOCAL_AUDIO_STREAM_STATE.
errorThe error information of the local audio. See LOCAL_AUDIO_STREAM_ERROR.

◆ onRemoteAudioStateChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioStateChanged ( const RtcConnection connection,
uid_t  remoteUid,
REMOTE_AUDIO_STATE  state,
REMOTE_AUDIO_STATE_REASON  reason,
int  elapsed 
)
inlinevirtual

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.

Parameters
remoteUidID of the remote user whose audio state changes.
stateState of the remote audio. See REMOTE_AUDIO_STATE.
reasonThe reason of the remote audio state change. See REMOTE_AUDIO_STATE_REASON.
elapsedTime elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

◆ onActiveSpeaker() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onActiveSpeaker ( const RtcConnection connection,
uid_t  uid 
)
inlinevirtual
Parameters
[in]uidthe speaker uid who is talking in the channel

◆ onClientRoleChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onClientRoleChanged ( const RtcConnection connection,
CLIENT_ROLE_TYPE  oldRole,
CLIENT_ROLE_TYPE  newRole 
)
inlinevirtual

Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.

Parameters
oldRoleThe old role of the user: CLIENT_ROLE_TYPE.
newRoleThe new role of the user: CLIENT_ROLE_TYPE.

◆ onRemoteAudioTransportStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteAudioTransportStats ( const RtcConnection connection,
uid_t  remoteUid,
unsigned short  delay,
unsigned short  lost,
unsigned short  rxKBitRate 
)
inlinevirtual

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.

Parameters
remoteUidID of the remote user whose audio data packet is received.
delayThe network time delay (ms) from the remote user sending the audio packet to the local user.
lostThe Packet loss rate (%) of the audio packet sent from the remote user.
rxKBitRateReceived bitrate (Kbps) of the audio packet sent from the remote user.

◆ onRemoteVideoTransportStats() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onRemoteVideoTransportStats ( const RtcConnection connection,
uid_t  remoteUid,
unsigned short  delay,
unsigned short  lost,
unsigned short  rxKBitRate 
)
inlinevirtual

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.

Parameters
remoteUidID of the remote user whose video packet is received.
delayThe network time delay (ms) from the remote user sending the video packet to the local user.
lostThe packet loss rate (%) of the video packet sent from the remote user.
rxKBitRateThe Received bitrate (Kbps) of the video packet sent from the remote user.

◆ onConnectionStateChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onConnectionStateChanged ( const RtcConnection connection,
CONNECTION_STATE_TYPE  state,
CONNECTION_CHANGED_REASON_TYPE  reason 
)
inlinevirtual

Occurs when the connection state of the SDK to the server is changed.

Parameters
stateSee CONNECTION_STATE_TYPE.
reasonSee CONNECTION_CHANGED_REASON_TYPE.

◆ onNetworkTypeChanged() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onNetworkTypeChanged ( const RtcConnection connection,
NETWORK_TYPE  type 
)
inlinevirtual

Occurs when the network type is changed.

Parameters
typeSee NETWORK_TYPE.

◆ onEncryptionError() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onEncryptionError ( const RtcConnection connection,
ENCRYPTION_ERROR_TYPE  errorType 
)
inlinevirtual

Reports the error type of encryption.

Parameters
typeSee ENCRYPTION_ERROR_TYPE.

◆ onUserAccountUpdated() [1/2]

virtual void agora::rtc::IRtcEngineEventHandlerEx::onUserAccountUpdated ( const RtcConnection connection,
uid_t  remoteUid,
const char *  userAccount 
)
inlinevirtual

◆ eventHandlerType() [2/2]

virtual const char* agora::rtc::IRtcEngineEventHandler::eventHandlerType
inline

◆ onAudioQuality() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onAudioQuality
inline

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.

Parameters
uidThe user ID of the speaker.
qualityThe audio quality of the user: QUALITY_TYPE
delayThe time delay (ms) of the audio packet from the sender to the receiver.
lostThe audio packet loss rate (%) from the sender to the receiver.

◆ onAudioVolumeIndication() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onAudioVolumeIndication
inline

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.

  • If the local user calls the muteLocalAudioStream method, the SDK stops triggering the local user's callback.
  • 20 seconds after a remote speaker calls the 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.
Parameters
speakersAn array containing the user ID and volume information for each speaker: AudioVolumeInfo.
  • In the local user's callback, this array contains the following members:
    • uid = 0,
    • volume = totalVolume, which reports the sum of the voice volume and audio-mixing volume of the local user.
  • In the remote users' callback, this array contains the following members:

    • uid of each remote speaker.
    • volume, which reports the sum of the voice volume and audio-mixing volume of each remote speaker.

    An empty speakers array in the callback indicates that no remote user is speaking at the moment.

speakerNumberThe total number of speakers. The value range is [0, 3].
  • In the local user's callback, speakerNumber = ‘, regardless of whether the local user speaks or not.
  • In the remote speakers’ callback, the callback reports the IDs and volumes of the three loudest speakers when there are more than three remote users in the channel, and speakerNumber = 3.
totalVolumeThe total volume after audio mixing. The value ranges between 0 (the lowest volume) and 255 (the highest volume).
  • In the local user's callback, totalVolume is the sum of the voice volume and audio-mixing volume of the local user.
  • In the remote users' callback, totalVolume is the sum of the voice volume and audio-mixing volume of all the remote speakers.

◆ onLeaveChannel() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onLeaveChannel
inline

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.

Parameters
statsThe statistics on the call: RtcStats.

◆ onRtcStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRtcStats
inline

Reports the statistics of the current call.

This callback is triggered once every two seconds after the user joins the channel.

Parameters
statsThe statistics of the current call: RtcStats.

◆ onNetworkQuality() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onNetworkQuality
inline

Reports the network quality of each user.

This callback is triggered once every two seconds after the user joins the channel.

Parameters
uidThe user ID. If uid is 0, the SDK reports the local network quality.
txQualityThe transmission quality of the user: QUALITY_TYPE.
rxQualityThe receiving quality of the user: QUALITY_TYPE.

◆ onIntraRequestReceived() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onIntraRequestReceived
inline

Occurs when intra request from remote user is received.

This callback is triggered once remote user needs one Key frame.

◆ onFirstLocalVideoFrame() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFrame
inline

Occurs when the first local video frame is rendered on the local video view.

Parameters
widthWidth (px) of the first local video frame.
heightHeight (px) of the first local video frame.
elapsedTime 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.

◆ onFirstLocalVideoFramePublished() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalVideoFramePublished
inline

Occurs when the first local video frame is published.

Parameters
elapsedThe time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback.

◆ onVideoSourceFrameSizeChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onVideoSourceFrameSizeChanged
inline

◆ onFirstRemoteVideoDecoded() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded
inline

Occurs when the first remote video frame is received and decoded.

Deprecated:
This callback is deprecated since v3.1.200. Use onRemoteVideoStateChanged instead.

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.

Parameters
uidID of the user whose video streams are received.
widthThe width (pixels) of the video stream.
heightThe height (pixels) of the video stream.
elapsedThe time elapsed (ms) from the local user calling joinChannel until this callback is triggered.

◆ onVideoSizeChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onVideoSizeChanged
inline

◆ onLocalVideoStateChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onLocalVideoStateChanged
inline

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.

Note
For some device models, the SDK will not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
Parameters
stateState type LOCAL_VIDEO_STREAM_STATE. When the state is LOCAL_VIDEO_STREAM_STATE_FAILED (3), see the error parameter for details.
errorThe detailed error information: LOCAL_VIDEO_STREAM_ERROR.

◆ onRemoteVideoStateChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoStateChanged
inline

Occurs when the remote video state has changed.

Note
This callback does not work properly when the number of users (in the COMMUNICATION profile) or hosts (in the LIVE_BROADCASTING profile) in the channel exceeds 17.
Parameters
userIdID of the user whose video state has changed.
stateThe remote video state: REMOTE_VIDEO_STATE.
reasonThe reason of the remote video state change: REMOTE_VIDEO_STATE_REASON.
elapsedThe time elapsed (ms) from the local client calling joinChannel until this callback is triggered.

◆ onFirstRemoteVideoFrame() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoFrame
inline

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.

Parameters
userIdID of the remote user sending the video stream.
widthWidth (px) of the video frame.
heightHeight (px) of the video stream.
elapsedTime elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

◆ onUserJoined() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserJoined
inline

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:

  • A broadcaster joins the channel by calling joinChannel.
  • A remote user switches the user role to broadcaster by calling setClientRole after joining the channel.
  • A remote user or broadcaster rejoins the channel after a network interruption.
Note
When a Web app joins the channel, this callback is triggered as long as the app publishes a stream.
Parameters
uidID of the remote user or broadcaster joining the channel.
elapsedThe time elapsed (ms) from the local user calling joinChannel or setClientRole until this callback is triggered.

◆ onUserOffline() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserOffline
inline

Occurs when a remote user or broadcaster goes offline.

There are two reasons for a user to go offline:

  • Leave the channel: When the user leaves the channel, the user sends a goodbye message. When this message is received, the SDK determines that the user leaves the channel.
  • Drop offline: When no data packet of the user is received for a certain period of time, the SDK assumes that the user drops offline. A poor network connection may lead to false detection, so we recommend using the RTM SDK for reliable offline detection.
  • The user switches the user role from a broadcaster to an audience.
Parameters
uidID of the remote user or broadcaster who leaves the channel or drops offline.
reasonThe reason why the remote user goes offline: USER_OFFLINE_REASON_TYPE.

◆ onUserMuteVideo() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserMuteVideo
inline

Occurs when a remote user pauses or resumes sending the video stream.

Deprecated:
This callback is deprecated since v3.1.200. Use onRemoteVideoStateChanged instead.
Note
This callback is invalid when the number of users or broadacasters in a channel exceeds 20.
Parameters
uidID of the remote user.
muted
  • True: The remote user has paused sending the video stream.
  • False: The remote user has resumed sending the video stream.

◆ onUserEnableVideo() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserEnableVideo
inline

Occurs when a remote user enables or disables the video module.

Once the video function is disabled, the users cannot see any video.

Deprecated:
This callback is deprecated since v3.1.200. Use onRemoteVideoStateChanged instead.
Note
This callback is invalid when the number of users or broadcasters in a channel exceeds 20.
Parameters
uidID of the remote user.
enabled
  • True: The remote user has enabled the video module.
  • False: The remote user has disabled the video module.

◆ onUserEnableLocalVideo() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserEnableLocalVideo
inline

Occurs when a remote user enables or disables the local video function.

Deprecated:
This callback is deprecated since v3.1.200. Use onRemoteVideoStateChanged instead.
Parameters
uidID of the remote user.
enabled
  • True: The remote user has enabled the local video function.
  • False: The remote user has disabled the local video function.

◆ onLocalAudioStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onLocalAudioStats
inline

Reports the statistics of the local audio stream.

The SDK triggers this callback once every two seconds.

Parameters
statsThe statistics of the local audio stream. See LocalAudioStats.

◆ onRemoteAudioStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioStats
inline

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.

Parameters
statsStatistics of the received remote audio streams. See RemoteAudioStats.

◆ onLocalVideoStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onLocalVideoStats
inline

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.

Note
If you have called the enableDualStreamMode method, this callback reports the statistics of the high-video stream (high bitrate, and high-resolution video stream).
Parameters
statsStatistics of the local video stream. See LocalVideoStats.

◆ onRemoteVideoStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoStats
inline

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.

Parameters
statsStatistics of the remote video stream. See RemoteVideoStats.

◆ onConnectionLost() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onConnectionLost
inline

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.

◆ onConnectionInterrupted() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted
inline

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.

◆ onConnectionBanned() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onConnectionBanned
inline

Occurs when your connection is banned by the Agora Server.

◆ onStreamMessage() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onStreamMessage
inline

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.

Parameters
userIdID of the user who sends the data stream.
streamIdThe ID of the stream data.
dataThe data stream.
lengthThe length (byte) of the data stream.
sentTsThe time of the data stream sent.

◆ onStreamMessageError() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onStreamMessageError
inline

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.

Parameters
userIdID of the user who sends the data stream.
streamIdThe ID of the stream data.
codeThe error code: ERROR_CODE_TYPE.
missedThe number of lost messages.
cachedThe number of incoming cached messages when the data stream is interrupted.

◆ onRequestToken() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRequestToken
inline

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.

See also
How to generate a token.

◆ onTokenPrivilegeWillExpire() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onTokenPrivilegeWillExpire
inline

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.

See also
How to generate a token.
Parameters
tokenThe token that will expire in 30 seconds.

◆ onFirstLocalAudioFramePublished() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFramePublished
inline

Occurs when the first local audio frame is published.

Parameters
elapsedThe time elapsed (ms) from the local user calling joinChannel to the SDK triggers this callback.

◆ onLocalAudioStateChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onLocalAudioStateChanged
inline

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.

Note
When the state is LOCAL_AUDIO_STREAM_STATE_FAILED (3), see the error parameter for details.
Parameters
stateState of the local audio. See LOCAL_AUDIO_STREAM_STATE.
errorThe error information of the local audio. See LOCAL_AUDIO_STREAM_ERROR.

◆ onRemoteAudioStateChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioStateChanged
inline

Occurs when the remote audio state changes.

This callback indicates the state change of the remote audio stream.

Parameters
uidID of the remote user whose audio state changes.
stateState of the remote audio. See REMOTE_AUDIO_STATE.
reasonThe reason of the remote audio state change. See REMOTE_AUDIO_STATE_REASON.
elapsedTime elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.

◆ onActiveSpeaker() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onActiveSpeaker
inline

Occurs when an active speaker is detected.

If you have called the enableAudioVolumeIndication() method, this callback is triggered when the volume detecting unit has detected an active speaker in the channel. This callback also returns the uid of the active speaker.

You can add relative functions on your app, for example, the active speaker, once detected, will have the portrait zoomed in.

Note
  • You need to call enableAudioVolumeIndication() to receive this callback.
  • The active speaker means the user ID of the speaker who speaks at the highest volume during a certain period of time.
Parameters
uidThe ID of the active speaker. A uid of 0 means the local user.

◆ onClientRoleChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onClientRoleChanged
inline

Occurs when the user role in a Live-Broadcast channel has switched, for example, from a broadcaster to an audience or vice versa.

Parameters
oldRoleThe old role of the user: CLIENT_ROLE_TYPE.
newRoleThe new role of the user: CLIENT_ROLE_TYPE.

◆ onRemoteAudioTransportStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats
inline

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.

Parameters
uidID of the remote user whose audio data packet is received.
delayThe network time delay (ms) from the remote user sending the audio packet to the local user.
lostThe Packet loss rate (%) of the audio packet sent from the remote user.
rxKBitRateReceived bitrate (Kbps) of the audio packet sent from the remote user.

◆ onRemoteVideoTransportStats() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats
inline

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.

Parameters
uidID of the remote user whose video packet is received.
delayThe network time delay (ms) from the remote user sending the video packet to the local user.
lostThe packet loss rate (%) of the video packet sent from the remote user.
rxKBitRateThe Received bitrate (Kbps) of the video packet sent from the remote user.

◆ onConnectionStateChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onConnectionStateChanged
inline

Occurs when the connection state of the SDK to the server is changed.

Parameters
stateSee CONNECTION_STATE_TYPE.
reasonSee CONNECTION_CHANGED_REASON_TYPE.

◆ onNetworkTypeChanged() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onNetworkTypeChanged
inline

Occurs when the network type is changed.

Parameters
typeSee NETWORK_TYPE.

◆ onEncryptionError() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onEncryptionError
inline

Reports the error type of encryption.

Parameters
typeSee ENCRYPTION_ERROR_TYPE.

◆ onUserAccountUpdated() [2/2]

virtual void agora::rtc::IRtcEngineEventHandler::onUserAccountUpdated
inline

◆ onAudioSubscribeStateChanged()

virtual void agora::rtc::IRtcEngineEventHandler::onAudioSubscribeStateChanged
inline

Occurs when the audio subscribe state changed.

Parameters
channelThe channel name of user joined.
uidThe remote user ID that is subscribed to.
oldStateThe old state of the audio stream subscribe : STREAM_SUBSCRIBE_STATE.
newStateThe new state of the audio stream subscribe : STREAM_SUBSCRIBE_STATE.
elapseSinceLastStateThe time elapsed (ms) from the old state to the new state.

◆ onVideoSubscribeStateChanged()

virtual void agora::rtc::IRtcEngineEventHandler::onVideoSubscribeStateChanged
inline

Occurs when the video subscribe state changed.

Parameters
channelThe channel name of user joined.
uidThe remote user ID that is subscribed to.
oldStateThe old state of the video stream subscribe : STREAM_SUBSCRIBE_STATE.
newStateThe new state of the video stream subscribe : STREAM_SUBSCRIBE_STATE.
elapseSinceLastStateThe time elapsed (ms) from the old state to the new state.

◆ onAudioPublishStateChanged()

virtual void agora::rtc::IRtcEngineEventHandler::onAudioPublishStateChanged
inline

Occurs when the audio publish state changed.

Parameters
channelThe channel name of user joined.
oldStateThe old state of the audio stream publish : STREAM_PUBLISH_STATE.
newStateThe new state of the audio stream publish : STREAM_PUBLISH_STATE.
elapseSinceLastStateThe time elapsed (ms) from the old state to the new state.

◆ onVideoPublishStateChanged()

virtual void agora::rtc::IRtcEngineEventHandler::onVideoPublishStateChanged
inline

Occurs when the video publish state changed.

Parameters
channelThe channel name of user joined.
oldStateThe old state of the video stream publish : STREAM_PUBLISH_STATE.
newStateThe new state of the video stream publish : STREAM_PUBLISH_STATE.
elapseSinceLastStateThe time elapsed (ms) from the old state to the new state.