ByteRTCRTSRoomDelegate class
- Inheritance
-
- Object
- NativeClass
- NativeObserverClass
- ByteRTCRTSRoomDelegate
- Implementers
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 离开 RTS 房间成功回调。
用户调用 leaveRoom{@link #ByteRTCRTSRoom#leaveRoom} 方法后,SDK 会停止房间内消息的收发,并在释放所有相关资源后,通过此回调通知用户离开房间成功。
@param rtsRoom RTSRoom 对象。
@param stats 保留参数,目前为空。
@note
+ 用户调用 leaveRoom{@link #ByteRTCRTSRoom#leaveRoom} 方法离开房间后,如果立即调用 destroy{@link #ByteRTCRTSRoom#destroy} 销毁房间实例,则将无法收到此回调事件。
+ 离开房间结束通话后,如果 App 需要使用系统音视频设备,则建议在收到此回调后再初始化音视频设备,否则可能由于 SDK 占用了导致 App 初始化音视频设备失败。
-
rtsRoom$onRoomBinaryMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@brief 收到房间中调用 sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage} 发送的广播二进制消息时,收到此回调。
@param rtsRoom ByteRTCRTSRoom 对象
@param uid 消息发送者 ID 。
@param message 收到的二进制消息内容。
-
rtsRoom$onRoomBinaryMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief 收到房间内广播二进制消息的回调。
房间内其他用户调用 sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage} 发送的广播二进制消息时,收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param msgid 消息编号。
@param uid 消息发送者 ID 。
@param message 收到的二进制消息内容。
-
rtsRoom$onRoomMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@brief 收到房间中调用 sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage} 发送的广播文本消息时,收到此回调。
@param rtsRoom ByteRTCRTSRoom 对象
@param uid 消息发送者 ID 。
@param message 收到的文本消息内容。
-
rtsRoom$onRoomMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief 收到房间中调用 sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage} 发送的广播文本消息时,收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param msgid 消息编号。
@param uid 消息发送者 ID 。
@param message 收到的文本消息内容。
-
rtsRoom$onRoomMessageSendResult$error(ByteRTCRTSRoom rtsRoom, NSInteger msgid, ByteRTCRoomMessageSendResult error)
→ FutureOr<void>
-
@detail callback
@brief 向房间内所有用户群发文本或二进制消息后,消息发送方会收到该消息发送结果回调。
@param rtsRoom ByteRTCRTSRoom 对象。
@param msgid 本条消息的 ID。
@param error 消息发送结果,详见 ByteRTCRoomMessageSendResult{@link #ByteRTCRoomMessageSendResult}
@note
+ 你应调用 sendRoomMessage:{@link #ByteRTCRTSRoom#sendRoomMessage} 向房间内群发文本消息
+ 你应调用 sendRoomBinaryMessage:{@link #ByteRTCRTSRoom#sendRoomBinaryMessage} 向房间内群发二进制消息
-
@detail callback
@brief RTS 房间状态改变回调,加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。
@param rtsRoom RTS 房间实例。
@param roomId 房间 ID。
@param uid 用户 ID。
@param state 房间状态码。
+ 0: 加入房间成功。
+ !0: 加入房间失败、异常退房、发生房间相关的警告或错误。
@param extraInfo 额外信息,如 {"elapsed":1187,"join_type":0}。
- join_type 表示加入房间的类型,0为首次进房,1为重连进房。
- elapsed 表示加入房间耗时,即本地用户从调用 joinRTSRoom:userInfo:{@link #ByteRTCRTSRoom#joinRTSRoom:userInfo} 到加入 RTS 房间成功所经历的时间间隔,单位为 ms。
-
rtsRoom$onUserBinaryMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@brief 收到来自房间中其他用户通过 sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} 发来的点对点二进制消息时,会收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param uid 消息发送者的用户 ID。
@param message 收到的二进制消息内容。
-
rtsRoom$onUserBinaryMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSData message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief 收到来自房间中其他用户通过 sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} 发来的点对点二进制消息时,会收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param msgid 消息编号.
@param uid 消息发送者的用户 ID。
@param message 收到的二进制消息内容。
-
rtsRoom$onUserJoined(ByteRTCRTSRoom rtsRoom, ByteRTCUserInfo userInfo)
→ FutureOr<void>
-
@detail callback
@brief 远端用户首次进房,或断网后重新连入房间时,房间内其他用户将收到该事件。
@param rtsRoom ByteRTCRTSRoom 对象。
@param userInfo 用户信息,参看 ByteRTCUserInfo{@link #ByteRTCUserInfo}。
-
rtsRoom$onUserLeave$reason(ByteRTCRTSRoom rtsRoom, NSString uid, ByteRTCUserOfflineReason reason)
→ FutureOr<void>
-
@detail callback
@brief 远端用户离开 RTS 房间时,本地用户会收到此事件。
@param rtsRoom ByteRTCRTSRoom 对象。
@param uid 离开房间的远端用户 ID 。
@param reason 用户离开房间的原因,参看 ByteRTCUserOfflineReason{@link #ByteRTCUserOfflineReason}。
-
rtsRoom$onUserMessageReceived$message(ByteRTCRTSRoom rtsRoom, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@brief 收到来自房间中其他用户通过 sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config} 发来的点对点文本消息时,会收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param uid 消息发送者的用户 ID。
@param message 收到的文本消息内容。
-
rtsRoom$onUserMessageReceived$uid$message(ByteRTCRTSRoom rtsRoom, NSInteger msgid, NSString uid, NSString message)
→ FutureOr<void>
-
@detail callback
@author hanchenchen.c
@brief 收到来自房间中其他用户通过 sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config} 发来的点对点文本消息时,会收到此回调。
@param rtsRoom ByteRTCRoom 对象
@param msgid 消息编号。
@param uid 消息发送者的用户 ID。
@param message 收到的文本消息内容。
-
rtsRoom$onUserMessageSendResult$error(ByteRTCRTSRoom rtsRoom, NSInteger msgid, ByteRTCUserMessageSendResult error)
→ FutureOr<void>
-
@detail callback
@brief 向房间内单个用户发送文本或二进制消息后(P2P),消息发送方会收到该消息发送结果回调。
@param rtsRoom ByteRTCRoom 对象。
@param msgid 本条消息的 ID。
@param error 消息发送结果,详见 ByteRTCUserMessageSendResult{@link #ByteRTCUserMessageSendResult}
@note
- 你应调用 sendUserMessage:message:config:{@link #ByteRTCRTSRoom#sendUserMessage:message:config} 向房间内单个用户发送文本消息
- 你应调用 sendUserBinaryMessage:message:config:{@link #ByteRTCRTSRoom#sendUserBinaryMessage:message:config} 向房间内单个用户发送二进制消息
-
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