Integrate SDK

2026-03-05

Prepare environment

Before integrating ZEGO Express SDK, please ensure the development environment meets the following requirements:

Supports Electron versions 7.0.0 to 23.0.0.
Supports Windows 7 and above operating systems.
Supports macOS 10.13 and above operating systems.
Supports Linux operating systems with x86_64, aarch64, armhf architectures. If you need to use the Linux platform, please contact ZEGO Technical Support.
Devices that support audio and video such as microphones and cameras.
The device is connected to the Internet.
Install Node.js, it is recommended to use the Long Term Support version displayed on the official website homepage.

Integrate SDK

Create new project (optional)

This step uses creating a new project as an example. If integrating into an existing project, you can ignore this step.

Please refer to Electron Documentation - Quick Start Guide to create an Electron project.

Install SDK

Use the npm command npm install zego-express-engine-electron in the project to install the SDK package.

Note

Please refer to Download SDK Package for the latest version.
When executing npm install to install the SDK, if the download from the npm official mirror is slow, you can switch to a domestic mirror.

Import SDK

Import and use the SDK in the project script file.

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

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

If the correct SDK version number can be printed in the console, the import is successful.

FAQ

Running electron apps on macOS Monterey(12.2.1) and above causes cameras, microphones and other devices to not work or crash?

For details on how to resolve this issue, please refer to FAQ.