文档概览/
Live/
SDK/
iOS/
API Usage Guide/
Advanced Features/
Live Room Information Settings/

Live Room Information Settings

本文档主要介绍如何使用 RTC Room Engine SDK 实现设置直播间信息的相关功能。

前提条件

在使用 RTC RoomEngine SDK 前，您需要先调用 登录 SDK，以便后续功能正常使用。
只有当您是主播时，设置的直播间信息才会生效。您可以参见 音频开播 或 视频开播 来完成直播间的创建。

使用指引

iOS
Android
您需要准备好需要设置的参数TUILiveInfo，接下来进行详细介绍：
参数：TUILiveInfo
TUILiveInfo 由很多的字段构成，但通常您只需要关心如下几个字段的填写：
参数名称
类型
描述
activityStatus
Int
直播间活跃状态：用户自定义标记
backgroundUrl
String
直播间背景，最大支持 200 个字节
categoryList
List<Int>
直播间分类标签，单个房间最大支持3个标记
coverUrl
String
直播间封面，最大支持 200 个字节
isPublicVisible
Bool
直播间是否公开，设置为 true 后即可在 房间列表 中被显示
在准备好 TUILiveInfo 之后，便可以通过调用setLiveInfo接口设置直播间信息。
您需要准备好需要设置的参数LiveInfo，接下来进行详细介绍：
参数：LiveInfo
LiveInfo 由很多的字段构成，但通常您只需要关心如下几个字段的填写：
参数名称
类型
描述
activityStatus
Int
直播间活跃状态: 用户自定义标记
backgroundUrl
String
直播间背景，最大支持 200 个字节
categoryList
List<Int>
直播间分类标签，单个房间最大支持3个标记
coverUrl
String
直播间封面，最大支持 200 个字节
isPublicVisible
Bool
直播间是否公开，设置为 true 后即可 在房间列表中被显示
在准备好 TUILiveInfo 之后，便可以通过调用setLiveInfo接口设置直播间信息。
示例：
iOS
Android
import RTCRoomEngine

let roomEngine = TUIRoomEngine.sharedInstance()
let liveListManager = roomEngine.getExtension(extensionType: .liveListManager) as? TUILiveListManager

let liveInfo = TUILiveInfo()
liveInfo.backgroundUrl = "backgroundUrl"   // 替换为您需要的直播间背景图片
liveInfo.coverUrl = "coverUrl"             // 替换为您需要的直播间封面图片
liveInfo.isPublicVisible = true            // 直播间公开
liveInfo.categoryList = [1, 2]             // 可替换为您业务中的直播间分类

let modifyFlag: TUILiveModifyFlag = [.backgroundUrl, .coverUrl, .publish, .category]  // 这里为您所修改的类别

liveListManager?.setLiveInfo(liveInfo, modifyFlag: modifyFlag) {
    // 设置直播间信息成功
} onError: { code, message in
    // 设置直播间信息失败
}
TUIRoomEngine roomEngine = TUIRoomEngine.sharedInstance();
TUILiveListManager liveListManager = (TUILiveListManager) roomEngine.getExtension(TUICommonDefine.ExtensionType.LIVE_LIST_MANAGER);

TUILiveListManager.LiveInfo liveInfo = new TUILiveListManager.LiveInfo();
liveInfo.backgroundUrl = "backgroundUrl";                      // 替换为您需要的直播间背景图片
liveInfo.coverUrl = "coverUrl";                                // 替换为您需要的直播间封面图片
liveInfo.isPublicVisible = true;                               // 直播间公开
liveInfo.categoryList =new ArrayList<>(Arrays.asList(1, 2));   // 可替换为您业务中的直播间分类


List<TUILiveListManager.LiveModifyFlag> modifyFlag  =  new ArrayList<>();
// 下面为您所修改的类别
modifyFlag.add(TUILiveListManager.LiveModifyFlag.BACKGROUND_URL);
modifyFlag.add(TUILiveListManager.LiveModifyFlag.COVER_URL);
modifyFlag.add(TUILiveListManager.LiveModifyFlag.PUBLISH);
modifyFlag.add(TUILiveListManager.LiveModifyFlag.CATEGORY);
liveListManager.setLiveInfo(liveInfo, modifyFlag, new TUIRoomDefine.ActionCallback() {
    @Override
    public void onSuccess() {
        // 设置直播间信息成功
    }
    @Override
    public void onError(TUICommonDefine.Error error, String message) {
        // 设置直播间信息失败
    }
});