创建房间

更新时间: 2024/06/07 15:29:00

房间是 NERoom 产品的基石,搭建应用场景时,您首先需要创建房间。

注意事项

  • 创建房间后,不会自动加入房间,您需要调用接口加入房间。
  • PK 直播房间的保留时长最多为 24 小时,超过 24 小时,NERoom Server会自动删除该房间。
  • 其他业务场景中,房间的保留时长最多为 16 小时,超过 16 小时,NERoom Server会自动删除该房间。
  • 如果您需要延长默认的房间保留时长,请联系网易云信商务经理。

配置步骤

调用 createRoom 接口创建房间。

fun createRoom(params: NECreateRoomParams, options: NECreateRoomOptions, callback: NECallback<Unit>)
  • NECreateRoomParams 相关参数说明如下表所示。

    参数 描述
    roomUuid 房间 ID。房间 ID 需要保证全局唯一。
    最大长度为 64 个字符。
    roomName 房间名。
    最大长度为 64 个字符。
    templateId 模板 ID。类型:int。模板 ID 的值如下:
    • 线上会议:40
    • 互动直播:3
    • 在线K歌:400
    • 语聊房:569
    • 自定义模板:模板 ID获取方法请参见如何获取模板 ID
    password (可选)设置当前房间的密码。如果设置为空,表示用户进入房间时无需密码。
    seatInitParams (可选)设置麦位的初始化配置。包括如下参数:
    • seatCount:麦位数量。默认为 8,最大为 20。
    • seatRequestApprovalMode:麦位申请审批模式。
      • on:观众申请上麦时,需要管理员同意后才能上麦。
      • off(默认):观众申请上麦时,管理员自动同意上麦。
    • seatInvitationConfirmMode:麦位邀请确认模式。
      • on:管理员邀请观众上麦时,需要观众同意后才会上麦。
      • off(默认):管理员邀请观众上麦时,观众自动同意上麦。
    roomExt 房间的扩展信息,用来设置自定义的房间属性。
  • NECreateRoomOptions 相关参数说明如下表所示。

    参数 描述
    enableRtc 设置该房间是否包含音视频通话的功能。
    • true:包含音视频通话功能。
    • false:不包含音视频通话功能。
    默认值:true。
    enableChatroom 设置该房间是否开启即时消息的功能。
    • true:包含即时消息功能。
    • false:不包含即时消息功能。
    默认值:false。
    enableWhiteboard 设置该房间是否包含互动白板的功能。
    • true:包含互动白板功能。
    • false:不包含互动白板功能。
    默认值:false。
    enableRecord 设置该房间是否包含云端录制的功能。
    • true:包含云端录制功能。
    • false:不包含云端录制功能。
    默认值:false。
    enableLive 设置该房间是否包含直播的功能。
    • true:包含直播功能。
    • false:不包含直播功能。
    默认值:false。

示例代码

实现创建房间功能的示例代码如下:

NERoomService roomService = NERoomKit.getInstance().getService(NERoomService.class);
String roomUuid="123";
String roomName="roomName";
int templateId= 21;
String password = "12345";
Map<String,String> initialProperties = new HashMap<String,String>();
initialRoomProperties.put("custom-property-key0", "custom-property-value0");
initialRoomProperties.put("custom-property-key1", "custom-property-value1");
//设置麦位初始化配置
NESeatInitParams seatInitParams = new NESeatInitParams(
        8, 
        NESeatRequestApprovalMode.ON, 
        NESeatInvitationConfirmMode.ON
);
NECreateRoomParams params=new NECreateRoomParams(roomUuid,roomName,templateId, password, seatInitParams, initialProperties);
NECreateRoomOptions options = new NECreateRoomOptions();
roomService.createRoom(params, options, new NECallback2<Unit>() {
  @Override
  public void onSuccess(@Nullable Unit unit) {
    super.onSuccess(unit);
    Log.d(TAG,"success");
  }

  @Override
  public void onError(int code, @Nullable String message) {
    super.onError(code, message);
    Log.d(TAG,"error");
  }
});

API 参考

方法 功能描述
createRoom 创建房间。
此文档是否对你有帮助?
有帮助
去反馈
  • 注意事项
  • 配置步骤
  • 示例代码
  • API 参考