Conference
  • 产品概述
  • Web
    • 跑通 Demo
    • 集成
    • UI 定制
    • Conference Control
    • 房间中聊天
    • 云端录制
    • AI 降噪
    • 机器人推流
    • 虚拟背景
    • 更多功能
      • 悬浮窗
      • 文字水印
    • 接口文档
      • RoomKit 接口
      • RoomEngine 接口
        • 接口概述
        • TUIRoomEngine
        • TUIRoomEvents
        • TUIRoomEngine 定义
    • 常见问题
  • iOS
    • 跑通 Demo
    • 集成
    • UI 定制
    • 会议控制
    • 房间中聊天
    • 云端录制
    • AI 降噪
    • 机器人推流
    • 更多功能
      • 悬浮窗
    • 接口文档
      • RoomKit 接口
      • RoomEngine 接口
        • 接口概述
        • TUIRoomEngine
        • TUIRoomObserver
        • 类型定义
    • 常见问题
  • Android
    • 跑通 Demo
    • 集成
    • UI 定制
    • 会议控制
    • 房间中聊天
    • 云端录制
    • AI 降噪
    • 机器人推流
    • 更多功能
      • 悬浮窗
    • 接口文档
      • RoomKit 接口
      • RoomEngine 接口
        • 接口概述
        • TUIRoomEngine
        • TUIRoomObserver
        • 类型定义
    • 常见问题
  • Electron
    • 跑通 Demo
    • 集成
    • UI 定制
    • Conference Control
    • 房间中聊天
    • 云端录制
    • AI 降噪
    • 机器人推流
    • 更多功能
      • 悬浮窗
      • 文字水印
    • 接口文档
      • RoomKit 接口
      • RoomEngine 接口
        • 接口概述
        • TUIRoomEvent
        • TUIRoomEngine
        • TUIRoomEngine 定义
    • 常见问题
  • Flutter
    • 跑通 Demo
    • 集成
    • UI 定制
    • 会议控制
    • In-Conference Chat
    • 云端录制
    • AI 降噪
    • 机器人推流
    • 更多功能
      • 悬浮窗
    • 接口文档
      • RoomKit 接口
      • RoomEngine 接口
        • 接口概述
        • TUIRoomEngine
        • TUIRoomObserver
        • 类型定义
    • 常见问题
  • 产品概述
    • 产品概述
  • 开通服务
  • 价格中心
    • 免费时长
    • TRTC 多人音视频 Conference 包月套餐
    • 订阅套餐时长计费说明
    • 现收现付
      • 音视频时长计费说明
      • 云端录制计费说明
      • 混流转码与旁路转推计费说明
  • 服务器 API
    • REST 接口
      • RESTful 接口概述
      • RESTful 接口列表
      • Room Management
        • Create a Room
        • Destroy a Room
        • Update the Room Information
        • Get the Room Information
      • 用户管理
        • Get the Room Member List
        • Update the Room Member Information
        • Change the Room Ownership
        • Mark Room Members
        • Ban Room Members
        • Unban Room Members
        • Get the Banned Room Member List
        • Remove Room Member
      • Seat Management
        • Get the Seat List
        • Pick User on the Seat
        • Kick User off the Seat
        • Lock the Seat
    • Third-Party Callback
      • Callback Overview
      • Callback Command List
      • Callback Configuration
        • Query Callback Configuration
        • Create Callback Configuration
        • Update Callback Configuration
        • Delete Callback Configuration
      • Room Related
        • After a Room Is Created
        • After a Room Is Destroyed
        • After the Room Information Is Updated
      • User Related
        • After a Room Is Entered
        • After a Room Is Left
      • Seat Connection Related
        • After the Seat List Is Changed
  • 错误码
Conference

接口概述

TUIRoomEngine API 列表

TUIRoomEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。
TUIRoomEngine

TUIRoomEngine 核心方法

API
描述
init
创建 TUIRoomEngine 实例。
login
登录接口,您需要先初始化用户信息后才能进入房间,并进行一系列的操作。
logout
退出登录接口,会有主动离开房间操作、销毁资源。
设置本地用户名称和头像。
获取本地用户登录的基本信息。
设置事件回调。
移除事件回调。

房间相关主动接口

API
描述
创建房间。
解散房间。
enterRoom
进入房间。
exitRoom
离开房间。
连接其他房间。
断开与其他房间的连接。
获取房间信息。
更新房间名称(只有管理员或群主能够调用)。
设置房间麦控模式(只有管理员或群主能够调用)。

本地用户视图渲染、视频管理

API
描述
设置本地用户视频渲染的控件。
打开本地摄像头。
关闭本地摄像头。
更新本地视频编码质量设置。
开始推送本地视频。
停止推送本地视频。
开始屏幕分享(该接口仅支持移动端)。
开始屏幕分享(该接口仅支持桌面端 Mac OS 系统)。
结束屏幕分享。
枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)。
选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)。

本地用户音频管理

API
描述
打开本地麦克风。
关闭本地麦克风。
更新本地音频编码质量设置。
开始推送本地音频。
停止推送本地音频。

远端用户视图渲染、视频管理

API
描述
设置远端用户视频渲染的控件。
开始播放远端用户视频。
停止播放远端用户视频。
将远端用户禁音。

房间内用户信息

API
描述
获取房间内的成员列表。
获取成员信息。

房间内用户管理

API
描述
修改用户角色(只有管理员或群主能够调用)。
将远端用户踢出房间(只有管理员或群主能够调用)。

房间内用户发言管理

API
描述
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态,例如:全员禁止打开麦克风、全员禁止打开摄像头、全员禁止打开屏幕分享(目前仅会议场景下可用,并且只有管理员或群主能够调用)。
请求远端用户打开媒体设备(只有管理员或群主能够调用)。
关闭远端用户媒体设备(只有管理员或群主能够调用)。
请求打开本地媒体设备(普通用户可用)。

房间内麦位管理

API
描述
设置最大麦位数(仅支持进房前和创建房间时设置)。
获取麦位列表。
锁定麦位(只有管理员或群主能够调用,包括位置锁定、音频状态锁定和视频状态锁定)。
takeSeat
申请上麦(自由发言模式下,不需要申请)。
leaveSeat
申请下麦(自由发言模式下,不需要申请)。
主持人/管理员 邀请用户上麦。
主持人/管理员 将用户踢下麦。

信令管理

API
描述
取消请求。
回复请求。

发送消息

API
描述
发送本文消息。
发送自定义消息。
禁用远端用户的发送文本消息能力(只有管理员或群主能够调用)。
禁用所有用户的发送文本消息能力(只有管理员或群主能够调用)。

高级功能:获取 TRTC 实例

API
描述
获取原生 TRTC 设备管理类。
获取原生 TRTC 音效类。
获取原生 TRTC 美颜类。
获取原生 TRTC 实例类。


TUIRoomObserver 回调事件

TUIRoomObserver 是 TUIRoomEngine 对应的回调事件类,您可以通过此回调,来监听自己需要的回调事件。
TUIRoomObserver

TUIRoomObserver

错误回调

API
描述
onError
错误事件回调。

登录状态事件回调

API
描述
其他终端登录被踢下线。
用户凭证超时事件。

房间内事件回调

API
描述
房间名称更改事件。
房间内所有用户麦克风被禁用事件。
房间内所有用户摄像头被禁用事件。
房间内所有用户发送文本消息被禁用事件。
被踢出房间事件。
房间被解散事件。
房间麦控模式发生变化

房间内用户事件回调

API
描述
远端用户进房事件。
远端用户离开房间事件。
用户角色发生变化事件。
用户视频状态发生变化事件。
用户音频状态发生变化事件。
用户屏幕采集停止事件。
用户音量变化事件。
用户文本消息发送能力发生变化事件
用户网络状态变化事件。

房间内麦位事件回调

API
描述
房间内最大麦位数发生变化事件(仅在会议类型房间生效)
麦位列表发生变化事件。
收到用户被踢下麦事件。

请求信令事件回调

API
描述
收到请求消息事件。
收到请求被取消的事件。

房间内消息事件回调

API
描述
收到普通文本消息事件。
收到自定义消息事件。