4.5.2 • Published 4 months ago

agora-electron-sdk v4.5.2

Weekly downloads
248
License
MIT
Repository
github
Last release
4 months ago

NOTE: These sdk and samples only for the Agora Video 4.x APIs. For examples using previous releases please see the following branches:

Agora RTC SDK for Electron

✨ Features

  • 📦 Newly designed middle-tier API and Native C++ SDK.
  • 🛡 Written in TypeScript with predictable static types.

🖥 Environment Support

  • 🌈 Support macOS x86-64 and arm64 (Electron 11+)
  • ⚙️ Support Windows ia32 and x64
  • Electron: 4.x ~ latest
macOSWindowsElectron
x86 | arm64ia32 | x644.0.0 ~ Latest

📦 Install

In newest version you can define installation configuration in package.json (or .npmrc, while package.json has a higher priority), usually you can just provide "prebuilt", and "arch".

// package.json
{
  ...
  "agora_electron": {
    "prebuilt": true,
    "arch": "x64"
  }
  ...
}


// .npmrc
agora_electron_sdk_pre_built=true // defalut value is true
agora_electron_sdk_arch=x64 // only support windows:

Properties detail:

  • prebuilt whether to automatically download prebuilt NodeJS C++ Addon or build locally(which need to provide development env)
  • arch: If not set, the script will automatically choose the arch. only support windows
  • platform darwin or win32
## Automatic platform and architecture selection
npm install agora-electron-sdk

or

## or select 32 bit architecture on Windows
npm install --agora_electron_sdk_arch=ia32

## or select 64 bit architecture on Windows
npm install --agora_electron_sdk_arch=x64

🔨 Usage

import createAgoraRtcEngine from "agora-electron-sdk";

const rtcEngine = createAgoraRtcEngine();
rtcEngine.initialize({appId: "<your agora app id>"});

When using without electron-webpack

When using directly within a web electron project with custom webpack configuration, you may see errors when compiling. It's because you have not properly configured loader for node addon. A convenient way to skip the compile process is to set externals property of your webpack config to {"agora-electron-sdk": "commonjs2 agora-electron-sdk"}

🔗 Links

  • Document - Official document

  • Demo - A quick start demo based on React and this repo

  • Changelog - Attention to newest information

  • Release Notes - Attention to newest information

⌨️ Development

Build From Source Code

You will need to build Agora RTC Electron SDK from source if you want to work on a new feature/bug fix, try out the latest features which are not released yet, or maintain your own fork with patches that cannot be merged to the core.

Prerequisites

Windows

  • Python 2.7
  • Visual Studio Code C++ Desktop Develop Framework

MacOS

  • Python 2.7
  • XCode

Clone locally:

$ git clone git@github.com:AgoraIO-Extensions/Electron-SDK.git
$ cd Electron-SDK
$ npm install #or yarn

# build macOS
$ npm install --agora_electron_sdk_pre_built=false

# build  32 bit architecture on Windows
$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=ia32

# build  64 bit architecture on Windows
$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=x64

🤝 Contributing PRs Welcome

Read our contributing guide and let's build a better antd together. :)

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature)
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request
4.5.2-dev.2

4 months ago

4.5.2-dev.1

4 months ago

0.0.0-dev.1

4 months ago

4.5.2

4 months ago

4.5.1-build.1-rc.1

6 months ago

4.5.1

6 months ago

4.5.0-dev.2

7 months ago

4.5.0

7 months ago

4.5.0-dev.1

8 months ago

4.3.2-build.5-rc.1

9 months ago

4.4.1-build.2-rc.1

9 months ago

4.4.0

10 months ago

4.3.2-build.2-rc.1

10 months ago

4.4.0-dev.2

11 months ago

4.2.6-build.16-rc.1

11 months ago

4.4.0-dev.1

12 months ago

4.3.2-build.90-rc.1

12 months ago

4.3.2-build.90-rc.2

12 months ago

4.3.2-build.90-rc.3

12 months ago

4.3.2

1 year ago

4.3.1

1 year ago

4.3.1-dev.1

1 year ago

4.3.0

1 year ago

4.3.0-dev.1

1 year ago

4.2.2-dev.7

2 years ago

4.2.2-dev.6

2 years ago

4.2.3

2 years ago

4.2.2

2 years ago

4.2.4

2 years ago

4.2.6

2 years ago

4.2.6-rc.1

2 years ago

4.2.3-dev.3

2 years ago

4.2.1

2 years ago

4.2.0-rc.1

2 years ago

4.2.0-rc.6

2 years ago

4.2.0-rc.5

2 years ago

4.2.0-rc.4

2 years ago

4.2.0-rc.3

2 years ago

4.2.0-rc.2

2 years ago

4.2.0-beta.8

2 years ago

4.2.0-beta.7

2 years ago

4.2.0-beta.9

2 years ago

4.2.0-beta.4

2 years ago

4.2.0-beta.3

2 years ago

4.2.0-beta.6

2 years ago

4.2.0-beta.5

2 years ago

4.2.0-beta.2

2 years ago

4.2.0-beta.1

2 years ago

4.2.0-es5.1

2 years ago

4.2.2-dev.4

2 years ago

4.2.0

2 years ago

4.1.1

2 years ago

4.2.0-dev.15

2 years ago

4.2.0-dev.13

2 years ago

4.2.0-dev.8

2 years ago

4.2.0-dev.1

2 years ago

4.2.0-dev.5

2 years ago

4.2.0-dev.4

2 years ago

4.1.0-rc.1

3 years ago

4.1.0-rc.2

3 years ago

4.1.0-rc.3

3 years ago

4.1.0-rc.4

3 years ago

4.1.0

3 years ago

3.4.11-build.111

2 years ago

3.4.11-build.213

2 years ago

4.0.1-xhs.3

3 years ago

4.1.1-rc.1

2 years ago

3.7.0-build.430

3 years ago

4.0.0

3 years ago

3.5.1-build.719

3 years ago

3.5.1-build.718

3 years ago

3.5.1-build.720

3 years ago

3.7.0-build.715

3 years ago

4.0.1-rc.2

3 years ago

4.0.1-rc.1

3 years ago

3.7.0-build.527

3 years ago

3.7.0-build.519

3 years ago

3.7.1-build.915

3 years ago

4.0.0-test.1

3 years ago

4.0.0-test.2

3 years ago

4.0.0-test.3

3 years ago

3.7.0-build.808

3 years ago

3.6.3-build.517

3 years ago

3.7.1-build.810

3 years ago

3.7.0

3 years ago

3.4.2-build.708

3 years ago

3.4.2-build.706

3 years ago

4.0.1-xhs.2

3 years ago

4.0.1-xhs.1

3 years ago

4.0.0-rc.1

3 years ago

4.0.0-rc.3

3 years ago

4.0.0-rc.2

3 years ago

4.0.0-rc.4

3 years ago

3.6.0-build.1216

4 years ago

3.6.0-build.111

3 years ago

3.6.0-build.1231

4 years ago

3.6.0-build.1230

4 years ago

3.5.1-build.1207

4 years ago

3.5.1-build.1123

4 years ago

3.4.8-build.1123

4 years ago

3.5.1-build.1116

4 years ago

3.4.8-build.919

4 years ago

3.4.8-build.920

4 years ago

3.4.6-build.810

4 years ago

3.4.6-build.811

4 years ago

3.4.5-build.809

4 years ago

3.4.6-build.809

4 years ago

3.4.6-build.730

4 years ago

3.4.6-build.729

4 years ago

3.4.6-build.727

4 years ago

3.4.6-build.722

4 years ago

3.4.5-build.701

4 years ago

3.4.2-testiris.1

4 years ago

3.4.2-testiris.2

4 years ago

3.4.2-testiris.3

4 years ago

3.4.2-testiris.4

4 years ago

3.4.2-testiris.5

4 years ago

3.4.2-testiris.6

4 years ago

3.4.2-testiris.7

4 years ago

3.4.2-testiris.8

4 years ago

3.4.2-testiris.9

4 years ago

3.2.1-build.623

4 years ago

3.3.1-iris.602

4 years ago

3.3.1-iris.62

4 years ago

2.9.10-7.148

4 years ago

2.9.107-rc.148

4 years ago

3.3.2-build.152

4 years ago

3.4.2

4 years ago

3.4.1

4 years ago

3.4.1-hotfix.3

4 years ago

3.4.1-hotfix.1

4 years ago

3.4.1-hotfix.2

4 years ago

3.2.1-hotfix.1

4 years ago

3.2.1-hotfix.2

4 years ago

3.3.2-build.156

4 years ago

3.3.2-build.157

4 years ago

3.3.1-rc.232

4 years ago

3.3.2-hotfix.4

4 years ago

3.3.2-hotfix.3

4 years ago

3.3.2-hotfix.2

4 years ago

3.3.2-hotfix.1

4 years ago

3.3.2

4 years ago

3.3.1-rc.71

4 years ago

2.9.107-rc.136

4 years ago

3.1.10-0.2

4 years ago

3.3.1

4 years ago

3.3.0-build.1220

4 years ago

3.1.1-hotfix.2

5 years ago

3.1.1-hotfix.1

5 years ago

3.1.1-build.914

5 years ago

3.0.1-beta.2

5 years ago

2.9.0-rc.177

5 years ago

3.0.0-build.661

5 years ago

3.0.1-beta.1

5 years ago

3.0.0-build.660

5 years ago

3.0.0-build.475

5 years ago

3.0.0-rc.123

5 years ago

3.0.0-build.474

5 years ago

2.9.0-rc.173

5 years ago

2.9.0-rc.172

5 years ago

3.0.0-build.473

5 years ago

2.9.0-rc.104

5 years ago

3.0.0

5 years ago

2.9.0-rc.125

5 years ago

2.9.0-rc.103

5 years ago

2.9.0-rc.132

5 years ago

2.9.0-rc.36

5 years ago

2.9.0-rc.102

5 years ago

2.9.0-rc.101

5 years ago

2.3.4-hotfix.14

6 years ago

2.8.2-rc.121

6 years ago

2.9.1-beta.5

6 years ago

2.9.1-beta.4

6 years ago

2.3.4-hotfix.13

6 years ago

2.9.1-beta.3

6 years ago

2.3.4-hotfix.12

6 years ago

2.3.4-hotfix.11

6 years ago

2.3.4-hotfix.10

6 years ago

2.9.1-beta.1

6 years ago

2.8.2-hotfix.9

6 years ago

2.8.2-hotfix.8

6 years ago

2.8.2-hotfix.7

6 years ago

2.8.2-hotfix.6

6 years ago

2.8.2-hotfix.5

6 years ago

2.8.2-hotfix.4

6 years ago

2.3.4-hotfix.9

6 years ago

2.3.4-hotfix.8

6 years ago

2.3.4-hotfix.7

6 years ago

2.3.4-hotfix.6

6 years ago

2.8.2-hotfix.3

6 years ago

2.3.4-hotfix.5

6 years ago

2.8.2-hotfix.2

6 years ago

2.8.2-hotfix.1

6 years ago

2.9.0-hotfix.2

6 years ago

2.9.0-hotfix.1

6 years ago

2.3.4-hotfix.4

6 years ago

2.9.0

6 years ago

2.3.4-hotfix.3

6 years ago

2.8.2

6 years ago

2.3.4-hotfix.2

6 years ago

2.8.0-hotfix.1

6 years ago

2.3.4-hotfix.1

6 years ago

2.3.4

6 years ago

2.8.0

6 years ago

2.4.1-alpha

6 years ago

2.4.0-beta.2

6 years ago

2.3.3-hotfix.2

6 years ago

2.3.3-hotfix.1

6 years ago

2.4.0-beta.1

6 years ago

2.3.3-hotfix

6 years ago

2.4.0-beta

6 years ago

2.4.0-alpha

6 years ago

2.3.3

6 years ago

2.3.3-alpha.11

6 years ago

2.3.2

6 years ago

2.3.3-alpha.10

6 years ago

2.3.3-alpha.9

6 years ago

2.3.3-alpha.8

6 years ago

2.3.3-alpha.7

6 years ago

2.3.3-alpha.6

6 years ago

2.3.3-alpha.5

6 years ago

2.3.3-alpha.4

6 years ago

2.3.3-alpha.3

6 years ago

2.3.3-alpha.2

6 years ago

2.3.3-alpha.1

6 years ago

2.3.3-rc.3

6 years ago

2.3.3-rc.2

6 years ago

2.3.3-rc

6 years ago

2.3.3-rc.1

6 years ago

2.3.2-alpha

6 years ago

2.0.8-rc.5

7 years ago

2.0.8-rc.5-alpha

7 years ago

2.0.8-rc.4

7 years ago

2.0.8-rc.3

7 years ago

2.0.8-rc.2

7 years ago

2.0.8-rc.1

7 years ago

2.0.7-rc.8

7 years ago

2.0.7-rc.7

7 years ago

2.0.7-rc.6

7 years ago

2.0.7-rc.5

7 years ago

2.0.7-rc.4

7 years ago

2.0.7-rc.3

7 years ago

2.2.1-rc.2

7 years ago

2.0.7-rc.2

7 years ago

2.0.7-rc.1

7 years ago

2.2.1-rc.1

7 years ago

2.2.1-beta

7 years ago

2.2.1-alpha

7 years ago

0.0.1

7 years ago