- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍 (TUIRoomKit)
- 开通服务 (TUIRoomKit)
- 跑通 Demo（TUIRoomKit）
- 快速接入 (TUIRoomKit)
- 界面定制 (TUIRoomKit)
- 虚拟背景（TUIRoomKit）
- 会议控制 (TUIRoomKit)
- 云端录制 (TUIRoomKit)
- AI 降噪 (TUIRoomKit)
- 会中聊天 (TUIRoomKit)
- 机器人推流 (TUIRoomKit)
- 更多特性 (TUIRoomKit)
- 客户端 API (TUIRoomKit)
- 服务端 API (TUIRoomKit)
- 常见问题 (TUIRoomKit)
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍 (TUIRoomKit)
- 开通服务 (TUIRoomKit)
- 跑通 Demo（TUIRoomKit）
- 快速接入 (TUIRoomKit)
- 界面定制 (TUIRoomKit)
- 虚拟背景（TUIRoomKit）
- 会议控制 (TUIRoomKit)
- 云端录制 (TUIRoomKit)
- AI 降噪 (TUIRoomKit)
- 会中聊天 (TUIRoomKit)
- 机器人推流 (TUIRoomKit)
- 更多特性 (TUIRoomKit)
- 客户端 API (TUIRoomKit)
- 服务端 API (TUIRoomKit)
- 常见问题 (TUIRoomKit)
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
简介
TUIRoomKit API 是多人会议组件的含 UI 接口。使用 TUIRoomKit 的相关 API，您可以通过简单接口快速实现一个类会议场景。详细的接入步骤请参见：快速接入（TUIRoomKit）。
本文档将详细介绍 Flutter TUIRoomKit 中您可能使用到的类以及相关接口，通过查阅本文档，您可以对Flutter TUIRoomKit的使用有一个更为详细的了解。
ConferenceMainPage
会议主界面
字段 | 类型 | 描述 |
conferenceId | String | 需要创建/加入的会议 Id |
isCreateConference | bool | 是否为创建会议（true 为创建会议，false 为加入会议） |
conferenceParams | 创建/加入会议的相关参数 | |
conferenceObserver | 会议状态变化回调监听 |
说明：
当您使用
ConferenceSession创建或加入会议时，这里的参数均可不传。ConferenceSession
当您期望在创建/加入会议成功后再拉起会议界面，您可以使用
ConferenceSession类进行相关操作。字段 | 类型 | 描述 |
isMuteMicrophone | bool | 是否静音麦克风（默认为 false） |
isOpenCamera | bool | 是否开启摄像头（默认为 false） |
isSoundOnSpeaker | bool | 是否使用扬声器（默认为 true） |
name | String | 会议名称（默认为您的会议 Id，加入会议时传入无效） |
enableMicrophoneForAllUser | bool | 是否开启全员的麦克风权限（默认为 true，加入会议时传入无效） |
enableCameraForAllUser | bool | 是否开启全员的摄像头权限（默认为 true，加入会议时传入无效） |
enableMessageForAllUser | bool | 是否开启全员的发言权限（默认为 true，加入会议时传入无效） |
enableSeatControl | bool | 是否开启上台发言模式（默认为 false，加入会议时传入无效） |
onActionSuccess | VoidCallback | 创建/加入会议成功的回调，您可以在这个回调中导航至会议页面 |
onActionError | 创建/加入会议失败的回调 |
newInstance
创建一个新的 ConferenceSession 对象。
factory ConferenceSession.newInstance(String id)
参数 | 类型 | 描述 |
id | String | 需要创建/加入的会议 id |
quickStart
快速创建会议接口。
Future<void> quickStart()
join
加入会议接口。
Future<void> join()
注意：
在调用快速创建会议或加入会议接口之前，您需要完成所有您需要设置的 ConferenceSession 的参数，详情可以参见 会前控制。
直接导航至 ConferenceMainPage 并传入相关参数以创建/加入会议时，无需使用 ConferenceSession。
ConferenceParams
字段 | 类型 | 描述 |
isMuteMicrophone | bool | 是否静音麦克风（默认为 false） |
isOpenCamera | bool | 是否开启摄像头（默认为 false） |
isSoundOnSpeaker | bool | 是否使用扬声器（默认为 true） |
name | String | 会议名称（默认为您的会议 Id，加入会议时传入无效） |
enableMicrophoneForAllUser | bool | 是否开启全员的麦克风权限（默认为 true，加入会议时传入无效） |
enableCameraForAllUser | bool | 是否开启全员的摄像头权限（默认为 true，加入会议时传入无效） |
enableMessageForAllUser | bool | 是否开启全员的发言权限（默认为 true，加入会议时传入无效） |
enableSeatControl | bool | 是否开启上台发言模式（默认为 false，加入会议时传入无效） |
ConferenceObserver
onConferenceStarted
会议开始事件。
Function(String conferenceId, ConferenceError error) onConferenceStarted
参数 | 类型 | 描述 |
conferenceId | String | 会议 Id |
error | 错误码 |
onConferenceJoined
加入会议事件。
Function(String conferenceId, ConferenceError error) onConferenceJoined
参数 | 类型 | 描述 |
conferenceId | String | 会议 Id |
error | 错误码 |
onConferenceFinished
会议结束事件，当主动结束会议或会议被解散时会触发该回调。
Function(String conferenceId) onConferenceFinished
参数 | 类型 | 描述 |
conferenceId | String | 会议 Id |
onConferenceExited
退出会议事件，当主动退出会议或被踢出会议时会触发该回调。
Function(String conferenceId) onConferenceFinished
参数 | 类型 | 描述 |
conferenceId | String | 会议 Id |
ConferenceError
错误码。
枚举 | 取值 | 描述 |
success | 0 | 操作成功 |
errFailed | -1 | 暂未归类的通用错误 |
errConferenceIdNotExist | -2100 | 进房时房间不存在，或许已被解散 |
errConferenceIdInvalid | -2105 | 创建房间 ID 非法，自定义 ID 必须为可打印 ASCII 字符（0x20-0x7e），最长48个字节 |
errConferenceIdOccupied | -2106 | 房间 ID 已被使用，请选择别的房间 ID |
errConferenceNameInvalid | -2107 | 房间名称非法，名称最长30字节，如果包含中文，字符编码必须是 UTF-8。 |
是
否
本页内容是否解决了您的问题？