uni-app

最近更新时间:2025-08-13 17:33:22

我的收藏

开发环境要求

请根据 uni-app 原生语言插件 使用教程,学习如何在您的 uni-app 项目中引入原生语言插件。
iOS 版本要求:11+
Android API 要求:21+

前提条件

您已 注册腾讯云 账号,并完成 实名认证

Demo 及源码

为了帮助您更好地了解一个集成了腾讯云实时互动-教育版 uni-app 插件的应用,我们准备了 Demo 及配套源码供您参考。您可以查看 GitHub 获取源码

直接安装体验 Demo

若您使用 Android 设备,可扫码下载安装我们打包好的 uni-app 项目直接体验进入课堂。

进入应用后,如下截图所示。您可直接复制我们 线上 Demo 创建的课堂 信息,进入 uni-app native 版本课堂。
也可直接将课堂链接 (需要手动在末尾添加 &token=${通过 F12 打开 Console 进入网络请求 Network 内课堂请求 payload 来查看 token}) 贴入并自动解析参数。


操作步骤

步骤一:创建新的应用

1. 登录 实时互动-教育版 控制台,进入左侧导航栏的概览,选择新建应用
2. 若尚未创建应用,则默认进入“创建应用”界面,输入应用名称,例如 TestLCIC。

若您已创建应用,可前往应用管理中,选择使用已有应用即可。

说明:
移动端需要购买旗舰版或企业尊享版后方可接入。若需创建商用应用,可根据业务需求在 购买页 创建对应版本的应用。
应用名称只允许下划线、数字或中英文字符。

步骤二:获取 SDKAppId 和密钥(SecretKey)

1. 进入应用管理 > 应用配置,获取 SDKAppId
2. 进入 访问管理(CAM)控制台 获取密钥,若无密钥,需要在 API 密钥管理中进行新建,具体可参见 访问密钥管理




步骤三:导入 SDK

1. 前往购买 TRTC 免费插件 腾讯云实时音视频SDK (插件1),并选择该插件绑定的项目。
2. 通过 GitHub 仓库 ,获取腾讯云实时互动-教育版 uniapp 插件包 (插件2) ,将其中 lcic-sdk-pro 本地引入,放置在项目 nativeplugins 文件夹下。如果项目没有该文件夹,请手动创建一个。
3. 在 HBuilderX 里找到项目,在 manifest 的 app 原生插件配置中勾选如上两个插件(插件1 & 插件2),如下图所示。

更新说明:
我们的 Native SDK 会不定期更新,请多关注 本项目 GitHub 仓库,如果有更新,建议下载后替换本地项目 nativeplugins 中的插件包。

步骤四:SDK 授权申请

需要您提交 腾讯云工单,向我们发送 SDK 权限申请。请按下表模板提供对应信息。在信息确认无误的情况下,我们将会在1个工作日完成。
注意:
一个旗舰版仅支持授权一个正式包名,请确认无误后发送相关信息。
包名用于 x5 内核以及快直播播放器签名授权,请提供所需授权的正式应用的 App Name、Package Name 和 Bundle ID 信息。
分类
说明
问题标题
实时互动-教育版 Android SDK 授权申请
问题主要内容
公司名称。如,xxx 有限公司。
个人姓名
联系方式
App Name
Package Name (Android)
Bundle ID (iOS)

步骤五:初始化 X5 内核

X5 内核相对于系统 WebView,具有兼容性更好,速度更快等优势。Android 实时互动-教育版 SDK 的组件实现依赖于 X5 内核的 WebView。现提供 X5 内核静态集成方式,能提升 X5 内核加载成功率且无需进程重启即可生效。
1. 检查同意隐私政策协议。
注意:
建议在同意隐私政策协议之后,再调用初始化 X5 内核的方法,以免上架应用市场时出现未经用户同意收集个人信息的情况。
2. 初始化 X5 内核。进入课堂前,必须保证该方法执行完毕。无论成功与否,后续都可正常进入课堂。如果初始化失败,进入课堂采用兜底 WebView 方案。
const lcicModule = uni.requireNativePlugin('lcic-sdk-pro');

lcicModule.initX5Core({
licenseKey: "" // 申请的 X5 LicenseKey
},
(ret) => {
if (ret && ret.code === 0) {
// X5 内核初始化成功. 后续进入课堂走 X5 内核方案.
} else {
// X5 内核初始化失败. 后续进入课堂走兜底 Webview 方案.
}
}
注意:
initX5Core 中的 licenseKey 参数需要通过 步骤四 提交工单联系我们获取 X5 内核的 licenseKey。
如果出现X5初始化失败,可及时 联系我们

步骤六:获取进入课堂所需参数

joinClass 参数解释:
通过 控制台 进入应用管理 > 应用配置,获取 SDKAppId ,即为学校编号(schoolId)信息。
通过云 API 接口 CreateRoom 创建课堂,可以获取到课堂号(classid)信息。
通过调用云 API 接口 RegisterUser 注册用户,可以获取到对应的用户 ID(userid)信息。
通过云 API 接口 LoginUser 登录,可以获取到用户鉴权 token 信息。
scene、lng、camera、mic、speaker 为非必要参数,如果不设置则使用的是默认值。
字段
类型
必填
含义
备注
schoolId
int
学校编号
通过控制台进入应用管理 > 应用配置,获取 SDKAppId
classId
long
课堂编号
通过 CreateRoom 接口创建返回 RoomId 获取。
userId
string
用户账号
通过 RegisterUser 接口获取。
token
string
后台鉴权参数
通过 LoginUser 接口获取。
scene
string
场景名称
用于区分不同的定制布局,通过 SetAppCustomContent 接口配置。
lng
string
语言参数
当前支持中文(简体)、中文(繁体) 、English、韩语、日语、阿拉伯语、越南语、印尼语。可拼接相应参数,展示对应语种。参数:zh-CN、zh-TW、en-US、ka、ja、ar、vi、id。
camera
int
初始化开启摄像头
1为开启摄像头,0为关闭摄像头,默认 1。
mic
int
初始化开启麦克风
1为开启麦克风,0为关闭麦克风,默认 1。
speaker
int
初始化开启扬声器
1为开启扬声器,0为关闭扬声器,默认 1。

步骤七:调起组件主页面

只需传递 4 个参数就可调起 LCIC 组件主页面,分别为学校编号、课堂编号、用户账号和 token。
说明:
schoolIdSDKAppId
const lcicModule = uni.requireNativePlugin('lcic-sdk-pro');

lcicModule.joinClass({
schoolId: schoolId,
userId: userId,
token: token,
classId: classId,
// 其他更多可选参数, 可参考步骤六
},
(res) => {
// 进入课堂成功
}
);

步骤八:运行项目

调试阶段,您可创建包含 TRTC 及腾讯云实时互动-教育版两个插件的自定义基座。
调试完成后,可使用云打包等方式,打包并导出项目。