This tutorial enables you to quickly get started with creating an Agora account and using the Agora sample app to give you an overview on how to develop requests using the Node.js C++ Addons and the Agora RTC SDKs on Windows / MacOS:
The sample is an open-source wrapper for Electron developers.
- Agora.io Developer Account
- Node.js 6.9.1+ with C++11 support
- Electron 1.8.3+
- Agora RTC SDK for Windows or MacOS 2.1.0+
- MacOS 10.12+
This section shows you how to prepare and build the Agora Electron wrapper.
In order to build and run the sample application you must obtain an App ID:
- Create a developer account at agora.io. Once you finish the signup process, you will be redirected to the Dashboard.
- Navigate in the Dashboard tree on the left to Projects > Project List.
- Copy the App ID that you obtained from the Dashboard into a text file. You will use this when you launch the app.
-
Run the install command in your project directory.
npm install -g node-gyp -
Run the appropriate project file for your operating system:
Mac OS
The latest Xcode install will ensure you have C++11 support.
sh build.shWindows
-
Update the
build.batscript with the versions of Visual Studio and Electron installed on your machine.The sample file uses Visual Studio 2015
msvs_version=2015and Electron version 1.8.3target=1.8.3.Note: Electron 1.8.3+ requires Visual Studio 2015 or above.
node-gyp rebuild --target=1.8.3 --arch=ia32 --msvs_version=2015 --dist-url=https://atom.io/download/electron -
In the command line, run the install command.
hope build.bat
-
-
Once the build is complete, you can use the resulting Agora Electron wrapper to build your app.
- Agora JavaScript API for Electron reference doc.
- Complete API documentation is available at the Document Center.
- You can file bugs about this sample here.
- Learn how to contribute code to the sample project.
This software is under the MIT License (MIT). View the license.