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

Inherits agora::rtc::IRtcEngineEventHandlerEx.

Public Member Functions

virtual const char * eventHandlerType () const
 
virtual bool onEvent (RTC_EVENT evt, std::string *payload)
 
- Public Member Functions inherited from agora::rtc::IRtcEngineEventHandlerEx
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()

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

◆ onEvent()

virtual bool agora::rtc::IRtcEngineEventHandlerInternal::onEvent ( RTC_EVENT  evt,
std::string *  payload 
)
inlinevirtual