ios_IRTSRoomEventHandler class
Properties
-
$instance
↔ dynamic
-
getter/setter pairinherited
-
$resource
→ NativeResource
-
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
destroy()
→ void
-
inherited
-
emit(String name, List args)
→ dynamic
-
inherited
-
nativeCall<T>(String method, [List? args, NativeMethodMeta? meta])
→ Future<T>
-
Call instance method
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
registerEvent(String name, dynamic method)
→ void
-
inherited
-
rtsRoom$onLeaveRoom(ByteRTCRTSRoom rtsRoom, ByteRTCRoomStats stats)
→ FutureOr<void>
-
@detail callback
@brief Leave the RTS room successfully callback.
After the user call leaveRoom{@link #ByteRTCRTSRoom#leaveRoom}, the SDK will stop sending/receiving broadcast messages in the room and, after releasing all relevant resources, notify the user via this callback that leaving the room was successful.
@param rtsRoom RTSRoom object.
@param stats Reserved parameter.
@note
+ After the user calls the leaveRoom{@link #ByteRTCRTSRoom#leaveRoom} method to leave the room, if destroy{@link #ByteRTCRTSRoom#destroy} is called to destroy the room instance immediately, this callback event will not be received.
+ If the app needs to use the system audio & video device after leaving the room, it is recommended to initialize the audio & video device after receiving this callback, otherwise the initialization may fail due to the SDK occupying the audio & video device.
inherited
-
rtsRoom$onRoomBinaryMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@brief Receive this callback when you receive a broadcast binary message sent by the room call sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage}.
@param rtsRoom ByteRTCRTSRoom object
@param uid Message sender ID.
@param message The binary message content received.
inherited
-
rtsRoom$onRoomBinaryMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief Receive this callback when you receive a broadcast binary message sent by the room call sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage}.
@param rtsRoom ByteRTCRoom object
@param msgid Message number.
@param uid User ID of the message sender.
@param message The binary message content received.
inherited
-
rtsRoom$onRoomMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@brief Receive this callback when you receive a broadcast text message from the room called sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage}.
@param rtsRoom ByteRTCRTSRoom object
@param uid Message sender ID.
@param message The content of the received text message.
inherited
-
rtsRoom$onRoomMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief Receive this callback when you receive a broadcast text message from the room called sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage}.
@param rtsRoom ByteRTCRoom object
@param msgid Message number.
@param uid User ID of the message sender.
@param message The content of the received text message.
inherited
-
rtsRoom$onRoomMessageSendResult$error(ByteRTCRTSRoom rtsRoom, NSInteger msgid, ByteRTCRoomMessageSendResult error)
→ FutureOr<void>
-
@detail callback
@brief After sending a text or binary message to all users in the room, the message sender will receive a callback with the result of the message.
@param rtsRoom ByteRTCRTSRoom object.
@param msgid The ID of this message.
@param error Message sending results. See ByteRTCRoomMessageSendResult{@link #ByteRTCRoomMessageSendResult}
@note
+ You should call sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage} Send a mass text message to the room
+ You should call sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage} Send a mass binary message to the room
inherited
-
@detail callback
@brief Callback on RTS room state changes. Via this callback you get notified of room relating warnings, errors and events. For example, the user joins the room, the user is removed from the room, and so on.
@param rtsRoom RTS room instance.
@param roomId Room ID.
@param uid User ID.
@param state Room state code.
+ 0: Join room success.
+ !0: Failed to join a room, abnormal exit, room-related warnings or errors.
@param extraInfo Extra information.
join_type indicates the type of room the user joins. 0 means the user joins the room for the first time, and 1 means the user rejoins the room.
elapsed indicates the time interval from calling joinRTSRoom:userInfo:{@link #ByteRTCRTSRoom#joinRTSRoom:userInfo} to successfully joining room, in ms.
inherited
-
rtsRoom$onUserBinaryMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@brief Receive a binary message from another user in the room via sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} Receive this callback.
@param rtsRoom ByteRTCRoom object
@param uid The user ID of the sender of the message.
@param message The binary message content received.
inherited
-
rtsRoom$onUserBinaryMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief Receive a binary message from another user in the room via sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} Receive this callback.
@param rtsRoom ByteRTCRoom object
@param msgid Message number.
@param uid The user ID of the sender of the message.
@param message The binary message content received.
inherited
-
rtsRoom$onUserJoined(ByteRTCRTSRoom rtsRoom, ByteRTCUserInfo userInfo)
→ FutureOr<void>
-
@detail callback
@brief When the remote user enters the room for the first time, or reconnects to the room after being disconnected, the other users in the room will receive this callback.
@param rtsRoom ByteRTCRTSRoom object.
@param userInfo For user information. See ByteRTCUserInfo{@link #ByteRTCUserInfo}.
inherited
-
rtsRoom$onUserLeave$reason(ByteRTCRTSRoom rtsRoom, NSString uid, ByteRTCUserOfflineReason reason)
→ FutureOr<void>
-
@detail callback
@brief This callback is triggered when a remote user is disconnected or turns invisible.
@param rtsRoom ByteRTCRTSRoom object.
@param uid ID of the user who leaves the room, or switches to invisible.
@param reason Reason to leave the room. See ByteRTCUserOfflineReason{@link #ByteRTCUserOfflineReason}.
inherited
-
rtsRoom$onUserMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@brief Receive text messages (P2P) from other users in the room via sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config}.
@param rtsRoom ByteRTCRoom object
@param uid The user ID of the sender of the message.
@param message The content of the received text message.
inherited
-
rtsRoom$onUserMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief Receive text messages (P2P) from other users in the room via sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config}.
@param rtsRoom ByteRTCRoom object
@param msgid Message number.
@param uid The user ID of the sender of the message.
@param message The content of the received text message.
inherited
-
rtsRoom$onUserMessageSendResult$error(ByteRTCRTSRoom rtsRoom, NSInteger msgid, ByteRTCUserMessageSendResult error)
→ FutureOr<void>
-
@detail callback
@brief After sending a text or binary message (P2P) to a single user in the room, the message sender will receive a callback with the result of the message.
@param rtsRoom ByteRTCRoom object.
@param msgid The ID of this message.
@param error Message result. See ByteRTCUserMessageSendResult{@link #ByteRTCUserMessageSendResult}
@note
- You should call sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config} to send a text message to a single user in the room
- You should call sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} to send a binary message to a single user in the room
inherited
-
sendInstanceGet<T>(String property)
→ Future<T>
-
Get instance property
inherited
-
sendInstancePropertiesGet(dynamic nativeClass)
→ Future<Map<String, dynamic>>
-
Get instance properties
inherited
-
sendInstanceSet(String property, dynamic value)
→ Future<void>
-
Set instance property
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateInstance(dynamic instance)
→ void
-
inherited
-
updateResource(NativeResource resource)
→ void
-
inherited
