开发准备
接入之前
浏览器只允许 localhost 或者 https 页面访问媒体设备(摄像头等),请先检查确保在该环境下运行 SDK。
接入流程
在开始编写代码之前,请先确认您已经对这个产品有了大概的了解,并且已经完成了 七牛实时音视频云接入流程。
当您已经可以随时生成实时音视频云的 RoomToken 时(在控制台手动生成,或者调用后端生成都可以), 就认为完成了接入流程,可以准备开发工作了
引入 SDK
我们提供了两种方式引入方式,您可以直接下载 JS 文件,也可以通过 npm
完成引入
NPM 安装
运行下方的命令即可通过 npm
引入我们的 SDK
npm install --save qnweb-rtc
如果想要更新到最新版本或者指定版本,运行下列命令
npm install --save qnweb-rtc@latest # 最新版本
npm install --save qnweb-rtc@4.0.0 # 指定版本
我们更加推荐您使用 yarn 来管理 npm 模块
通过yarn add qnweb-rtc
引入 SDK,通过yarn add qnweb-rtc@latest
来更新版本
安装好后,运行以下代码访问 SDK 的入口
import QNRTC from "qnweb-rtc";
console.log("current version is", QNRTC.VERSION);
运行时看到打印的 current version
表示引入成功
注意!我们默认提供的是 没有 polyfill 的 ECMAScript 5 代码。
直接导入 JS 文件
每次发布版本,我们都会将最新的 SDK JS 文件放在我们的 Github 上,点击链接即可获取当前最新的 SDK JS 文件。 所以,每次想要升级版本时,只需要访问我们的 Github 页面,然后替换一下自己的 js 文件即可。
如果想要使用特定版本的 SDK,可以访问我们 Github 的 Release 页面查看。
SDK 的 JS 文件在导入页面后,会自动创建一个全局对象 QNRTC
,这个对象的成员包括了 SDK 所导出的所有模块和对象。
// 当页面资源加载完成后
window.onload = () => {
console.log("current version is", QNRTC.VERSION);
}
运行时看到打印的 current version
表示引入成功。
文档反馈
(如有产品使用问题,请 提交工单)