简介
TUIRoomEngine (rtc_room_engine) 是一款面向企业会议、网络研讨会、在线教育等多人音视频会话场景的组件。它提供房间管理、多人实时音视频互动、成员管理、屏幕分享等会控功能，并支持标清、高清、超高清等多种画质。通过集成此组件，您可以为您的应用程序添加多人音视频会话功能。
集成方式：
在您项目的
pubspec.yaml中，添加以下代码以集成 TUIRoomEngine：dependencies:rtc_room_engine: 最新版本
执行以下命令安装组件：
flutter pub get
TUIRoomEngine API 列表
TUIRoomEngine API 是多人音视频房间的无 UI 接口，您可以使用这套 API 根据您的业务需求自定义封装。
TUIRoomEngine 核心方法
API | 描述 |
创建 TUIRoomEngine 实例。 | |
销毁 TUIRoomEngine 实例。 | |
登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。 | |
退出登录接口，会有主动离开房间操作、销毁资源。 | |
设置本地用户名称和头像。 | |
设置登录用户信息。 | |
获取本地用户登录的基本信息。 | |
设置事件回调。 | |
移除事件回调。 |
房间相关主动接口
API | 描述 |
创建房间。 | |
解散房间。 | |
进入房间。 | |
离开房间。 | |
连接其他房间。 | |
断开与其他房间的连接。 | |
获取房间信息。 | |
更新房间名称（只有管理员或群主能够调用）。 | |
设置房间管理模式（只有管理员或群主能够调用）。 |
本地用户视图渲染、视频管理
API | 描述 |
设置本地用户视频渲染的控件。 | |
打开本地摄像头。 | |
关闭本地摄像头。 | |
更新本地视频编码质量设置。 | |
设置视频编码器的编码参数 | |
设置视频编码器分辨率模式 | |
开启重力感应模式 | |
开始推送本地视频。 | |
停止推送本地视频。 | |
开始屏幕分享 | |
结束屏幕分享 |
本地用户音频管理
API | 描述 |
打开本地麦克风。 | |
关闭本地麦克风。 | |
更新本地音频编码质量设置。 | |
停止推送本地音频。 | |
开始推送本地音频。 |
远端用户视图渲染、视频管理
API | 描述 |
设置远端用户视频渲染的控件。 | |
开始播放远端用户视频。 | |
停止播放远端用户视频。 | |
将远端用户禁音。 |
房间内用户信息
API | 描述 |
获取房间内的成员列表。 | |
获取成员信息。 |
房间内用户管理
API | 描述 |
修改用户角色（只有管理员或群主能够调用）。 | |
修改用户昵称。 | |
将远端用户移出房间（只有管理员或群主能够调用）。 | |
为用户增加标记（只有房主能够调用） | |
为用户移除标记（只有房主能够调用） | |
根据标记获取房间内用户信息 | |
设置房间内成员自定义信息 |
房间内用户发言管理
API | 描述 |
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头、全员禁止打开屏幕分享（目前仅会议场景下可用，并且只有管理员或群主能够调用）。 | |
请求远端用户打开媒体设备（只有管理员或群主能够调用）。 | |
关闭远端用户媒体设备（只有管理员或群主能够调用）。 | |
请求打开本地媒体设备（普通用户可用）。 |
房间内麦位管理
API | 描述 |
设置最大麦位数（仅支持进房前和创建房间时设置）。 | |
获取麦位列表。 | |
主持人/管理员 获取房间内申请上麦用户的请求列表。 | |
锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）。 | |
申请上麦（自由发言模式下，不需要申请）。 | |
申请下麦（自由发言模式下，不需要申请）。 | |
移麦 | |
主持人/管理员 邀请用户上麦。 | |
主持人/管理员 将用户移下麦。 |
信令管理
API | 描述 |
取消请求。 | |
回复请求。 |
发送消息
API | 描述 |
发送本文消息。 | |
发送自定义消息。 | |
禁用远端用户的发送文本消息能力（只有管理员或群主能够调用）。 | |
禁用所有用户的发送文本消息能力（只有管理员或群主能够调用）。 |
高级功能
API | 描述 |
设置美颜级别 | |
设置美白级别 | |
获取插件 | |
获取设备管理类 |
调试相关
API | 描述 |
调用实验性接口 |
TUIRoomObserver 回调事件
TUIRoomObserver 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己需要的回调事件。
TUIRoomObserver
错误回调
API | 描述 |
错误事件回调。 |
登录状态事件回调
API | 描述 |
其他终端登录被移下线。 | |
用户凭证超时事件。 |
房间内事件回调
API | 描述 |
房间名称更改事件。 | |
房间内所有用户麦克风被禁用事件。 | |
房间内所有用户摄像头被禁用事件。 | |
房间内所有用户屏幕分享被禁用事件。 | |
房间内所有用户发送文本消息被禁用事件。 | |
被移出房间事件。 | |
房间被解散事件。 | |
房间麦控模式发生变化 | |
房间上麦模式发生变化 | |
房间人数发生变化 |
房间内用户事件回调
API | 描述 |
远端用户进房事件。 | |
远端用户离开房间事件。 | |
用户角色发生变化事件。 | |
用户视频状态发生变化事件。 | |
用户音频状态发生变化事件。 | |
用户音量变化事件。 | |
用户文本消息发送能力发生变化事件。 | |
用户网络状态变化事件。 | |
屏幕分享结束。 |
房间内麦位事件回调
API | 描述 |
房间内最大麦位数发生变化事件（仅在会议类型房间生效）。 | |
麦位列表发生变化事件。 | |
收到用户被移下麦事件。 |
请求信令事件回调
API | 描述 |
收到请求消息事件。 | |
收到请求被取消的事件。 | |
收到请求被其他 管理员/房主 处理事件 |
房间内消息事件回调
API | 描述 |
收到普通文本消息事件。 | |
收到自定义消息事件。 |
