setRoomExtraInfo method
@valid since 3.52
@detail api
@author lichangfeng.rtc
@brief 设置/更新 RTC 房间附加信息,可用于标识房间状态或属性,或灵活实现各种业务逻辑。
@param key 房间附加信息键值,长度小于 10 字节。
同一房间内最多可存在 5 个 key,超出则会从第一个 key 起进行替换。
@param value 房间附加信息内容,长度小于 128 字节。
@return
- 0: 方法调用成功,返回本次调用的任务编号;
- <0: 方法调用失败,具体原因详见 SetRoomExtraInfoResult{@link #SetRoomExtraInfoResult}。
@note
- 在设置房间附加信息前,必须先调用 joinRoom{@link #RTCRoom#joinRoom} 加入房间。
- 调用该方法后,会收到一次 onSetRoomExtraInfoResult{@link #IRTCRoomEventHandler#onSetRoomExtraInfoResult} 回调,提示设置结果。
- 调用该方法成功设置附加信息后,同一房间内的其他用户会收到关于该信息的回调 onRoomExtraInfoUpdate{@link #IRTCRoomEventHandler#onRoomExtraInfoUpdate}。
- 新进房的用户会收到进房前房间内已有的全部附加信息通知。
Implementation
Future<int?> setRoomExtraInfo(
{required string key, required string value}) async {
$a() => ($instance as $p_a.RTCRoom).setRoomExtraInfo(key, value);
$i() => ($instance as $p_i.ByteRTCRoom).setRoomExtraInfo(key, value);
if (Platform.isAndroid) {
return $a();
} else if (Platform.isIOS) {
return $i();
} else {
throw UnsupportedError(
'Not Support Platform ${Platform.operatingSystem}');
}
}