RtcChannelEventHandler class

The RtcChannelEvents interface.

Constructors

RtcChannelEventHandler({WarningCallback? warning, ErrorCallback? error, UidWithElapsedAndChannelCallback? joinChannelSuccess, UidWithElapsedAndChannelCallback? rejoinChannelSuccess, RtcStatsCallback? leaveChannel, ClientRoleCallback? clientRoleChanged, UidWithElapsedCallback? userJoined, UserOfflineCallback? userOffline, ConnectionStateCallback? connectionStateChanged, EmptyCallback? connectionLost, TokenCallback? tokenPrivilegeWillExpire, EmptyCallback? requestToken, UidCallback? activeSpeaker, VideoSizeCallback? videoSizeChanged, RemoteVideoStateCallback? remoteVideoStateChanged, RemoteAudioStateCallback? remoteAudioStateChanged, FallbackCallback? localPublishFallbackToAudioOnly, FallbackWithUidCallback? remoteSubscribeFallbackToAudioOnly, RtcStatsCallback? rtcStats, NetworkQualityWithUidCallback? networkQuality, RemoteVideoStatsCallback? remoteVideoStats, RemoteAudioStatsCallback? remoteAudioStats, RtmpStreamingStateCallback? rtmpStreamingStateChanged, EmptyCallback? transcodingUpdated, StreamInjectedStatusCallback? streamInjectedStatus, StreamMessageCallback? streamMessage, StreamMessageErrorCallback? streamMessageError, MediaRelayStateCallback? channelMediaRelayStateChanged, MediaRelayEventCallback? channelMediaRelayEvent, MetadataCallback? metadataReceived, StreamPublishStateCallback? audioPublishStateChanged, StreamPublishStateCallback? videoPublishStateChanged, StreamSubscribeStateCallback? audioSubscribeStateChanged, StreamSubscribeStateCallback? videoSubscribeStateChanged, RtmpStreamingEventCallback? rtmpStreamingEvent, UserSuperResolutionEnabledCallback? userSuperResolutionEnabled})

Constructs a RtcChannelEventHandler

Properties

activeSpeaker ↔ UidCallback?

Reports which user is the loudest speaker.

getter/setter pair

audioPublishStateChanged ↔ StreamPublishStateCallback?

Occurs when the audio publishing state changes.

getter/setter pair

audioSubscribeStateChanged ↔ StreamSubscribeStateCallback?

Occurs when the audio subscribing state changes.

getter/setter pair

channelMediaRelayEvent ↔ MediaRelayEventCallback?

Reports events during the media stream relay.

getter/setter pair

channelMediaRelayStateChanged ↔ MediaRelayStateCallback?

Occurs when the state of the media stream relay changes.

getter/setter pair

clientRoleChanged ↔ ClientRoleCallback?

Occurs when the user role switches in a ChannelProfile.LiveBroadcasting channel. For example, from broadcaster to audience or vice versa.

getter/setter pair

connectionLost ↔ EmptyCallback?

Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.

getter/setter pair

connectionStateChanged ↔ ConnectionStateCallback?

Occurs when the network connection state changes.

getter/setter pair

error ↔ ErrorCallback?

Reports the error code of the RtcChannel instance.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

joinChannelSuccess ↔ UidWithElapsedAndChannelCallback?

Occurs when the local user joins a specified channel.

getter/setter pair

leaveChannel ↔ RtcStatsCallback?

Occurs when a user leaves the channel.

getter/setter pair

localPublishFallbackToAudioOnly ↔ FallbackCallback?

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.

getter/setter pair

metadataReceived ↔ MetadataCallback?

Occurs when the local user receives the metadata, including the following parameters:

getter/setter pair

networkQuality ↔ NetworkQualityWithUidCallback?

Reports the last mile network quality of each user in the channel once every two seconds.

getter/setter pair

rejoinChannelSuccess ↔ UidWithElapsedAndChannelCallback?

Occurs when a user rejoins the channel after being disconnected due to network problems.

getter/setter pair

remoteAudioStateChanged ↔ RemoteAudioStateCallback?

Occurs when the remote audio state changes.

getter/setter pair

remoteAudioStats ↔ RemoteAudioStatsCallback?

Reports the statistics of the audio stream from each remote user/broadcaster.

getter/setter pair

remoteSubscribeFallbackToAudioOnly ↔ FallbackWithUidCallback?

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.

getter/setter pair

remoteVideoStateChanged ↔ RemoteVideoStateCallback?

Occurs when the remote video state changes.

getter/setter pair

remoteVideoStats ↔ RemoteVideoStatsCallback?

Reports the statistics of the video stream from each remote user/broadcaster. The SDK triggers this callback once every two seconds for each remote user/broadcaster. If a channel includes multiple remote users, the SDK triggers this callback as many times.

getter/setter pair

requestToken ↔ EmptyCallback?

Occurs when the token has expired.

getter/setter pair

rtcStats ↔ RtcStatsCallback?

Reports the statistics of the RtcEngine once every two seconds. The RtcStatsCallback typedef includes the following parameter:

getter/setter pair

rtmpStreamingEvent ↔ RtmpStreamingEventCallback?

Reports events during the RTMP or RTMPS streaming.

getter/setter pair

rtmpStreamingStateChanged ↔ RtmpStreamingStateCallback?

Occurs when the state of the RTMP or RTMPS streaming changes.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

streamInjectedStatus ↔ StreamInjectedStatusCallback?

Reports the status of injecting the online media stream.

getter/setter pair

streamMessage ↔ StreamMessageCallback?

Occurs when the local user receives a remote data stream.

getter/setter pair

streamMessageError ↔ StreamMessageErrorCallback?

Occurs when the local user fails to receive a remote data stream.

getter/setter pair

tokenPrivilegeWillExpire ↔ TokenCallback?

Occurs when the token expires in 30 seconds.

getter/setter pair

transcodingUpdated ↔ EmptyCallback?

Occurs when the publisher's transcoding settings are updated.

getter/setter pair

userJoined ↔ UidWithElapsedCallback?

Occurs when a remote user (Communication) or a broadcaster (ChannelProfile.LiveBroadcasting) joins the channel.

getter/setter pair

userOffline ↔ UserOfflineCallback?

Occurs when a remote user (ChannelProfile.Communication) or a broadcaster (ChannelProfile.LiveBroadcasting) leaves the channel.

getter/setter pair

userSuperResolutionEnabled ↔ UserSuperResolutionEnabledCallback?

Reports whether the super resolution feature is successfully enabled. (beta feature)

getter/setter pair

videoPublishStateChanged ↔ StreamPublishStateCallback?

Occurs when the video publishing state changes.

getter/setter pair

videoSizeChanged ↔ VideoSizeCallback?

Occurs when the video size or rotation information of a remote user changes.

getter/setter pair

videoSubscribeStateChanged ↔ StreamSubscribeStateCallback?

Occurs when the video subscribing state changes.

getter/setter pair

warning ↔ WarningCallback?

Reports the warning code of the RtcChannel instance.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

process(String methodName, List data) → void

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited