The Agora-RTC-SDK-for-Electron is an open-source wrapper for Electron developers. This SDK takes advantage of Node.js C++ Addons and Agora RTC SDKs on Windows/macOS.
其他语言版本： 简体中文
Attention to Changelog for newest information
You can directly install the sdk through npm:
# install newest sdk and we will download prebuilt binary file for you
npm install agora-electron-sdkimport AgoraRtcEngine from 'agora-electron-sdk'Switch prebuilt addon version in .npmrc (default to use 1.8.3)
# range(1.8.3, <3.0.0) will download a prebuilt addon built with electron 1.8.3
AGORA_ELECTRON_DEPENDENT=2.0.0
# or
# range(>=3.0.0) will download a prebuilt addon built with electron 3.0.6
AGORA_ELECTRON_DEPENDENT=3.0.6
# or
# range(= 4.0.0) will download a prebuilt addon built with electron 4.0.0
AGORA_ELECTRON_DEPENDENT=4.0.0-
API Reference - API Reference
-
e-Education Application - A complete e-education Application based on this repo
-
Demo - A quick start demo based on Vue/React and this repo
-
Doc Center - Original API Reference for Agora Native SDK
-
Node.js 6.9.1+
-
Electron 1.8.3+
Assuming that you have Node installed and can use npm in command line.
-
Run
npm installto install dependency -
Usually it will trigger
npm run download, or you can run it manually. -
If you want to debug with xcode/visual studio, run
npm run debugto generate the project file and sdk for debug env.
Find more scripts in package.json
Notice:
-
Must create a developer account at Agora.io, when you want to use Agora APIs.
-
For macOS, please always use the latest Xcode.
-
For Windows, if Visual Studio or Electron version are not the same as in script, change the corresponding parameters in the script. Electron 1.8.3+ needs Visual Studio 2015 or above. And you have to install a 32-bit electron by
npm install -D --arch=ia32 electron -
For more information about develop environment, visit node-gyp for help.
We are still opmizing our project, welcome for pr and issules.
The MIT License (MIT).