创建房间

更新时间: 2024/06/14 18:16:18

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

注意事项

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

配置步骤

调用 createRoom 接口创建房间。

swiftfunc createRoom(params: NECreateRoomParams, options: NECreateRoomOptions, callback: NECallback<AnyObject>? = nil)
  • 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。

示例代码

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

swift        let params = NECreateRoomParams()
        params.roomUuid = "xx"
        params.roomName = "xx"
        params.templateId = xx
        params.password = "xxx"

        let seatParam = NESeatInitParams()
        seatParam.seatCount = 8
        seatParam.seatRequestApprovalMode = .off
        seatParam.
        params.seatInitParams = seatParam

        let options = NECreateRoomOptions()
        // 是否包含回放功能,默认为false. 需要此功能请置为true
        options.enableRecord = false
        // 是否包含直播功能,默认为false. 需要此功能请置为true
        options.enableLive = false
        // 是否包含音视频通话功能,默认为true. 如果不需要请置为false
        options.enableRtc = true
        // 是否开启即时消息功能,默认为false. 需要此功能请置为true
        options.enableChatroom = true
        // 是否包含互动白板功能,默认为false. 需要此功能请置为true
        options.enableWhiteboard = true
        NERoomKit.shared().roomService.createRoom(params: params, options: options) {code, string, _ in 
            if code == 0 {
                print("Succeefully create room")
            } else {
                print("Failed to create room, reason: \(string ?? "")")
            }
        }

此文档是否对你有帮助?
有帮助
去反馈
  • 注意事项
  • 配置步骤
  • 示例代码