Integrate the SDK

Set up the development environment

Before integrating the ZegoEffects SDK, make sure your development environment meets the following requirements:

• Electron 7.0.0 or later.
• Windows 7 or later / macOS 10.10 or later.
• Audio and video devices: microphone and camera.
• Your computer is connected to the internet.
• Node.js: We recommend you install the Long Term Support (LTS) version provided on the Node.js official website.

Create a new project

Skip this step if a project already exists.

Import the SDK

To import the SDK, you will need to download the SDK package first. To download it, run the npm command npm install zego-express-engine-electron.

Import the SDK in your 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())

If the correct SDK version number is printed out in the console when you run the project, the SDK import is successful.