产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
函数接口 | 描述 |
预定会议 | |
取消预定会议 | |
更新预定会议信息 | |
获取预定会议列表 | |
获取预定会议邀请成员列表 | |
添加成员至邀请列表 | |
从邀请列表移除成员 | |
事件接口 | 描述 |
会议预定回调 | |
会议即将开始回调 | |
会议取消回调 | |
会议信息变更回调 | |
参会人员变更回调 | |
会议状态变更回调 |
类型 | 说明 |
会议信息 | |
会议信息修改内容 |
类型 | 说明 |
会议取消的原因。 | |
会议状态。 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();await conferenceListManager.scheduleConference({roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型scheduleStartTime: 1720004257, // 填入您的会议预定开始时间的时间戳，单位秒。scheduleEndTime: 1720001317, // 填入您的会议预定结束时间的时间戳，单位秒。});
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 房间 Id，必填, roomId 限制长度为64字节，且仅支持以下范围的字符集： 大小写英文字母（a-zA-Z） 数字（0-9） 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ |
scheduleStartTime | number | 必填 | - | 预定会议开始时间（计数单位为秒的时间戳） |
scheduleEndTime | number | 必填 | - | 预定会议结束时间（计数单位为秒的时间戳） |
scheduleAttendees | Array | 非必填 | [] | 预定会议邀请成员 userId 列表 |
reminderSecondsBeforeStart | number | 非必填 | 0 | 会议开始前提醒时间，单位秒 |
roomName | string | 非必填 | roomId | 房间名称，默认值为 roomId，传入的值不能为空字符串 |
roomType | 非必填 | TUIRoomType.kConference | 房间类型 | |
isSeatEnabled | boolean | 非必填 | false | 是否开启麦位控制 |
seatMode | 非必填 | TUISeatMode.kFreeToTake | 上麦模式(开启麦位控制后生效) | |
isMicrophoneDisableForAllUser | boolean | 非必填 | false | 是否开启全员禁麦，默认不开启全员禁麦 |
isScreenShareDisableForAllUser | boolean | 非必填 | false | 是否开启禁止屏幕分享，默认不开启禁止屏幕分享权限（该属性自 v2.2.0 版本以后支持） |
isCameraDisableForAllUser | boolean | 非必填 | false | 是否开启全员禁画，默认不开启全员禁画 |
isMessageDisableForAllUser | boolean | 非必填 | false | 是否允许成员发送消息，默认不禁止 |
maxSeatCount | number | 非必填 | - | 最大麦位数量。 |
password | string | 非必填 | '' | 房间密码（该属性自 v2.5.0 版本支持） |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();await conferenceListManager.cancelConference({roomId: '12345', // 填入您要取消的会议 Id，即房间 roomId。);
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 要取消会议Id，即房间roomId |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();await conferenceListManager.updateConferenceInfo({roomId: '12345', // 填入您要更新的会议房间 roomId 。roomName: 'myRoomName', // 填入您更新后的会议名称。scheduleStartTime: 1720004257, // 填入您更新后的会议预定开始时间的时间戳，单位秒。scheduleEndTime: 1720001317, // 填入您更新后的会议预定结束时间的时间戳，单位秒。);
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 要取消会议Id，即房间roomId |
roomName | string | 非必填 | '' | 会议名称 |
scheduleStartTime | number | 非必填 | - | 预定会议的开始时间（计数单位为秒的时间戳） |
scheduleEndTime | number | 非必填 | - | 预定会议的结束时间（计数单位为秒的时间戳） |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();const conferenceList = [];let result;let cursor = '';let count = 20;do {result = await conferenceListManager.fetchScheduledConferenceList({ cursor, count });conferenceList.push(...result.conferenceList);cursor = result.cursor;} while (cursor !== '')
参数 | 类型 | 说明 | 默认值 | 含义 |
statusArray | 非必填 | - | 会议状态数组，默认值为拉取全部状态会议。 | |
cursor | string | 必填 | - | 分页获取索引，首次拉取请填 ''。若接口调用成功且返回数据中的 cursor 不为空，则表示需要分页。请使用返回的 cursor 作为参数再次调用接口拉取，直至返回的 cursor 为空，表示数据已全部拉取。 |
count | number | 必填 | - | 本次拉取数量。 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();const attendeeList = [];let result;let cursor = '';let totalCount = 0;let roomId = '12345';let count = 20;do {result = await conferenceListManager.fetchAttendeeList({ roomId, cursor, count });attendeeList.push(...result.attendeeList);cursor = result.cursor;totalCount = result.totalCount;} while (cursor !== '')
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 会议Id，即房间roomId |
cursor | string | 必填 | '' | 分页获取索引，首次拉取请填 ''。若接口调用成功且返回数据中的 cursor 不为空，则表示需要分页。请使用返回的 cursor 作为参数再次调用接口拉取，直至返回的 cursor 为空，表示数据已全部拉取。 |
count | number | 必填 | - | 本次拉取数量。 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();await conferenceListManager.addAttendeesByAdmin({roomId: '12345', // 填入您要添加成员的会议 Id ,即房间 roomId 。userIdList: ['123'], // 填入您要邀请的成员 Id 数组。});
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 会议Id，即房间roomId |
userIdList | Array<string> | 必填 | - | 成员 userId 列表 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();await conferenceListManager.removeAttendeesByAdmin({roomId: '12345', // 填入您要移除成员的会议 Id ,即房间 roomId 。userIdList: ['123'], // 填入您要移除的成员 Id 数组。});
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | string | 必填 | - | 会议Id，即房间roomId |
userIdList | Array<string> | 必填 | - | 成员 userId 列表 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();const callback = ({ conferenceInfo }) => {console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);})conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, callback);
参数 | 类型 | 是否必填 | 默认值 | 说明 |
eventName | 是 | - | 事件名。 | |
func | (...args: any[]) => void | 是 | - | 事件处理函数。 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();const callback = ({ conferenceInfo }) => {console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);})conferenceListManager.off(TUIConferenceListManagerEvents.onConferenceScheduled, callback);
参数 | 类型 | 是否必填 | 默认值 | 说明 |
eventName | 是 | - | 事件名。 | |
func | (...args: any[]) => void | 是 | - | 事件处理函数。 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, ({ conferenceInfo }) => {console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);})
参数 | 类型 | 含义 |
conferenceInfo | TUIConferenceInfo | 会议信息 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceWillStart, ({ conferenceInfo }) => {console.log('conferenceListManager.onConferenceWillStart', conferenceInfo);})
参数 | 类型 | 含义 |
conferenceInfo | TUIConferenceInfo | 会议信息 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceCancelled, ({ roomId, reason, operateUser }) => {console.log('conferenceListManager.onConferenceCancelled', roomId, reason, operateUser);})
参数 | 类型 | 含义 |
roomId | string | 会议 ID，即房间 roomId |
reason | 会议取消原因 | |
operateUser | 取消会议操作者信息 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceInfoChanged, ({ conferenceModifyInfo }) => {console.log('conferenceListManager.onConferenceInfoChanged', conferenceModifyInfo);})
参数 | 类型 | 含义 |
conferenceModifyInfo | 会议变更信息 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesChanged, ({ roomId, leftUsers, joinedUsers }) => {console.log('conferenceListManager.onScheduleAttendeesChanged', roomId, leftUsers, joinedUsers);})
参数 | 类型 | 含义 |
roomId | string | 会议 ID，即房间roomId |
leftUsers | 离开成员列表 | |
joinedUsers | 新加入成员列表 |
const roomEngine = new TUIRoomEngine();const conferenceListManager = roomEngine.getConferenceListManager();conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusChanged, ({ roomId, status }) => {console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );})
参数 | 类型 | 含义 |
roomId | string | 会议 ID，即房间roomId |
status | 会议状态 |
名称 | 类型 | 描述 |
scheduleStartTime | number | 预定会议开始时间 |
scheduleEndTime | number | 预定会议结束时间 |
scheduleAttendees | string[] | 邀请参会成员列表 |
reminderSecondsBeforeStart | number | 会议开始前提醒时间（秒） |
status | 房间状态（只读） | |
basicRoomInfo | 房间信息 |
名称 | 类型 | 描述 |
scheduleStartTime | number | 预定会议开始时间 |
scheduleEndTime | number | 预定会议结束时间 |
basicRoomInfo.roomId | string | 房间 ID |
basicRoomInfo.roomName | string | 房间名称 |
名称 | 类型 | 描述 |
kConferenceCancelReasonCancelledByAdmin | number | 房主取消 |
kConferenceCancelReasonRemovedFromAttendees | number | 当前用户被移出参会人员列表 |
名称 | 类型 | 描述 |
kConferenceStatusNone | number | 未知状态 |
kConferenceStatusNotStarted | number | 会议未开始 |
kConferenceStatusRunning | number | 会议进行中 |
文档反馈