跑通示例项目
更新时间: 2024/08/02 11:26:48
网易云信音视频通话 2.0 产品为您提供开源的的示例项目,您可以参考本文档快速跑通示例项目,快速在本地运行示例 Demo,体验 NERTC SDK 的实时音视频通话的效果。
前提条件
在开始运行示例项目之前,请确保您已完成以下操作:
- 已创建应用并获取 App Key。
- 已开通音视频通话 2.0 服务。
- 集成 SDK。
- 联系技术支持进行初始化配置,例如开通调试模式等。
开发环境
在开始运行示例项目之前,请确保开发环境满足以下要求:
- 安全环境:https 环境或者本地连接 localhost/127.0.0.1 环境。
- 浏览器:Chrome 72 及以上版本、Safari 12 及以上版本。
- React 16.8及以上版本;node.js 版本为 12 或以上版本。
注意事项
- 跑通示例项目时,建议维持 Demo 的 baseURL 设置,如果需要基于 Demo 开发自己的应用,需要将其改为您的 App Server 业务服务端地址。
- 示例项目默认使用安全模式。但是在跑通示例项目时,您需要使用调试模式, 在 rtc.ts 中把token 设为空。此时无需传入 Token 即可加入房间。但是出于安全考虑,应用正式上线前,请在控制台中将指定应用的鉴权方式改回安全模式。
示例项目结构
项目结构中的文件说明如下:
文件夹/文件 | 说明 |
---|---|
NERtcSample-MultipersonCall.pro |
工程配置文件,其中包含三方库等配置。 |
rtc | SDK 封装,其中包含了美颜管理器、设备管理器、事件处理器等模块。 |
http | http 封装,其中包含了 get、post 网络请求。 |
view | 主要包含多人视频通话上层业务逻辑。 |
运行示例源码
在 Demo 体验页面 下载需要体验的示例项目或 Demo 源码工程。
-
集成 Web SDK。
- 下载 Web 端 SDK 文件。
- 拷贝
NIM_Web_NERTC_v4.x.x.js
到 assets 文件夹下。
-
在
config/index.ts
文件中配置 AppKey、appSecret。请填写您自己的应用 AppKey 和 AppSecret。跑通示例项目时,建议维持 Demo 的 baseURL 设置,如果需要基于 Demo 开发自己的应用,需要将其改为您的 App Server 业务服务端地址。
export default { appkey: '', appSecret: '', baseUrl: '', };
-
执行以下命令安装依赖。
npm install
-
运行示例项目。
npm start
-
体验示例项目。
- 在浏览器中打开
https://localhost:8000/#/
访问项目。 - 提供扬声器和摄像头的权限。
- 加入房间、体验多人视频通话功能。
- 在浏览器中打开
常见问题
加入房间失败,应如何处理?
加入房间失败时,请根据失败的报错信息,检查本地环境中是否缺少扬声器或摄像头。 如果排查困难,请收集失败的报错信息,并联系技术支持处理。
此文档是否对你有帮助?