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 built binary file for you
npm install agora-electron-sdk@2.0.7-rc.6// you can use require either
import AgoraRtcEngine from 'agora-electron-sdk'Other resources:
CDN for Built Binary File(Windows)
CDN for Built Binary File(Mac)
-
Node.js 6.9.1+
-
Electron 1.8.3+
-
Agora RTC SDK Windows/macOS 2.2.1+
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.
- You can find full APIs for Agora RTC SDK at Document Center
We are still opmizing our project, welcome to help improve our Javascript Api Doc and test coverage, have a look at contribute code for detail.
The MIT License (MIT).