集成SDK
开发环境准备
前提条件
- 操作系统:win/mac/linux
- Node.js >= 14
- npm >= 7
- Electron >= 5
离线安装(推荐)
-
将下载的SDK文件夹导入到项目根目录

-
将下列代码拷贝至项目主进程中
// main.js const { app, ipcMain } = require("electron"); const path = require("path"); // 获取SDK路径给渲染进程 ipcMain.handle("getSdkPath", () => { let rootDir; if (app.isPackaged) { // 生产环境:返回resources目录 rootDir = process.resourcesPath; } else { // 开发环境:返回项目根目录 rootDir = app.getAppPath(); } const sdkPath = path.join(rootDir, "RTCSDK/index.js"); console.log("sdk path:", sdkPath); return sdkPath; }); -
在渲染进程中新建
RTCSDK.js,代码如下//RTCSDK.js const { ipcRenderer } = require("electron"); let rtcsdk; // 获取是否打包状态 async function load() { // 获取SDK路径,动态导入 const RTCSDKPath = await ipcRenderer.invoke("getSdkPath"); const RTCSDK = require(RTCSDKPath); rtcsdk = new RTCSDK(); return rtcsdk; } export function getRTCSDK() { //首次调用时是返回Promise,后续再调用是返回SDK实例 return rtcsdk || load() } -
建立渲染进程窗口时,添加如下图配置

-
最后在渲染进程中获取SDK实例
import { getRTCSDK } from "./RTCSDK.js"; //首次调用返回Promise,可以在渲染进程main中先调用 getRTCSDK().then((rtcsdk) => { console.log("插件版本:", rtcsdk.version); }); //后续再获取SDK实例 const rtcsdk = getRTCSDK(); console.log("插件版本:", rtcsdk.version); -
如果在项目中没有虚拟背景和美颜的需求,为了节省程序安装包体积,可以手动删除如下目录
/RTCSDK/plugin/${systom}_${arch}/plugins/CRVBG虚拟背景插件/RTCSDK/plugin/${systom}_${arch}/plugins/CRBeauty美颜插件
-
以上开发环境准备工作结束,在后续构建过程中如果使用
electron-builder,您还需要在electron-builder.json中添加extraResources配置// electron-builder.json { "appId": "com.rtc.electronApiDemo", "asar": true, "icon": "electron/icon.png", "artifactName": "${productName}_${version}_${arch}.${ext}", //构建时拷贝SDK到资源目录 "extraResources": [ { "from": "RTCSDK", "to": "RTCSDK", "filter": ["index.js", "plugin/${os}_${arch}/**/*"] } ], //... }
在线安装
- 如需使用美颜或者虚拟背景功能,无需使用可略过此步骤。
在您项目package.json中添加以下配置,在安装SDK时,会自动下载并集成相关功能模块。
如果装包后再配置package.json将不生效,请重新安装SDK。
{
"name": "your-project",
"version": "1.0.0",
//...
"rtcConfig": {
"CRVBG": ["win"], // 集成虚拟背景功能,不需要可删除这行
"CRBeauty": ["win"] // 集成美颜功能,不需要可删除这行
}
}
- 在已有Electron项目中,安装
@cloudroom/electron-rtcsdk包
npm install -S @cloudroom/electron-rtcsdk
- 您可以通过以下方式将 SDK 引入至您的项目中。
import RTCSDK from "@cloudroom/electron-rtcsdk";
const rtcsdk = new RTCSDK();
console.log("插件版本:", rtcsdk.version);
至此,集成工作已经完成,可以开始实现音视频通话了。