Skip to content

Latest commit

 

History

History
87 lines (51 loc) · 3.31 KB

README.zh.md

File metadata and controls

87 lines (51 loc) · 3.31 KB
Raw

Agora-RTC-SDK-for-Electron npm packageMac Build StatusWindows Build status

Agora-RTC-SDK-for-Electron是基于 Electron 平台开发的开源声网SDK封装。

Read this in other language: English

使用指南

您可以从Changelog获取最新发版信息

SDK安装支持直接通过npm：

#安装最新版本的sdk，执行时为自动下载预编译的二进制文件
npm install agora-electron-sdk
import AgoraRtcEngine from 'agora-electron-sdk'

若您的electron版本高于3.0.0，您可能需要修改.npmrc以切换预编译版本(默认使用1.8.3)

#electron版本(1.8.3，<3.0.0)
AGORA_ELECTRON_DEPENDENT = 2.0.0

#electron版本(>= 3.0.0)
AGORA_ELECTRON_DEPENDENT = 3.0.6

#electron版本(= 4.0.0)
AGORA_ELECTRON_DEPENDENT = 4.0.0

其他资源：

API参考 - API 说明

在线教育解决方案 - 如何用本项目实现一个完整的在线教育应用

基本Demo - 演示如何使用Vue/React和本项目简单地实现的音视频通话

原生API参考 - 原生API参考

开发环境

  • Node.js 6.9.1+

  • Electron 1.8.3+

  • Agora RTC SDK Windows/macOS 2.2.1+

如何开发

以下步骤默认您已经安装了NodeJS，并且可以在命令行中正常执行npm。

  • 执行npm install来安装依赖项

  • 安装会自动触发npm run download，您也可以到对应目录手动执行。

  • 如果您想用xcode / visual studio调试，可以执行npm run debug来生成项目文件和带符号表的sdk文件。

详细的脚本命令可以在package.json中查看

注意：

  • 如果要使用声网的SDK，必须首先在Agora.io上创建账号。

  • 在开发macOS应用时，请尽量安装最新版本的xcode。

  • 在开发windows版本时，若Visual Studio或Electron版本与脚本中的不同，请更改脚本中的相应参数。 Electron 1.8.3+需要Visual Studio 2015或更高版本。请注意windows下 您必须通过npm install -D --arch = ia32 electron 安装32位的Electron，不然打包的程序在32位的windows上将无法运行。

  • 有关开发环境的更多信息，请访问node-gyp获取帮助。

如何贡献

我们在积极地维护我们的项目，如果您对这个项目有兴趣并想让它变得更好，欢迎一起参与共建或提出意见。

Lisence(MIT)