Collaborative Whiteboard
  • iOS
  • Android
  • Web
  • Electron : JavaScript
  • Windows
  • macOS
  • Overview
  • SDK downloads
  • Demo app
  • Sample codes
  • Development guide
  • Quick starts
  • Error codes
  • Server APIs
  • Documentation
  • Collaborative Whiteboard
  • Quick starts
  • Integration

Integrate the SDK

Last updated:2023-12-20 14:28

1 Set up the development environment

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.

2 Prerequisites

If you need the file sharing function, download the ZegoDocsView SDK.

3 Integrate the SDK

3.1 Optional: Create a new project

Skip this step if you already have a project.

For instructions on how to create an Electron project, see Electron quick start.

3.2 Install the SDK via NPM

  1. Open Terminal, run cd to go to the project directory.

  2. Run the following command to install the latest version of the SDK.

    npm install zego-express-engine-electron@whiteboard --save

3.3 Import the SDK

Use the following code to import the SDK into the project.

// Import the ZEGO Express-Video SDK.
const zegoExpressEngine = window.require('zego-express-engine-electron/ZegoExpressEngine.js')
// Import the ZEGO Whiteboard SDK.
const ZegoWhiteBoard = window.require('zego-express-engine-electron/ZegoWhiteBoardView.js')
Page Directory