- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 开播和观看（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 悬浮窗（TUILiveKit）
- 客户端API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 开播和观看（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 悬浮窗（TUILiveKit）
- 客户端API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
1. TUIRoom 是基于腾讯云实时音视频（TRTC）和即时通信 IM 服务组合而成的，支持以下功能：
主持人创建房间，进入房间人员输入房间号后进入房间。
进入房间人员之间进行屏幕分享。
支持发送各种文本消息和自定义消息。
说明：
TUIKit 系列组件同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PaaS 服务，开通实时音视频后会同步开通即时通信IM服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明，TRTC 开通会默认关联开通 IM SDK 的体验版，仅支持100个 DAU。
TRTC SDK：使用 TRTC SDK 作为低延时音视频房间组件。
IM SDK：使用 IM SDK 实现聊天室的功能（IM SDK 使用 Android 版本）。
TUIRoom API 概览
TUIRoomCore 基础函数
API | 描述 |
获取单例对象。 | |
销毁单例对象。 | |
设置事件回调。 |
房间相关接口函数
API | 描述 |
创建房间（主持人调用）。 | |
销毁房间（主持人调用）。 | |
进入房间（参会成员调用）。 | |
离开房间（参会成员调用）。 | |
获取房间信息。 | |
获取房间内所有成员信息。 | |
获取某个用户的信息。 | |
转移主持人权限（主持人调用）。 |
本地音视频操作接口
API | 描述 |
开启本地视频的预览画面。 | |
停止本地视频采集及预览。 | |
开启麦克风采集。 | |
停止麦克风采集。 | |
设置本地画面镜像预览模式。 | |
设置开启扬声器。 |
远端用户相关接口
API | 描述 |
订阅并播放指定成员的远端视频画面。 | |
取消订阅并停止播放远端视频画面。 |
发送聊天消息接口
API | 描述 |
发送聊天消息。 | |
发送自定义消息。 |
场控相关接口
API | 描述 |
禁用/恢复某用户的麦克风。 | |
禁用/恢复所有用户的麦克风，并且状态会同步到房间信息中。 | |
禁用/恢复某用户的摄像头。 | |
禁用/恢复所有用户的摄像头，并且状态会同步到房间信息中。 | |
开启/停止聊天室禁言（主持人调用）。 | |
移除房间内的某人（主持人调用）。 | |
主持人开始点名。 | |
主持人结束点名。 | |
参会成员回复主持人点名。 | |
主持人邀请成员发言。 | |
主持人取消邀请成员发言。 | |
参会成员同意/拒绝主持人的申请发言。 | |
参会成员申请发言。 | |
主持人同意/拒绝参会成员的申请发言。 | |
主持人禁止申请发言。 | |
主持人令参会成员停止发言。 | |
主持人令全体停止发言。 | |
参会成员停止发言，转变为观众。 |
屏幕分享接口
API | 描述 |
启动屏幕分享。 | |
停止屏幕采集。 |
美颜滤镜相关接口函数
API | 描述 |
获取美颜管理对象 TXBeautyManager。 |
相关设置接口
API | 描述 |
设置网络流控相关参数。 |
获取 SDK 版本接口函数
API | 描述 |
获取 SDK 版本。 |
TUIRoomCoreListener API 概览
错误事件回调
API | 描述 |
错误回调。 |
基础事件回调
API | 描述 |
房间解散回调。 | |
音量大小回调回调。 | |
主持人更改回调。 |
远端用户事件回调
API | 描述 |
远端用户进入房间回调。 | |
远端用户离开房间回调。 | |
远端用户是否开启摄像头视频回调。 | |
远端用户是否开启屏幕分享回调。 | |
远端用户是否开启音频上行回调。 | |
远端用户开始发言回调。 | |
远端用户结束发言回调。 |
消息事件回调
API | 描述 |
收到文本消息回调。 | |
收到自定义消息回调。 |
场控事件回调
API | 描述 |
用户收到主持人发言邀请回调。 | |
用户收到主持人取消发言邀请回调。 | |
主持人收到用户发言申请的回调。 | |
用户取消申请发言回调。 | |
主持人禁止申请发言回调。 | |
参会成员被请求停止发言的回调。 | |
主持人开始点名，参会成员收到的回调。 | |
主持人结束点名，参会成员收到的回调。 | |
参会成员回复点名，主持人收到的回调。 | |
主持人更改聊天室是否禁言回调。 | |
主持人设置禁用麦克风回调。 | |
主持人设置禁用摄像头回调。 | |
参会成员收到主持人踢人的回调。 |
统计和质量回调
API | 描述 |
技术指标统计回调。 | |
网络质量回调。 |
屏幕分享相关回调
API | 描述 |
开始屏幕分享回调。 | |
停止屏幕分享回调。 |
TUIRoomCore 基础函数
getInstance
public static TUIRoomCore getInstance(Context context);
参数如下表所示：
参数 | 类型 | 含义 |
context | Context | Android 上下文，内部会转为 ApplicationContext 用于系统 API 调用。 |
destroyInstance
void destroyInstance();
setListener
void setListener(TUIRoomCoreListener listener);
参数如下表所示：
参数 | 类型 | 含义 |
listener | TUIRoomCoreListener | 接收事件回调类。 |
createRoom
创建房间（主持人调用）。
void createRoom(String roomId, TUIRoomCoreDef.SpeechMode speechMode, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
roomId | String | 房间标识，需要由您分配并进行统一管理。 |
speechMode | TUIRoomCoreDef.SpeechMode | 发言模式。 |
callback | TUIRoomCoreCallback.ActionCallback | 创建房间的结果回调。 |
主持人正常调用流程如下：
1. 主持人调用
createRoom() 创建房间，房间创建成功与否会通过 TUIRoomCoreCallback.ActionCallback 通知给主持人。2. 主持人调用
startCameraPreview() 打开摄像头采集和预览。3. 主持人调用
startLocalAudio() 打开本地麦克风。destroyRoom
销毁房间房间（主持人调用），主持人在创建房间后，可以调用该函数来销毁房间。
void destroyRoom(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | UIRoomCoreCallback.ActionCallback | 销毁房间的结果回调。 |
enterRoom
进入房间（参会成员调用）。
void enterRoom(String roomId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
roomId | String | 房间标识。 |
callback | UIRoomCoreCallback.ActionCallback | 结果回调。 |
加入参会成员进入房间的正常调用流程如下：
1. 参会成员调用
enterRoom 并传入 roomId 即可进入房间房间。2. 参会成员调用
startCameraPreview() 打开摄像头预览，调用 startLocalAudio() 打开麦克风采集。3. 参会成员收到
onRemoteUserCameraAvailable 的事件，调用 startRemoteView()开始播放视频。leaveRoom
离开房间（参会成员调用）。
void leaveRoom(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | UIRoomCoreCallback.ActionCallback | 结果回调。 |
getRoomInfo
获取房间信息。
TUIRoomCoreDef.RoomInfo getRoomInfo();
getRoomUsers
获取房间所有成员信息。
List<TUIRoomCoreDef.UserInfo> getRoomUsers();
getUserInfo
获取成员信息。
void getUserInfo(String userId, TUIRoomCoreCallback.UserInfoCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户标识。 |
callback | UIRoomCoreCallback.UserInfoCallback | 房间人员详细信息回调。 |
setSelfProfile
设置用户信息。
void setSelfProfile(String userName, String avatarURL, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userName | String | 用户姓名。 |
avatarURL | String | 用户头像 URL。 |
callback | TUIRoomCoreCallback.ActionCallback | 是否设置成功的结果回调。 |
transferRoomMaster
将群转交给其他用户。
void transferRoomMaster(String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户标识。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
本地推流接口
startCameraPreview
开始本地摄像头预览。
void startCameraPreview(boolean isFront, TXCloudVideoView view);
参数如下表所示：
参数 | 类型 | 含义 |
isFront | boolean | true：前置摄像头；false：后置摄像头。 |
view | TXCloudVideoView | 承载视频画面的控件。 |
stopCameraPreview
停止本地摄像头预览。
void stopCameraPreview();
startLocalAudio
开启麦克风采集。
void startLocalAudio(int quality);
参数如下表所示：
参数 | 类型 | 含义 |
quality | int | 采集的声音音质： TRTC_AUDIO_QUALITY_MUSIC TRTC_AUDIO_QUALITY_DEFAULT TRTC_AUDIO_QUALITY_SPEECH |
stopLocalAudio
停止麦克风采集
void stopLocalAudio();
setVideoMirror
设置本地画面镜像预览模式。
void setVideoMirror(int type);
参数如下表所示：
参数 | 类型 | 含义 |
type | int | 镜像类型。 |
setSpeaker
设置开启扬声器。
void setSpeaker(boolean isUseSpeaker);
参数如下表所示：
参数 | 类型 | 含义 |
isUseSpeaker | boolean | true：扬声器，false：听筒。 |
远端用户相关接口
startRemoteView
订阅远端用户的视频流。
void startRemoteView(String userId, TXCloudVideoView view, TUIRoomCoreDef.SteamType streamType, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 需要播放的用户 ID。 |
view | TXCloudVideoView | 承载视频画面的 view 控件。 |
streamType | TUIRoomCoreDef.SteamType | 流类型。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
stopRemoteView
取消订阅并停止播放远端视频画面。
void stopRemoteView(String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 需要停止播放的用户 ID。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
switchCamera
切换前后摄像头。
void switchCamera(boolean isFront);
参数如下表所示：
参数 | 类型 | 含义 |
isFront | boolean | true：前置摄像头；false：后置摄像头。 |
发送消息接口
sendChatMessage
在房间中广播文本消息，一般用于文本聊天。
void sendChatMessage(String message, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
message | String | 消息内容。 |
callback | TUIRoomCoreCallback.ActionCallback | 发送结果回调。 |
sendCustomMessage
发送自定义消息。
void sendCustomMessage(String data, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
data | String | 消息内容。 |
callback | TUIRoomCoreCallback.ActionCallback | 发送结果回调。 |
场控相关接口
muteUserMicrophone
禁用/恢复某用户的麦克风。
void muteUserMicrophone(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
mute | boolean | 是否禁用。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
muteAllUsersMicrophone
禁用/恢复所有用户的麦克风。
void muteAllUsersMicrophone(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
mute | boolean | 是否禁用。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
muteUserCamera
禁用/恢复某用户的摄像头。
void muteUserCamera(String userId, boolean mute, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
mute | boolean | 是否禁用。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
muteAllUsersCamera
禁用/恢复所有用户的摄像头。
void muteAllUsersCamera(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
mute | boolean | 是否禁用。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
muteChatRoom
禁言/恢复文字聊天。
void muteChatRoom(boolean mute, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
mute | boolean | 是否禁用。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
kickOffUser
主持人踢人。
void kickOffUser(String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
startCallingRoll
主持人开始点名。
void startCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
stopCallingRoll
主持人结束点名。
void stopCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
replyCallingRoll
参会成员回复主持人点名。
void replyCallingRoll(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
sendSpeechInvitation
主持人邀请参会成员发言。
void sendSpeechInvitation(String userId, TUIRoomCoreCallback.InvitationCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
callback | TUIRoomCoreCallback.InvitationCallback | 结果回调。 |
cancelSpeechInvitation
主持人取消邀请参会成员发言。
void cancelSpeechInvitation(String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
replySpeechInvitation
参会成员同意/拒绝主持人的发言邀请。
void replySpeechInvitation(boolean agree, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
agree | boolean | 是否同意。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
sendSpeechApplication
参会成员申请发言。
void sendSpeechApplication(TUIRoomCoreCallback.InvitationCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.InvitationCallback | 结果回调。 |
cancelSpeechApplication
参会成员取消申请发言。
void cancelSpeechApplication(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
replySpeechApplication
主持人同意/拒绝参会成员的申请发言。
void replySpeechApplication(boolean agree, String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
agree | boolean | 是否同意。 |
userId | String | 用户 ID。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
forbidSpeechApplication
主持人禁止申请发言。
void forbidSpeechApplication(boolean forbid, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
forbid | boolean | 是否禁止。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
sendOffSpeaker
主持人令参会成员停止发言。
void sendOffSpeaker(String userId, TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
sendOffAllSpeakers
主持人令所有成员停止发言。
void sendOffAllSpeakers(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
exitSpeechState
参会成员停止发言，转变为观众。
void exitSpeechState(TUIRoomCoreCallback.ActionCallback callback);
参数如下表所示：
参数 | 类型 | 含义 |
callback | TUIRoomCoreCallback.ActionCallback | 结果回调。 |
屏幕分享接口
startScreenCapture
启动屏幕分享。
void startScreenCapture(TRTCCloudDef.TRTCVideoEncParam encParams, TRTCCloudDef.TRTCScreenShareParams screenShareParams);
参数如下表所示：
参数 | 类型 | 含义 |
encParams | TRTCCloudDef.TRTCVideoEncParam | 设置屏幕分享时的编码参数，推荐采用上述推荐配置，如果您指定 encParams 为 null，则使用您调用 startScreenCapture 之前的编码参数设置。 |
screenShareParams | TRTCCloudDef.TRTCScreenShareParams | 设置屏幕分享的特殊配置，其中推荐设置 floatingView，一方面可以避免 App 被系统强杀；另一方面也能助于保护用户隐私。 |
说明：
stopScreenCapture
停止屏幕采集。
void stopScreenCapture();
美颜滤镜相关接口函数
getBeautyManager
TXBeautyManager getBeautyManager();
通过美颜管理，您可以使用以下功能：
设置“美颜风格”、“美白”、“红润”、“大眼”、“瘦脸”、“V脸”、“下巴”、“短脸”、“小鼻”、“亮眼”、“白牙”、“祛眼袋”、“祛皱纹”、“祛法令纹”等美容效果。
调整“发际线”、“眼间距”、“眼角”、“嘴形”、“鼻翼”、“鼻子位置”、“嘴唇厚度”、“脸型”。
设置人脸挂件（素材）等动态效果。
添加美妆。
进行手势识别。
相关设置接口
setVideoQosPreference
设置网络流控相关参数。
void setVideoQosPreference(TRTCCloudDef.TRTCNetworkQosParam preference);
参数如下表所示：
参数 | 类型 | 含义 |
preference | TRTCCloudDef.TRTCNetworkQosParam | 网络流控策略。 |
setAudioQuality
设置音质。
void setAudioQuality(int quality);
参数如下表所示：
参数 | 类型 | 含义 |
quality | int |
setVideoResolution
设置分辨率。
void setVideoResolution(int resolution);
参数如下表所示：
参数 | 类型 | 含义 |
resolution | int |
setVideoFps
设置帧率。
void setVideoFps(int fps);
参数如下表所示：
参数 | 类型 | 含义 |
fps | int | 视频采集帧率。 |
说明：
推荐取值：15fps或20fps，5fps以下，卡顿感明显。10fps以下，会有轻微卡顿感。20fps以上，则过于浪费（电影的帧率为24fps）。
setVideoBitrate
设置码率。
void setVideoBitrate(int bitrate);
参数如下表所示：
参数 | 类型 | 含义 |
bitrate | int |
说明：
推荐取值：请参考 TRTCVideoResolution 在各档位注释的最佳码率，也可以在此基础上适当调高。 例如 TRTC_VIDEO_RESOLUTION_1280_720 对应1200kbps的目标码率，您也可以设置为1500kbps以便获得更好的清晰度观感。
enableAudioEvaluation
启用音量大小提示。
void enableAudioEvaluation(boolean enable);
参数如下表所示：
参数 | 类型 | 含义 |
enable | boolean | true：打开，false：关闭。 |
说明：
开启后会在 onUserVolumeUpdate 中获取到 SDK 对音量大小值的评估。
setAudioPlayVolume
设置播放音量。
void setAudioPlayVolume(int volume);
参数如下表所示：
参数 | 类型 | 含义 |
volume | int | 播放音量，0-100， 默认100。 |
setAudioCaptureVolume
设置麦克风采集音量
void setAudioCaptureVolume(int volume);
参数如下表所示：
参数 | 类型 | 含义 |
volume | int | 采集音量，0-100， 默认100。 |
startFileDumping
开始录音。
void startFileDumping(TRTCCloudDef.TRTCAudioRecordingParams trtcAudioRecordingParams);
参数如下表所示：
参数 | 类型 | 含义 |
trtcAudioRecordingParams | TRTCCloudDef.TRTCAudioRecordingParams |
说明：
该方法调用后， SDK 会将通话过程中的所有音频（包括本地音频，远端音频，BGM 等）录制到一个文件里。无论是否进房，调用该接口都生效。如果调用 leaveRoom 时还在录音，录音会自动停止。
stopFileDumping
停止录音。
void stopFileDumping();
获取 SDK 版本接口
getSdkVersion
获取 SDK 版本信息。
int getSdkVersion();
错误事件回调
onError
void onError(int code, String message);
参数如下表所示：
参数 | 类型 | 含义 |
code | int | 错误码。 |
message | String | 错误信息。 |
基础事件回调
onDestroyRoom
房间解散回调。
void onDestroyRoom();
onUserVoiceVolume
用户音量大小回调。
void onUserVoiceVolume(String userId, int volume);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
volume | int | 用户的音量大小，取值范围 0 - 100。 |
onRoomMasterChanged
主持人更改回调。
void onRoomMasterChanged(String previousUserId, String currentUserId);
参数如下表所示：
参数 | 类型 | 含义 |
previousUserId | String | 更改前的主持人用户 ID。 |
currentUserId | String | 更改后的主持人用户 ID。 |
远端用户回调事件
onRemoteUserEnter
远端用户进入房间回调。
void onRemoteUserEnter(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onRemoteUserLeave
远端用户离开房间回调。
void onRemoteUserLeave(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onRemoteUserCameraAvailable
远端用户是否开启摄像头视频。
void onRemoteUserCameraAvailable(String userId, boolean available);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
available | boolean | true：有视频流数据；false：无视频流数据。 |
onRemoteUserScreenVideoAvailable
成员开启/关闭视频分享的通知。
void onRemoteUserScreenVideoAvailable(String userId, boolean available);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
available | boolean | 是否有屏幕分享流数据。 |
onRemoteUserAudioAvailable
远端用户是否开启音频上行回调。
void onRemoteUserAudioAvailable(String userId, boolean available);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
available | boolean | 是否有音频数据。 |
onRemoteUserEnterSpeechState
远端用户开始发言。
void onRemoteUserEnterSpeechState(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onRemoteUserExitSpeechState
远端用户结束发言。
void onRemoteUserExitSpeechState(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
聊天室消息事件回调
onReceiveChatMessage
收到文本消息。
void onReceiveChatMessage(String userId, String message);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
message | String | 文本消息。 |
onReceiveRoomCustomMsg
收到自定义消息。
void onReceiveRoomCustomMsg(String userId, String data);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
message | String | 自定义消息。 |
场控消息回调
onReceiveSpeechInvitation
用户收到主持人发言邀请回调。
void onReceiveSpeechInvitation(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 主持人用户 ID。 |
onReceiveInvitationCancelled
用户收到主持人取消发言邀请回调。
void onReceiveInvitationCancelled(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 主持人用户 ID。 |
onReceiveSpeechApplication
主持人收到用户发言申请的回调。
void onReceiveSpeechApplication(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onSpeechApplicationCancelled
用户取消申请发言回调。
void onSpeechApplicationCancelled(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onSpeechApplicationForbidden
主持人禁止申请发言回调。
void onSpeechApplicationForbidden(boolean isForbidden);
参数如下表所示：
参数 | 类型 | 含义 |
isForbidden | boolean | 是否禁止。 |
onOrderedToExitSpeechState
参会成员被请求停止发言的回调。
void onOrderedToExitSpeechState(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 主持人用户 ID。 |
onCallingRollStarted
主持人开始点名，参会成员收到的回调。
void onCallingRollStarted(String userId);
onCallingRollStopped
主持人结束点名，参会成员收到的回调。
void onCallingRollStopped(String userId);
onMemberReplyCallingRoll
参会成员回复点名，主持人收到的回调。
void onMemberReplyCallingRoll(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
onChatRoomMuted
主持人更改聊天室是否禁言回调。
void onChatRoomMuted(boolean muted);
参数如下表所示：
参数 | 类型 | 含义 |
muted | boolean | 是否禁用。 |
onMicrophoneMuted
主持人设置禁用麦克风回调。
void onMicrophoneMuted(boolean muted);
参数如下表所示：
参数 | 类型 | 含义 |
muted | boolean | 是否禁用。 |
onCameraMuted
主持人设置禁用摄像头回调。
void onCameraMuted(boolean muted);
参数如下表所示：
参数 | 类型 | 含义 |
muted | boolean | 是否禁用。 |
onReceiveKickedOff
主持人踢人的回调。
void onReceiveKickedOff(String userId);
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 主持人/管理员 用户 ID。 |
统计和质量回调
onStatistics
技术指标统计回调。
void onStatistics(TRTCStatistics statistics);
参数如下表所示：
参数 | 类型 | 含义 |
statis | TRTCStatistics | 统计数据。 |
onNetworkQuality
网络状况回调。
void onNetworkQuality(TRTCCloudDef.TRTCQuality localQuality, List<TRTCCloudDef.TRTCQuality> remoteQuality);
参数如下表所示：
参数 | 类型 | 含义 |
localQuality | TRTCCloudDef.TRTCQuality | 上行网络质量。 |
remoteQuality | List&lt;TRTCCloudDef.TRTCQuality&gt; | 下行网络质量。 |
说明：
详情请参见 TRTC SDK
屏幕分享事件回调
onScreenCaptureStarted
开始屏幕分享回调。
void onScreenCaptureStarted();
onScreenCaptureStopped
停止屏幕分享回调。
void onScreenCaptureStopped(int reason);
参数如下表所示：
参数 | 类型 | 含义 |
reason | int | 停止原因，0：用户主动停止；1：被其他应用抢占导致停止。 |
是
否
本页内容是否解决了您的问题？