Tencent Cloud

Recent Pages

Android

最后更新时间：2023-09-14 14:51:17

本文将介绍如何用最短的时间完成 TUIRoomKit 组件的接入，跟随本文档，您将在一个小时的时间内完成如下几个关键步骤，并最终得到一个包含完备 UI 界面的音视频会议功能。
环境准备
最低兼容 Android 4.1（SDK API Level 16），建议使用 Android 5.0 （SDK API Level 21）及以上版本。
Android Studio 3.5 及以上的版本（Gradle 3.5.4 及以上的版本）。
Android 4.1 及以上的手机设备。
步骤一：开通服务
TUIRoomKit 当前处于内测阶段，SDK 能力限时免费使用，更多产品内测说明，请查看 关于多人音视频 Conference 开启内测公告。
首先请在 TRTC 控制台 创建应用，并记录 SDKAppID 和 SecretKey 参数，这些参数在后续接入过程中会被使用，创建应用及参数位置如下图所示：
﻿
﻿
﻿
步骤二：集成 TUIRoomKit 组件
1. 在 Github 中克隆/下载代码，然后拷贝 Android 目录下的debug 、timcommon、 tuichat、 tuicore、 tuiroomkit 、tuivideoseat子目录到您当前工程中的 app 同级目录中。
2. 工程根目录下找到 setting.gradle 文件，并在其中增加如下代码，它的作用是将tuiroomkit 作为本地模块导入到您当前的项目中。
include ':debug'
include ':timcommon'
include ':tuichat'
include ':tuicore'
include ':tuiroomkit'
include ':tuivideoseat'
3. 在 app 目录下找到 build.gradle 文件，并在其中增加如下代码，它的作用是声明当前 app 对新加入的 tuiroomkit 组件的依赖。
api project(':tuiroomkit')
说明
TUIRoomKit 依赖于 TRTC SDK 与 IM SDK ，在使用过程中，请在您的工程的根目录 build.gradle 添加如下代码：
ext {
    imSdk = "com.tencent.imsdk:imsdk-plus:latest.release"
    liteavSdk = "com.tencent.liteav:LiteAVSDK_TRTC:latest.release"
    roomEngineSdk = "com.tencent.liteav.tuikit:tuiroomengine:latest.release"
}
由于我们在 SDK 内部使用了Java 的反射特性，需要将 SDK 中的部分类加入不混淆名单，因此需要您在 proguard-rules.pro 文件中添加如下代码：
-keep class com.tencent.** { *; }
注意
TUIRoomKit 会在内部帮助您动态申请相机、麦克风、读取存储权限等，如果因为您的业务问题需要删减，可以请修改tuiroomkit/src/main/AndroidManifest.xml。
步骤三：登录 TUIRoomKit 组件
在您的项目中添加如下代码，它的作用是通过调用TUIRoomKit 中的相关接口完成组件的登录。这个步骤异常关键，因为只有在登录后才能正常使用 TUIRoomKit 的各项功能，故请您耐心检查相关参数是否配置正确：
TUIRoomKit.sharedInstance(context).login(1400000001,    // 请替换为步骤一取到的 SDKAppID
                                         "998",         // 请替换为您的 UserID
                                         "xxxxxxxxxx"); // 您可以在控制台中计算一个 UserSig 并填在这个位置
参数说明
这里详细介绍一下 login 函数中所需要用到的几个关键参数：
SDKAppID：在步骤一中您已经获取到，这里不再赘述。
UserID：当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。
UserSig：使用步骤一获取的 SecretKey 对 SDKAppID、UserID 等信息进行加密，就可以得到 UserSig，它是一个鉴权用的票据，用于腾讯云识别当前用户是否能够使用 TRTC 的服务。您可以通过控制台总览页中顶部的 UserSig 生成功能，创建一个临时可用的 UserSig。
﻿
﻿
更多信息请参见 UserSig 相关。
注意：
这个步骤也是目前我们收到的开发者反馈最多的步骤，常见问题如下：
SDKAppID 设置错误，请正确使用国际站点的 SDKAppID，否则会无法接入。
UserSig 被错配成了加密密钥（SecretKey），UserSig 是用 SecretKey 把 SDKAppID、UserID 以及过期时间等信息加密得来的，而不是直接把 SecretKey 配置成 UserSig。
UserID 被设置成“1”、“123”、“111”等简单字符串，由于 TRTC 不支持同一个 UserID 多端登录，所以在多人协作开发时，形如 “1”、“123”、“111” 这样的 UserID 很容易被您的同事占用，导致登录失败，因此我们建议您在调试的时候设置一些辨识度高的 UserID。
Github 中的示例代码使用了 genTestUserSig 函数在本地计算 UserSig 是为了更快地让您跑通当前的接入流程，但该方案会将您的 SecretKey 暴露在 App 的代码当中，这并不利于您后续升级和保护您的 SecretKey，所以我们强烈建议您将 UserSig 的计算逻辑放在服务端进行，并由 app 在每次使用 TUIRoomKit 组件时向您的服务器请求实时计算出的 UserSig。
步骤四：使用 TUIRoomKit
设置用户信息
通过调用 TUIRoomKit 的 setSelfInfo 即可设置用户的用户名、头像。
public abstract void setSelfInfo(String userName, String avatarURL);
参数
类型
含义
userName
String
用户名
avatarURL
String
用户头像 URL
准备页面（可选）
通过调用 TUIRoomKit 的 enterPrepareView 就可以进入准备页面。
boolean enablePreview=true; // 是否开启视频预览，不需预览则设置为false
TUIRoomKit.sharedInstance(context).enterPrepareView(enablePreview);
参数
类型
含义
enablePreview
boolean
是否开启视频预览
创建房间
通过调用 TUIRoomKit 的 createRoom 方法并指定房间的类型为TUIRoomKit.UIScene.MEETING，就可以创建房间。
 public enum RoomScene {   
     MEETING, // 会议类型的房间
     LIVE     // 直播类型的房间
 }
 public class RoomInfo {   
     public String  name;                                   // 房间名称，仅房主可设置
     public String  owner;                                  // 房主id，无需设置，进房后可自动获取
     public String  roomId;                                 // 房间号
     public boolean isOpenCamera;                           // 进房是否开启摄像头
     public boolean isUseSpeaker                            // 进房是否开启扬声器
     public boolean isOpenMicrophone;                       // 进房是否开启麦克风
     public boolean isCameraDisableForAllUser = false;       // 房间内是否不允许打开视频，仅房主可设置,默认允许
     public boolean isMicrophoneDisableForAllUser = false;   // 房间内是否不允许打开音频，仅房主可设置,默认允许
     public boolean isMessageDisableForAllUser = false;      // 房间内是否不允许发送弹幕消息，仅房主可设置,默认允许
     public TUIRoomDefine.SpeechMode speechMode = TUIRoomDefine.SpeechMode.FREE_TO_SPEAK;//房间内发言管理模式,默认自由发言
 }
 
 RoomInfo roomInfo = new RoomInfo();
 roomInfo.name = "xx";              // 请设置为您需要的房间名称
 roomInfo.roomId = "998";           // 请设置为您需要的房间号
 roomInfo.isOpenCamera = true;      // 请按照您的业务需求设置
 roomInfo.isOpenMicrophone = true;  // 请按照您的业务需求设置
 roomInfo.isUseSpeaker = true;      // 请按照您的业务需求设置
 
 TUIRoomKit.sharedInstance(context).createRoom(roomInfo, TUIRoomKit.RoomScene.MEETING);
参数
类型
含义
roomInfo
RoomInfo
房间的基本信息
scene
TUIRoomKit.RoomScene
房间类型，示例：TUIRoomKit.RoomScene.MEETING
加入房间
通过调用 TUIRoomKit 的 enterRoom 方法并指定房间类型与房间号，就可以进入指定房间。
﻿
 RoomInfo roomInfo = new RoomInfo();
 roomInfo.roomId = "998";           // 请设置为您要进入的房间号
 roomInfo.isOpenCamera = true;      // 请按照您的业务需求设置
 roomInfo.isOpenMicrophone= true;   // 请按照您的业务需求设置
 roomInfo.isUseSpeaker = true;      // 请按照您的业务需求设置
 
 TUIRoomKit.sharedInstance(context).enterRoom(roomInfo)
参数
类型
含义
roomInfo
RoomInfo
房间的基本信息
说明
加入房间时的 RoomInfo 参数只需关注roomId、isOpenCamera、isOpenMicrophone、isUseSpeaker四个字段，其他字段无需设置。
交流与反馈
如果有任何需要或者反馈，您可以联系：colleenyu@tencent.com。

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

Android

环境准备

步骤一：开通服务

步骤二：集成 TUIRoomKit 组件

步骤三：登录 TUIRoomKit 组件

步骤四：使用 TUIRoomKit

设置用户信息

准备页面（可选）

创建房间

加入房间

交流与反馈

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

参数	类型	含义
userName	String	用户名
avatarURL	String	用户头像 URL

tencent cloud

注册

登录

Recent Pages

Android

环境准备

步骤一：开通服务

步骤二：集成 TUIRoomKit 组件

步骤三：登录 TUIRoomKit 组件

步骤四：使用 TUIRoomKit

设置用户信息

准备页面（可选）

创建房间

加入房间

交流与反馈

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？