更新记录

2.4.0(2024-06-07)

新增

  • 发布 TencentCloud-TUIRoomEngine v 2.4.0

0.0.1(2024-05-31)

发布 TencentCloud-TUIRoomEngine v 0.0.1


平台兼容性

Android Android CPU类型 iOS
适用版本区间:4.4 - 14.0 armeabi-v7a:未测试,arm64-v8a:未测试,x86:未测试 适用版本区间:12 - 17

原生插件通用使用流程:

  1. 购买插件,选择该插件绑定的项目。
  2. 在HBuilderX里找到项目,在manifest的app原生插件配置中勾选模块,如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码,在代码中引用插件,调用插件功能。
  4. 打包自定义基座,选择插件,得到自定义基座,然后运行时选择自定义基座,进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项:使用HBuilderX2.7.14以下版本,如果同一插件且同一appid下购买并绑定了多个包名,提交云打包界面提示包名绑定不一致时,需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择


TUIRoomKit App 示例工程快速跑通

本文档主要介绍如何快速跑通 TUIRoomKit 示例工程,体验多人音视频互动,更详细的 TUIRoomKit 组件接入流程,请点击腾讯云官网文档:TUIRoomKit 组件 uniapp(客户端) 接入说明

环境准备

  • 建议使用最新的 HBuilderX 编辑器 。
  • iOS 9.0 或以上版本且支持音视频的 iOS 设备,暂不支持模拟器。
  • Android 版本不低于 4.1 且支持音视频的 Android 设备,暂不支持模拟器。如果为真机,请开启允许调试选项。最低兼容 Android 4.1(SDK API Level 16),建议使用 Android 5.0 (SDK API Level 21)及以上版本。
  • iOS/Android 设备已经连接到 Internet。

步骤一:开通多人音视频互动服务

在使用 TUIRoomKit 发起会议前,您需要开通 TUIRoomKit 专属的多人音视频互动服务,详细步骤如下:

  1. 登录 实时音视频 TRTC 控制台,单击左侧应用管理页面,找到需要开通 TUIRoomKit 的应用(SDKAppID),点击详情,进入应用概览界面。

  2. 在应用概览页面找到含 UI 低代码集成接入 卡片,选择多人音视频(TUIRoomKit),点击领取体验,领取7天体验版 TUIRoomKit 进行接入测试。

    注意:

    • 领取体验版后仅开通 TUIRoomKit 7天的体验资格,测试过程中所产生的音视频时长等资源消耗,仍会按照实时音视频 TRTC 标准计费规则计费;
    • 新账号首次可前往 试用中心 免费领取10000分钟音视频时长;
    • 如果所选 SDKAppID 体验版领取次数已达上限,需要购买 TUIRoomKit 包月套餐才能开通服务,请点击场景套餐订阅按钮或前往 购买页 购买;

  3. 领取完成后,可以看到体验版的基本信息,包括服务状态、版本信息和功能详情、到期时间。

  4. 单击集成指南,即可参照集成指南开始集成。至此 TUIRoomKit 服务开通完成。

步骤二:下载源码,配置工程

  1. 克隆或者直接下载此仓库源码,欢迎 Star,感谢~~

    git clone https://github.com/tencentyun/TUIRoomKit.git
  2. 找到并打开 TUIRoomKit/uni-app/src/roomkit/config/basic-info-config.js 文件。

  3. 配置 basic-info-config.js 文件中的相关参数

    • SDKAPPID:默认为 0,请设置为步第一步中记录下的 SDKAppID。
    • SDKSECRETKEY:默认为 '',请设置为步第一步中记录下的密钥信息。
  4. 安装依赖

    HBuilderX 创建的工程不会默认创建 package.json 文件,因此您需要先创建 package.json 文件。新建终端,如下:

      cd TUIRoomKit/uni-app
      npm init -y
      npm i @tencentcloud/tuiroom-engine-uniapp-app @tencentcloud/universal-api mitt pinia --save

    步骤三:下载并导入 TUIRoomEngine 插件

  5. 登录 uni 原生插件市场,并访问 TencentCloud-TUIRoomEngine 插件,在插件详情页中购买(TencentCloud-TUIRoomEngine 为免费插件)。购买后才能够云端打包使用插件。 >购买插件时请选择正确的 appid,以及绑定正确包名

  6. 购买插件后在应用的 manifest.json 页面的 App原生插件配置项下单击选择云端插件,选择腾讯云原生音视频插件。

步骤四:开启您的第一场会议

  1. 制作自定义调试基座,请选择传统打包方式进行打包。
  1. 自定义调试基座成功后,使用自定义基座运行项目。
  1. 在主持人端,您可以创建会议,而普通成员可以加入已创建的会议。画面如下

主持人端:

普通成员端:

联系我们

如果您在接入或使用过程中有任何需要或者反馈,欢迎加入 TUIRoomKit 技术交流群 进行技术交流和问题反馈。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

安卓:摄像头,语音,本地存储空间 IOS:摄像头,语音,本地存储空间

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

插件使用的 TRTC SDK会采集数据,详情可参考:https://www.qcloud.com

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

请参考开源项目地址的开源协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问