RtcChannelEventHandler class Null safety
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. [...]
read / write
- audioPublishStateChanged ↔ StreamPublishStateCallback?
-
Occurs when the audio publishing state changes. [...]
read / write
- audioSubscribeStateChanged ↔ StreamSubscribeStateCallback?
-
Occurs when the audio subscribing state changes. [...]
read / write
- channelMediaRelayEvent ↔ MediaRelayEventCallback?
-
Reports events during the media stream relay. [...]
read / write
- channelMediaRelayStateChanged ↔ MediaRelayStateCallback?
-
Occurs when the state of the media stream relay changes. [...]
read / write
- clientRoleChanged ↔ ClientRoleCallback?
-
Occurs when the user role switches in a ChannelProfile.LiveBroadcasting channel. For example, from broadcaster to audience or vice versa. [...]
read / write
- connectionLost ↔ EmptyCallback?
-
Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted. [...]
read / write
- connectionStateChanged ↔ ConnectionStateCallback?
-
Occurs when the network connection state changes. [...]
read / write
- error ↔ ErrorCallback?
-
Reports the error code of the RtcChannel instance. [...]
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- joinChannelSuccess ↔ UidWithElapsedAndChannelCallback?
-
Occurs when the local user joins a specified channel. [...]
read / write
- leaveChannel ↔ RtcStatsCallback?
-
Occurs when a user leaves the channel. [...]
read / write
- 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. [...]
read / write
- metadataReceived ↔ MetadataCallback?
-
Occurs when the local user receives the metadata, including the following parameters: [...]
read / write
- networkQuality ↔ NetworkQualityWithUidCallback?
-
Reports the last mile network quality of each user in the channel once every two seconds. [...]
read / write
- rejoinChannelSuccess ↔ UidWithElapsedAndChannelCallback?
-
Occurs when a user rejoins the channel after being disconnected due to network problems. [...]
read / write
- remoteAudioStateChanged ↔ RemoteAudioStateCallback?
-
Occurs when the remote audio state changes. [...]
read / write
- remoteAudioStats ↔ RemoteAudioStatsCallback?
-
Reports the statistics of the audio stream from each remote user/broadcaster. [...]
read / write
- 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. [...]
read / write
- remoteVideoStateChanged ↔ RemoteVideoStateCallback?
-
Occurs when the remote video state changes. [...]
read / write
- 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. [...]
read / write
- requestToken ↔ EmptyCallback?
-
Occurs when the token has expired. [...]
read / write
- rtcStats ↔ RtcStatsCallback?
-
Reports the statistics of the RtcEngine once every two seconds.
The
RtcStatsCallback
typedef includes the following parameter: [...]read / write - rtmpStreamingEvent ↔ RtmpStreamingEventCallback?
-
Reports events during the RTMP or RTMPS streaming. [...]
read / write
- rtmpStreamingStateChanged ↔ RtmpStreamingStateCallback?
-
Occurs when the state of the RTMP or RTMPS streaming changes. [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- streamInjectedStatus ↔ StreamInjectedStatusCallback?
-
Reports the status of injecting the online media stream. [...]
read / write
- streamMessage ↔ StreamMessageCallback?
-
Occurs when the local user receives a remote data stream. [...]
read / write
- streamMessageError ↔ StreamMessageErrorCallback?
-
Occurs when the local user fails to receive a remote data stream. [...]
read / write
- tokenPrivilegeWillExpire ↔ TokenCallback?
-
Occurs when the token expires in 30 seconds. [...]
read / write
- transcodingUpdated ↔ EmptyCallback?
-
Occurs when the publisher's transcoding settings are updated. [...]
read / write
- userJoined ↔ UidWithElapsedCallback?
-
Occurs when a remote user (Communication) or a broadcaster (ChannelProfile.LiveBroadcasting) joins the channel. [...]
read / write
- userOffline ↔ UserOfflineCallback?
-
Occurs when a remote user (ChannelProfile.Communication) or a broadcaster (ChannelProfile.LiveBroadcasting) leaves the channel. [...]
read / write
- videoPublishStateChanged ↔ StreamPublishStateCallback?
-
Occurs when the video publishing state changes. [...]
read / write
- videoSizeChanged ↔ VideoSizeCallback?
-
Occurs when the video size or rotation information of a remote user changes. [...]
read / write
- videoSubscribeStateChanged ↔ StreamSubscribeStateCallback?
-
Occurs when the video subscribing state changes. [...]
read / write
- warning ↔ WarningCallback?
-
Reports the warning code of the RtcChannel instance. [...]
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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