setRoomExtraInfo abstract method
设置/更新房间附加信息,可用于标识房间状态或属性,或灵活实现各种业务逻辑。
v3.54 新增。
key
:房间附加信息键值,长度小于 10 字节。
同一房间内最多可存在 5 个 key,超出则会从第一个 key 起进行替换。
value
:房间附加信息内容,长度小于 128 字节。
返回值:
0
:方法调用成功,返回本次调用的任务编号;<0
:方法调用失败,具体原因详见 SetRoomExtraInfoResult。
注意:
- 在设置房间附加信息前,必须先调用 RTCRoom.joinRoom 加入房间。
- 调用该方法后,会收到一次 RTCRoomEventHandler.onSetRoomExtraInfoResult 回调,提示设置结果。
- 调用该方法成功设置附加信息后,同一房间内的其他用户会收到关于该信息的回调 RTCRoomEventHandler.onRoomExtraInfoUpdate。
- 新进房的用户会收到进房前房间内已有的全部附加信息通知。
Implementation
Future<int?> setRoomExtraInfo({
required String key,
required String value,
});