- 安装好node环境。https://nodejs.org/dist/v10.14.1/node-v10.14.1-x86.msi
- 按照以下命令执行。
$ git clone https://github.com/zegoim/zego-electron-quick-start.git
$ cd zego-electron-quick-start
$ npm config set registry http://registry.npm.taobao.org/
$ npm install （或者使用 cnpm install 下载依赖速度会快很多）
- 设置国外镜像，并通过代理访问国外镜像的方法是，执行以下命令
$ npm config set registry https://registry.npmjs.org/
// 设置代理
$ npm config set proxy http://127.0.0.1:1080
// 设置https代理
$ npm config set https-proxy http://127.0.0.1:1080
- 设置npm淘宝镜像的方法是，执行以下命令
$ npm config set registry http://registry.npm.taobao.org/
// 删除http代理
$ npm config delete proxy
// 删除https代理
$ npm config delete https-proxy
// 请在 [即构管理控制台](https://console.zego.im/acount) 申请 SDK 初始化需要的 AppID 和 AppSign
// 获取 AppID 和 AppSign 指引](https://doc.zego.im/API/HideDoc/GetAppIDGuide/GetAppIDGuideline.html)。
// app id
const app_id = "";//向zego获取app id，ID为字符串
// app sign
const app_sign = [];//向zego获取测试app_sign，是一个数组，格式例如 [0x01, 0x03, 0x44, ....]
$ npm start
mac 平台打包，不使用签名时使用以下命令禁止
$ export CSC_IDENTITY_AUTO_DISCOVERY=false
$ npm run pkg
-
安装包文件：
zego-electron-quick-start Setup 1.0.0.exe -
未打成安装包的可执行文件目录：
win-ia32-unpacked
-
参考文档末尾
实践章节集成sdk。 -
在工程项目中的renderer.js文件中添加以下代码，引入zego sdk，参考代码
var ZegoLiveRoom = require("zegoliveroom/ZegoLiveRoom.js");
var ZEGOCONSTANTS = require("zegoliveroom/ZegoConstant.js");
- 创建zego client，参考代码
var zegoClient = new ZegoLiveRoom();
- 配置当前环境，参考代码
// 配置设置当前环境为测试环境
zegoClient.setUseEnv({ use_test_env: true });
- 初始化sdk，参考代码
// 初始化sdk
let ret = zegoClient.initSDK({
app_id: app_id, // appid
sign_key: app_sign, // app sign
user_id: TEST_USER_ID, // 用户id
user_name: TEST_USER_NAME // 用户名字
}, rs => {
if (rs.error_code == 0) {
console.log("sdk初始化成功");
} else {
console.log("sdk初始化失败,错误码为：" + rs.error_code);
zegoClient.unInitSDK();
}
});
if (ret) {
console.log("正在初始化...");
} else {
console.log("sdk初始化失败");
zegoClient.unInitSDK();
}
- 登录房间，参考代码
// 登陆房间
let ret = zegoClient.loginRoom({
room_id: TEST_ROOM_ID, // 房间id
room_name: TEST_ROOM_NAME, // 房间名字
role: ZEGOCONSTANTS.ZegoRoomRole.Audience // 房间角色
}, rs => {
console.log("登录结果返回 ", rs);
if (rs.error_code == 0) {
console.log("登录成功");
} else {
console.log("登录失败，错误码为：" + rs.error_code);
}
});
- 选择设备，参考代码
// 获取摄像头设备列表
let video_devices_list = zegoClient.getVideoDeviceList();
console.log("got video devices list:", video_devices_list);
if(video_devices_list.length > 0){
let cur_sel_index = 0; // 设备索引，选择第一个设备
zegoClient.setVideoDevice({
device_id: video_devices_list[cur_sel_index].device_id
});
}
- 预览摄像头，参考代码
// 设置预览view
let set_ret = zegoClient.setPreviewView({
// 设置canvas
canvas_view: document.getElementById("localVideo"),
// 通道索引，默认主通道
channel_index: ZEGOCONSTANTS.PublishChannelIndex.PUBLISH_CHN_MAIN
});
if (set_ret) {
// 开始预览
let preview_ret = zegoClient.startPreview({
channel_index: ZEGOCONSTANTS.PublishChannelIndex.PUBLISH_CHN_MAIN
});
console.log("预览结果", preview_ret);
}
- 开启回音消除、噪音消除和增益，参考代码
// 开启回音消除
zegoClient.enableAEC({enable:true});
// 开启噪音消除
zegoClient.enableANS({enable:true});
// 开启自动增益控制
zegoClient.enableAGC({enable:true});
- 开始推流，发送音视频数据，参考代码
// 开始推流
let ret = zegoClient.startPublishing({
title: "zego electron simple test xx",// 推流标题
stream_id: TEST_PUB_STREAM_ID,// 推流id
// 推流flag，连麦、混流还是单主播
publish_flag: ZEGOCONSTANTS.ZegoPublishFlag.ZEGO_JOIN_PUBLISH,
params: ""// 推流参数
});
- 开始拉流，播放音视频数据，开发过程中，需要传递的流id参数是对方的流id，这里为了演示，拉取的是自己的流id。参考代码
// 开始拉流播放
zegoClient.startPlayingStream({
stream_id: TEST_PLAY_STREAM_ID, // 拉流id
canvas_view: document.getElementById("remoteVideo"), // 设置播放的canvas
params: "" // 拉流参数
});
- 停止拉流播放音视频数据，参考代码
zegoClient.stopPlayingStream({
stream_id: TEST_PLAY_STREAM_ID // 流id
});
- 停止推流发送音视频数据，参考代码
zegoClient.stopPublishing({
// 通道
channel_index: ZEGOCONSTANTS.PublishChannelIndex.PUBLISH_CHN_MAIN
});
- 退出房间，参考代码
zegoClient.logoutRoom(rs => { });
- 反初始化sdk，参考代码
zegoClient.unInitSDK();
-
生产环境中，不打开调试栏，关闭方法为，注释掉main.js的第18行代码，mainWindow.webContents.openDevTools()
-
更多的功能接口和触发通知事件，请查阅工程demo示例和 官网SDK 的 Electron API接口文档。
-
注意点说明
- 推流和拉流：Zego SDK 把采集我方的音视频，编码后发送到 Zego 实时网络，此步骤被称为“推流”。同时，Zego SDK 从 Zego 实时网络中接收对方的音视频数据流，解码得到对方的声音与画面，此步骤被称作“拉流”。通话双方各自推我方流和拉对方流，视频通话就建立起来了。
- 用户id设置：业务保证唯一即可。
- 推流时机：登陆房间成功后，在进行推流操作。
- 拉流时机：在实现过程中，拉取的是对方的流，所以拉流操作传递的流id参数是对方的流id。在onStreamUpdated事件的流新增事件时可以获取到对方的流id。当收到新增流事件时在进行拉流操作。
- 房间登录相关说明，查看官网房间登录。
- 依赖zego sdk 的Electron 工程配置文件package.json完整示例配置如下
{
"name": "zego-electron-quick-start",
"version": "1.0.0",
"description": "A zego electron sdk quick start application",
"main": "main.js",
"scripts": {
"postinstall": "node node_modules/zegodown/bin/zegodown -v 5.0.12-2020-06",
"start": "electron .",
"pkg": "node pkg.js"
},
"keywords": [
"zego",
"electron",
"video",
"audio",
"live"
],
"author": "zego",
"license": "MIT",
"devDependencies": {
"electron": "5.0.12",
"electron-builder": "^20.28.4"
},
"dependencies": {
"zegoliveroom": "1.0.3",
"zegodown": "2.0.13"
},
"build": {
"mac": {
"entitlements": "build/entitlements.mac.plist",
"entitlementsInherit": "build/entitlements.mac.plist",
"extendInfo": {
"NSMicrophoneUsageDescription": "I need access to your microphone to send your voice to others in the session room.",
"NSCameraUsageDescription": "I need access to your camera so that others can see you in the session room."
}
}
}
}
在自己工程项目中集成zego liveroom electron sdk，必须按照以下前三个步骤添加对zego sdk 的依赖，更新sdk请参照第四点操作。
- 一. 需要在dependencies配置中添加zegoliveroom和zegodown的依赖
"dependencies": {
"zegoliveroom": "1.0.3",
"zegodown": "2.0.13"
},
- 二. 在scripts配置中，添加postinstall，配置zegodown下载zego sdk 的指定版本号
"scripts": {
"postinstall": "node node_modules/zegodown/bin/zegodown -v 5.0.12-2020-06"
},
- 三. 配置electron版本号，确保和zegodown配置的zego sdk的前缀版本一致，否则会导致二进制不兼容错误，运行会报错。
"devDependencies": {
"electron": "5.0.12"
},
- 四. 更新zego sdk 的方式 把zegodown 配置后面的版本比如：5.0.9-2020-06更改为5.0.9-20-11，表示从6月份迭代版本更新到11月份迭代版本。然后保存，重新执行npm install，重新npm start运行即可完成对zego sdk的更新。
2020.11.24 Version: 2.0.1
-
新增屏幕采集窗口状态发生变化的回调onScreenCapWindowStateChange。
-
新增检测mac是否有屏幕捕捉的权限checkScreenCaptureAuthority。
-
新增设置混音本地播放音量setAuxPlayVolume。
-
新增设置混音推流音量setAuxPublishVolume。
-
新增设置混音音量setAuxVolume。
-
新增是否启用预览和推流镜像setVideoMirrorMode。
-
新增直推CDN接口setCDNPublishTarget。
-
新增暴露cpu内存使用质量回调。
-
新增网络测速探测模块。
- 修复onCustomCommand回调的request_seq错误的问题。
- 文档更新设置拉流播放音量最大值可以设置到200。
- 1.8.4-20-11
- 1.8.8-20-11
- 2.0.18-20-11
- 3.0.16-20-11
- 3.1.13-20-11
- 4.0.8-20-11
- 4.1.5-20-11
- 4.2.11-20-11
- 4.2.12-20-11
- 5.0.8-20-11
- 5.0.9-20-11
历史版本
- 1.8.4-2020-06
- 1.8.8-2020-06
- 2.0.18-2020-06
- 3.0.16-2020-06
- 3.1.13-2020-06
- 4.0.8-2020-06
- 4.1.5-2020-06
- 4.2.11-2020-06
- 4.2.12-2020-06
- 5.0.8-2020-06
- 5.0.11-2020-06
- 5.0.12-2020-06
- 1.8.4-2020-05
- 1.8.8-2020-05
- 2.0.18-2020-05
- 3.0.16-2020-05
- 3.1.13-2020-05
- 4.0.8-2020-05
- 4.1.5-2020-05
- 4.2.11-2020-05
- 4.2.12-2020-05
- 5.0.8-2020-05
- 5.0.11-2020-05
- 5.0.12-2020-05