RTCRoomEventHandler class

Room event callbacks.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onAudioStreamBanned ↔ OnAudioStreamBannedType?

This callback is triggered by calling the OpenAPI BanUserStream/UnbanUserStream to disable/enable the specified user publishing audio streams in the specified room.

getter/setter pair

onAVSyncStateChange ↔ OnAVSyncStateChangeType?

Stream publisher will receive this callback when the A/V synchronization state changes after RTCRoom.setMultiDeviceAVSync is called.

getter/setter pair

onForwardStreamEvent ↔ OnForwardStreamEventType?

Callback about events during relaying media streams across rooms.

getter/setter pair

onForwardStreamStateChanged ↔ OnForwardStreamStateChangedType?

Callback about the state and errors during relaying media streams across rooms.

getter/setter pair

onLeaveRoom ↔ OnLeaveRoomType?

Callback about successfully leaving the room.

getter/setter pair

onLocalStreamStats ↔ OnLocalStreamStatsType?

Callback about the statistics of audio/video streams sent by the local device during the call and the network status, which is triggered every 2s.

getter/setter pair

onNetworkQuality ↔ OnNetworkQualityType?

After the user joins the room, this callback will report the user's network quality information every 2 seconds.

getter/setter pair

onPublishPrivilegeTokenWillExpire ↔ EmptyCallbackType?

Callback triggered 30s before the publishing privilege of the Token expires.
After receiving this callback, you must call RTCRoom.updateToken to update the publishing privilege Token.

getter/setter pair

onRemoteStreamStats ↔ OnRemoteStreamStatsType?

Callback about the statistics of the local device receiving the subscribed remote audio/video streams during the call and the network status, which is triggered every 2s.

getter/setter pair

onRoomBinaryMessageReceived ↔ OnBinaryMessageReceivedType?

This callback is triggered after the local user receives a in-room broadcast binary message.

getter/setter pair

onRoomExtraInfoUpdate ↔ OnRoomExtraInfoUpdateType?

Valid since v3.56.1

getter/setter pair

onRoomMessageReceived ↔ OnMessageReceivedType?

This callback is triggered after the local user receives a in-room broadcast text message.

getter/setter pair

onRoomMessageSendResult ↔ OnRoomMessageSendResultType?

This callback is triggered after the local user sends a message to all the other users in the room.

getter/setter pair

onRoomStateChanged ↔ OnRoomStateChangedType?

Callback about room state changes.

getter/setter pair

onRoomStats ↔ OnRoomStatsType?

In-room call statistics callback.

getter/setter pair

onSetRoomExtraInfoResult ↔ OnSetRoomExtraInfoResultType?

Valid since v3.56.1

getter/setter pair

onStreamStateChanged ↔ OnRoomStateChangedType?

Callback about stream state changes.

getter/setter pair

onSubscribePrivilegeTokenWillExpire ↔ EmptyCallbackType?

Callback triggered 30s before the subscribing privilege of the Token expires.

getter/setter pair

onTokenWillExpire ↔ EmptyCallbackType?

The callback will be triggered 30 seconds before the Token expires.

getter/setter pair

onUserBinaryMessageReceived ↔ OnBinaryMessageReceivedType?

This callback is triggered after the local user receives a binary message from the other users in the room.

getter/setter pair

onUserJoined ↔ OnUserJoinedType?

Callback about remote users joining the room.

getter/setter pair

onUserLeave ↔ OnUserLeaveType?

Callback about remote users leaving the room.

getter/setter pair

onUserMessageReceived ↔ OnMessageReceivedType?

This callback is triggered after the local user receives a text message from the other users in the room.

getter/setter pair

onUserMessageSendResult ↔ OnMessageSendResultType?

This callback is triggered after the local user sends a message to another user in the room.

getter/setter pair

onUserPublishScreen ↔ OnUserPublishStreamType?

Callback about new screen sharing media streams from remote users in the room.

getter/setter pair

onUserPublishStream ↔ OnUserPublishStreamType?

Callback about new media streams captured by camera/microphone in the room.

getter/setter pair

onUserUnpublishScreen ↔ OnUserUnpublishStreamType?

Callback about the removal of screen sharing media streams from remote users in the room.

getter/setter pair

onUserUnpublishStream ↔ OnUserUnpublishStreamType?

Callback about the removal of remote media stream captured by camera/microphone.

getter/setter pair

onUserVisibilityChanged ↔ OnUserVisibilityChangedType?

Valid since v3.56.1

getter/setter pair

onVideoStreamBanned ↔ OnVideoStreamBannedType?

This callback is triggered by calling the OpenAPI BanUserStream/UnbanUserStream to disable/enable the specified user publishing video streams in the specified room.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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