创建房间

更新时间: 2024/09/09 10:36:19

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

注意事项

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

配置步骤

调用 createRoom 接口创建房间。

function createRoom(params: NECreateRoomParams, options: NECreateRoomOptions)
  • NECreateRoomParams 相关参数说明如下表所示。

    名称 描述
    roomUuid 房间 ID,房间 ID 需要保证全局唯一。
    最大长度为 64 个字符。
    roomName 房间名。
    最大长度为 64 个字符。
    templateId 模板 ID。类型:int。模板 ID 的值如下:
    • 线上会议:40
    • 互动直播:3
    • 在线K歌:400
    • 语聊房:569
    • 自定义模板:模板 ID获取方法请参见如何获取模板 ID
    password (可选)设置当前房间的密码。如果设置为空,表示用户进入房间时无需密码。
    initialProperties (可选)设置房间属性。具体请参见房间属性
  • NECreateRoomOptions相关参数说明如下表所示。

    名称 描述
    enableRtc 设置该房间是否包含音视频通话的功能。
    • true:包含音视频通话功能。
    • false:不包含音视频通话功能。
    enableChatroom 设置该房间是否开启即时消息的功能。
    • true:包含即时消息功能。
    • false:不包含即时消息功能。
    enableWhiteboard 设置该房间是否包含互动白板的功能。
    • true:包含互动白板功能。
    • false:不包含互动白板功能。
    enableRecord 设置该房间是否开启录制的功能。
    • true:开启录制功能。
    • false:关闭功能。

示例代码

/**
 * 创建房间
 * @param params.templateId 模板ID
 * @param params.roomName 房间名称
 * @param params.roomUuid 房间ID
 * @param options.enableRtc 是否需要配置RTC房间
 * @param options.enableChatroom 是否需要配置聊天室房间
 * @param options.enableWhiteboard 是否需要配置白板房间
 */

const params = {
    templateId: 'your templateId',
    roomName: 'your roomName',
    roomUuid: 'your roomUuid'
}
const options = {
    enableRtc: true,
    enableChatroom: true,
    enableWhiteboard: true,
    enableRecord: true
}
NERoomService.createRoom(params, options).then(res => {
    console.log(res, 'createRoom success')
}).catch(err => {
    console.error(err, 'createRoom fail')
})

API 参考

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