集成SDK
- webSDK支持直接集成静态库,也可以使用npm包管理器安装。
1. 使用npm包管理器安装
- npm包名:@cloudroom/web-rtc-sdk
- 使用npm包安装SDK,接口对应开发文档中的接口名需要去掉前面的 "CRVideo_"。
npm install @cloudroom/web-rtc-sdk
import RTCSDK from '@cloudroom/web-rtc-sdk'
// 先注册所有需要的回调接口
RTCSDK.LoginSuccess.callback = (UID,cookie)=> {
// ...
}
RTCSDK.LoginFail.callback = (sdkErr)=> {
// ...
}
// 主调
RTCSDK.Init().then(()=> {
RTCSDK.SetSDKParams('SDK params');
RTCSDK.SetServerAddr('SDK server address');
RTCSDK.Login('login params')
}).catch((err) => {
// ...
})
...
2. 直接集成JS静态库
- 下载SDK包,解压后得到如下目录结构:
├── ...
├── ...
├── SDK
├── ├── VirtualBackgroundSource 虚拟背景资源文件
├── ├── RTCSDKV2.min.js SDK js
│ └── RTCSDKV2.min.js.map SDK map文件
├── ...
└── ...
在html项目中引入SDK
- 如果您的项目是原生html,则用<script>标签引入SDK即可
<script src="./SDK/RTCSDKV2.min.js"></script>
在webpack项目中引入SDK
- 如果您的项目是webpack构建,则需先安装插件
npm install add-asset-html-webpack-plugin --save-dev
# 或
yarn add add-asset-html-webpack-plugin --dev
AddAssetHtmlPlugin 是一个 Webpack 插件,用于将静态资源(如 JS、CSS 文件)自动添加到 HTML 文件中,它通常与 HtmlWebpackPlugin 一起使用
const HtmlWebpackPlugin = require('html-webpack-plugin');
const AddAssetHtmlPlugin = require('add-asset-html-webpack-plugin');
module.exports = {
// ...其他webpack配置
plugins: [
new HtmlWebpackPlugin(),
new AddAssetHtmlPlugin({
filepath: require.resolve('./SDK/RTCSDKV2.min.js'),
})
]
};
在vue项目中引入SDK
- 如果您的项目是vue项目,则可以直接在main.js中引入SDK
import './SDK/RTCSDKV2.min.js'
- 您也可以通过修改vue.config.js,使用AddAssetHtmlPlugin插件引入SDK
npm install add-asset-html-webpack-plugin --save-dev
# 或
yarn add add-asset-html-webpack-plugin --dev
// 修改vue.config.js
const path = require('path')
const AddAssetHtmlPlugin = require('add-asset-html-webpack-plugin')
module.exports = {
chainWebpack: config => {
// 添加 AddAssetHtmlPlugin 插件
config.plugin('AddSDK')
.use(
new AddAssetHtmlPlugin({
filepath: resolve("./SDK/RTCSDKV2.min.js"),
})
)
}
}
- 无论使用何种方式引入SDK,都需要能全局调用,既所有接口均挂载在window对象上
// 先注册所有需要的回调接口
CRVideo_LoginSuccess.callback = (UID,cookie) => {...}
CRVideo_LoginFail.callback = (sdkErr) => {...}
...
// 主调
CRVideo_Init().then(()=> {
CRVideo_SetSDKParams('SDK params');
CRVideo_SetServerAddr('SDK server address');
CRVideo_Login('login params');
...
}).catch((err) => {
// ...
})