实时音视频
  • iOS
  • Android
  • macOS
  • Windows
  • HarmonyOS
  • Linux
  • Web
  • 小程序
  • Flutter
  • Electron : JavaScript
  • Unreal Engine
  • Unity3D
  • uni-app
  • React Native
  • Cocos Creator
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 实现视频通话
    • 场景化音视频配置
  • 通信能力
  • 视频能力
  • 直播能力
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • 实时音视频
  • 快速开始
  • 集成 SDK

集成 SDK

更新时间:2023-12-19 10:51

1 准备环境

在开始集成 ZEGO Express SDK 前,请确保开发环境满足以下要求:

  • 支持 Electron 7.0.0 版本到 23.0.0 版本。
  • 支持 Windows 7 及以上操作系统。
  • 支持 macOS 10.13 及以上操作系统。
  • 支持 x86_64、aarch64、armhf 架构的 Linux 操作系统,如需使用 Linux 平台,请联系 ZEGO 技术支持。
  • 麦克风、摄像头等支持音视频的设备。
  • 设备已经连接到 Internet。
  • 安装 Node.js, 推荐使用其官网首页展示的长期支持版。

2 集成 SDK

2.1 新建项目(可选)

此步骤以如何创建新项目为例,如果是集成到已有项目,可忽略此步。

请参考 Electron 文档 - 快速启动指南 创建一个 Electron 项目。

2.2 安装 SDK

在项目中使用 npm 命令 npm install zego-express-engine-electron,安装 SDK 包。

  • 请参考 下载 SDK 包 查看最新版。
  • 执行 npm install 安装 SDK 时,如果 npm 官网镜像下载缓慢,可将其切换至国内镜像。

2.3 导入 SDK

在项目脚本文件中导入 SDK 并使用。

const zgEngine = window.require('zego-express-engine-electron/ZegoExpressEngine');
const zgDefines = window.require('zego-express-engine-electron/ZegoExpressDefines');
console.log(zgEngine.getVersion())

如果控制台中可以打印出正确的 SDK 版本号,即为导入成功。

3 常见问题

macOS Monterey(12.2.1) 及以上版本运行 electron 应用导致摄像头、麦克风等设备不能使用或者 crash?

如何解决此问题,详情请参考 FAQ

本篇目录