Skip to content

Latest commit

 

History

History
113 lines (88 loc) · 4 KB

README.zh.md

File metadata and controls

113 lines (88 loc) · 4 KB

Mac Build Status Windows Build Status Npm Package MIT License

Read this in other language: English


Agora RTC Electron SDK

Agora RTC Electron SDK 将 Agora RTC SDK (windows & macos) 封装为 NodeJS C++ Addon,提供了更快捷的音视频通信应用的开发方式。
前往文档 »

示例应用 · 发现问题 · 插件社区 🆕

目录

快速开始

安装

推荐使用 npm 安装:

# 安装最新版本的sdk并自动下载预编译的NodeJS C++ Addon
npm install agora-electron-sdk

通常需要在 package.json 中指定你的应用所使用的 Electron 版本以及是否需要下载预编译好的NodeJS C++ Addon(推荐,如果禁用prebuilt则需要自行提供 node-gyp 环境):

// package.json
{
...
  "agora_electron": {
    "electron_version": "5.0.8",
    "prebuilt": true
  }
...
}

想要了解更多配置详情, 请访问 wiki.

使用

import AgoraRtcEngine from 'agora-electron-sdk'

const rtcEngine = new AgoraRtcEngine();
rtcEngine.initialize('<your agora app id>');

相关资源

插件社区

最新版本中我们提供插件机制允许自行处理音视频数据,换言之,允许您编写插件来实现诸如美颜滤镜,人脸识别等非常酷的功能。

我们提供了一个官方插件示例:集成FaceUnity实现美颜滤镜

想要进一步了解插件是如何运作的,或是如何编写您自己的插件, 请访问 wiki.

贡献指南

开源社区的魅力之一就在于自由的学习,交流以及创造。我们热烈欢迎您提供任何形式的贡献。

  1. Fork 此项目
  2. 创建自己的分支 (git checkout -b feature/AmazingFeature)
  3. 提交代码变动 (git commit -m 'Add some AmazingFeature)
  4. 推到远端分支 (git push origin feature/AmazingFeature)
  5. 新建一个PR