AgoraEventHandlers class

Constructors

AgoraEventHandlers({dynamic warning(WarningCode)?, dynamic apiCallExecuted(ErrorCode, String, String)?, dynamic rejoinChannelSuccess(String, int, int)?, dynamic localUserRegistered(int, String)?, dynamic userInfoUpdated(int, UserInfo)?, dynamic clientRoleChanged(ClientRole, ClientRole)?, dynamic connectionStateChanged(ConnectionStateType, ConnectionChangedReason)?, dynamic networkTypeChanged(NetworkType)?, dynamic connectionLost()?, dynamic requestToken()?, dynamic audioVolumeIndication(List<AudioVolumeInfo>, int)?, dynamic firstLocalAudioFrame(int)?, dynamic firstLocalVideoFrame(int, int, int)?, dynamic userMuteVideo(int, bool)?, dynamic videoSizeChanged(int, int, int, int)?, dynamic localPublishFallbackToAudioOnly(bool)?, dynamic remoteSubscribeFallbackToAudioOnly(int, bool)?, dynamic audioRouteChanged(AudioOutputRouting)?, dynamic cameraFocusAreaChanged(Rect)?, dynamic cameraExposureAreaChanged(Rect)?, dynamic facePositionChanged(int, int, List<FacePositionInfo>)?, dynamic rtcStats(RtcStats)?, dynamic lastmileQuality(NetworkQuality)?, dynamic networkQuality(int, NetworkQuality, NetworkQuality)?, dynamic lastmileProbeResult(LastmileProbeResult)?, dynamic localVideoStats(LocalVideoStats)?, dynamic localAudioStats(LocalAudioStats)?, dynamic remoteVideoStats(RemoteVideoStats)?, dynamic remoteAudioStats(RemoteAudioStats)?, dynamic audioMixingFinished()?, dynamic audioMixingStateChanged(AudioMixingStateCode, AudioMixingReason)?, dynamic audioEffectFinished(int)?, dynamic rtmpStreamingStateChanged(String, RtmpStreamingState, RtmpStreamingErrorCode)?, dynamic transcodingUpdated()?, dynamic streamInjectedStatus(String, int, InjectStreamStatus)?, dynamic streamMessage(int, int, String)?, dynamic streamMessageError(int, int, ErrorCode, int, int)?, dynamic mediaEngineLoadSuccess()?, dynamic mediaEngineStartCallSuccess()?, dynamic channelMediaRelayStateChanged(ChannelMediaRelayState, ChannelMediaRelayError)?, dynamic channelMediaRelayEvent(ChannelMediaRelayEvent)?, dynamic metadataReceived(String, int, int)?, dynamic firstLocalAudioFramePublished(int)?, dynamic firstLocalVideoFramePublished(int)?, dynamic audioPublishStateChanged(String, StreamPublishState, StreamPublishState, int)?, dynamic videoPublishStateChanged(String, StreamPublishState, StreamPublishState, int)?, dynamic audioSubscribeStateChanged(String, int, StreamSubscribeState, StreamSubscribeState, int)?, dynamic videoSubscribeStateChanged(String, int, StreamSubscribeState, StreamSubscribeState, int)?, dynamic rtmpStreamingEvent(String, RtmpStreamingEvent)?, dynamic userSuperResolutionEnabled(int, bool, SuperResolutionStateReason)?, dynamic uploadLogResult(String, bool, UploadErrorReason)?, dynamic userJoined(int uid, int elapsed)?, dynamic joinChannelSuccess(String channel, int uid, int elapsed)?, dynamic onError(ErrorCode errorCode)?, dynamic activeSpeaker(int uid)?, dynamic leaveChannel(RtcStats stats)?, dynamic localAudioStateChanged(AudioLocalState state, AudioLocalError error)?, dynamic localVideoStateChanged(LocalVideoStreamState localVideoState, LocalVideoStreamError error)?, dynamic remoteAudioStateChanged(int uid, AudioRemoteState state, AudioRemoteStateReason reason, int elapsed)?, dynamic remoteVideoStateChanged(int uid, VideoRemoteState state, VideoRemoteStateReason reason, int elapsed)?, dynamic tokenPrivilegeWillExpire(String token)?, dynamic userOffline(int uid, UserOfflineReason reason)?})
const

Properties

activeSpeaker → dynamic Function(int uid)?
Reports which user is the loudest speaker.
final
apiCallExecuted → dynamic Function(ErrorCode, String, String)?
Occurs when an API method is executed.
final
audioEffectFinished → dynamic Function(int)?
Occurs when the audio effect file playback finishes.
final
audioMixingFinished → dynamic Function()?
Occurs when the audio mixing file playback finishes.
final
audioMixingStateChanged → dynamic Function(AudioMixingStateCode, AudioMixingReason)?
Occurs when the playback state of the local user's music file changes.
final
audioPublishStateChanged → dynamic Function(String, StreamPublishState, StreamPublishState, int)?
Occurs when the audio publishing state changes.
final
audioRouteChanged → dynamic Function(AudioOutputRouting)?
Occurs when the local audio playback route changes.
final
audioSubscribeStateChanged → dynamic Function(String, int, StreamSubscribeState, StreamSubscribeState, int)?
Occurs when the audio subscribing state changes.
final
audioVolumeIndication → dynamic Function(List<AudioVolumeInfo>, int)?
Reports which users are speaking and the speakers' volume, and whether the local user is speaking.
final
cameraExposureAreaChanged → dynamic Function(Rect)?
The camera exposure area has changed.
final
cameraFocusAreaChanged → dynamic Function(Rect)?
Occurs when the camera focus area is changed.
final
channelMediaRelayEvent → dynamic Function(ChannelMediaRelayEvent)?
Reports events during the media stream relay.
final
channelMediaRelayStateChanged → dynamic Function(ChannelMediaRelayState, ChannelMediaRelayError)?
Occurs when the state of the media stream relay changes.
final
clientRoleChanged → dynamic Function(ClientRole, ClientRole)?
Occurs when the user role switches in a live broadcast. For example, from a host to an audience or from an audience to a host.
final
connectionLost → dynamic Function()?
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
final
connectionStateChanged → dynamic Function(ConnectionStateType, ConnectionChangedReason)?
Occurs when the network connection state changes.
final
facePositionChanged → dynamic Function(int, int, List<FacePositionInfo>)?
Reports the face detection result of the local user.
final
firstLocalAudioFrame → dynamic Function(int)?
Occurs when the first local audio frame is sent.
final
firstLocalAudioFramePublished → dynamic Function(int)?
Occurs when the first audio frame is published.
final
firstLocalVideoFrame → dynamic Function(int, int, int)?
Occurs when the first local video frame is rendered.
final
firstLocalVideoFramePublished → dynamic Function(int)?
Occurs when the first video frame is published.
final
hashCode → int
The hash code for this object.
no setterinherited
joinChannelSuccess → dynamic Function(String channel, int uid, int elapsed)?
Occurs when the local user joins a specified channel.
final
lastmileProbeResult → dynamic Function(LastmileProbeResult)?
Reports the last-mile network probe result.
final
lastmileQuality → dynamic Function(NetworkQuality)?
Reports the last mile network quality of the local user once every two seconds before the user joins the channel.
final
leaveChannel → dynamic Function(RtcStats stats)?
Occurs when a user leaves the channel.
final
localAudioStateChanged → dynamic Function(AudioLocalState state, AudioLocalError error)?
Occurs when the local audio state changes.
final
localAudioStats → dynamic Function(LocalAudioStats)?
Reports the statistics of the local audio stream.
final
localPublishFallbackToAudioOnly → dynamic Function(bool)?
Occurs when the published media stream falls back to an audio-only stream due to poor network conditions or switches back to video stream after the network conditions improve.
final
localUserRegistered → dynamic Function(int, String)?
Occurs when the local user registers a user account.
final
localVideoStateChanged → dynamic Function(LocalVideoStreamState localVideoState, LocalVideoStreamError error)?
Occurs when the local video state changes.
final
localVideoStats → dynamic Function(LocalVideoStats)?
Reports the statistics of the local video streams.
final
mediaEngineLoadSuccess → dynamic Function()?
Occurs when the media engine is loaded.
final
mediaEngineStartCallSuccess → dynamic Function()?
Occurs when the media engine starts.
final
metadataReceived → dynamic Function(String, int, int)?
Occurs when the local user receives the metadata.
final
networkQuality → dynamic Function(int, NetworkQuality, NetworkQuality)?
Reports the last mile network quality of each user in the channel once every two seconds.
final
networkTypeChanged → dynamic Function(NetworkType)?
Occurs when the network type changes.
final
onError → dynamic Function(ErrorCode errorCode)?
Reports an error during SDK runtime
final
rejoinChannelSuccess → dynamic Function(String, int, int)?
Occurs when a user rejoins the channel after being disconnected due to network problems.
final
remoteAudioStateChanged → dynamic Function(int uid, AudioRemoteState state, AudioRemoteStateReason reason, int elapsed)?
Occurs when the remote audio state changes.
final
remoteAudioStats → dynamic Function(RemoteAudioStats)?
Reports the statistics of the audio stream from each remote user/host.
final
remoteSubscribeFallbackToAudioOnly → dynamic Function(int, bool)?
Occurs when the remote media stream falls back to audio-only stream due to poor network conditions or switches back to video stream after the network conditions improve.
final
remoteVideoStateChanged → dynamic Function(int uid, VideoRemoteState state, VideoRemoteStateReason reason, int elapsed)?
Occurs when the remote video state changes.
final
remoteVideoStats → dynamic Function(RemoteVideoStats)?
Reports the statistics of the video stream from each remote user/host.
final
requestToken → dynamic Function()?
Occurs when the token has expired.
final
rtcStats → dynamic Function(RtcStats)?
Reports the statistics of the RtcEngine once every two seconds.
final
rtmpStreamingEvent → dynamic Function(String, RtmpStreamingEvent)?
Reports events during the RTMP or RTMPS streaming.
final
rtmpStreamingStateChanged → dynamic Function(String, RtmpStreamingState, RtmpStreamingErrorCode)?
Occurs when the state of the RTMP or RTMPS streaming changes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamInjectedStatus → dynamic Function(String, int, InjectStreamStatus)?
Reports the status of injecting the online media stream.
final
streamMessage → dynamic Function(int, int, String)?
Occurs when the local user receives a remote data stream.
final
streamMessageError → dynamic Function(int, int, ErrorCode, int, int)?
Occurs when the local user fails to receive a remote data stream.
final
tokenPrivilegeWillExpire → dynamic Function(String token)?
Occurs when the token expires in 30 seconds.
final
transcodingUpdated → dynamic Function()?
Occurs when the publisher's transcoding settings are updated.
final
userInfoUpdated → dynamic Function(int, UserInfo)?
Occurs when the SDK gets the user ID and user account of the remote user.
final
userJoined → dynamic Function(int uid, int elapsed)?
Occurs when a remote user ChannelProfile.Communication/host ChannelProfile.LiveBroadcasting joins the channel
final
userMuteVideo → dynamic Function(int, bool)?
Occurs when a remote user stops/resumes sending the video stream.
final
userOffline → dynamic Function(int uid, UserOfflineReason reason)?
Occurs when a remote user ChannelProfile.Communication/host ChannelProfile.LiveBroadcasting leaves the channel.
final
videoPublishStateChanged → dynamic Function(String, StreamPublishState, StreamPublishState, int)?
Occurs when the video publishing state changes.
final
videoSizeChanged → dynamic Function(int, int, int, int)?
Occurs when the video size or rotation information of a remote user changes.
final
videoSubscribeStateChanged → dynamic Function(String, int, StreamSubscribeState, StreamSubscribeState, int)?
Occurs when the video subscribing state changes.
final
warning → dynamic Function(WarningCode)?
Reports a warning during SDK runtime.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited