{"id":15887876,"url":"https://github.com/agoraio-extensions/electron-sdk","last_synced_at":"2026-04-08T08:01:06.722Z","repository":{"id":37359122,"uuid":"129250564","full_name":"AgoraIO-Extensions/Electron-SDK","owner":"AgoraIO-Extensions","description":"Electron wrapper around the Agora RTC SDKs for Windows/macOS","archived":false,"fork":false,"pushed_at":"2026-04-03T12:30:32.000Z","size":37474,"stargazers_count":156,"open_issues_count":13,"forks_count":72,"subscribers_count":44,"default_branch":"main","last_synced_at":"2026-04-03T13:49:57.429Z","etag":null,"topics":["agora","electron","macos","rtc","typescript","video","webpack","windows"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO-Extensions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-04-12T12:50:12.000Z","updated_at":"2026-03-14T17:17:49.000Z","dependencies_parsed_at":"2025-12-29T12:06:40.244Z","dependency_job_id":"5c27d1bc-b79f-4980-9b79-ad49ad9b14a0","html_url":"https://github.com/AgoraIO-Extensions/Electron-SDK","commit_stats":{"total_commits":165,"total_committers":12,"mean_commits":13.75,"dds":0.593939393939394,"last_synced_commit":"cb81a8ce48708755cc4600b218e8046d1f85bb35"},"previous_names":["agoraio-community/agora-rtc-sdk-for-electron","agoraio/electron-sdk"],"tags_count":239,"template":false,"template_full_name":null,"purl":"pkg:github/AgoraIO-Extensions/Electron-SDK","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2FElectron-SDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2FElectron-SDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2FElectron-SDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2FElectron-SDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO-Extensions","download_url":"https://codeload.github.com/AgoraIO-Extensions/Electron-SDK/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2FElectron-SDK/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31545906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"online","status_checked_at":"2026-04-08T02:00:06.127Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agora","electron","macos","rtc","typescript","video","webpack","windows"],"created_at":"2024-10-06T06:05:32.287Z","updated_at":"2026-04-08T08:01:06.681Z","avatar_url":"https://github.com/AgoraIO-Extensions.png","language":"TypeScript","readme":"\u003e ⚠️ **Note**: To provide you with better and higher quality technical support services, we will no longer provide technical support through GitHub issues. If you need help, please contact us directly through [Agora Support](https://www.agora.io/en/customer-support/).\n\n\u003e NOTE: These sdk and samples only for the Agora Video 4.x APIs. For examples using previous releases please see the following branches:\n\u003e\n\u003e - [3.x](https://github.com/AgoraIO-Extensions/Electron-SDK/tree/3.x)\n\n# Agora RTC SDK for Electron\n\n\u003cdiv align=\"left\"\u003e\n    \u003ca href=\"https://github.com/AgoraIO-Extensions/Electron-SDK\"\u003e\u003cimg src=\"https://img.shields.io/badge/Platform-macOS--x86--64%20%7C%20macOS--arm64%20%7C%20win--32%20%7C%20win--64-blue?logo=Electron\u0026labelColor=fff\" alt=\"Platform\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/agora-electron-sdk\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/agora-electron-sdk?color=blue\u0026style=flat-square\u0026logo=npm\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/agora-electron-sdk\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dm/agora-electron-sdk?color=blue\u0026style=flat-square\u0026logo=npm\"\u003e\u003c/a\u003e\n    \u003ca href=\"./LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/agoraio-extensions/electron-sdk?color=blue\u0026style=flat-square\" alt=\"License\"/\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/AgoraIO-Extensions/Electron-SDK/issues\"\u003e\u003cimg src=\"https://flat.badgen.net/github/label-issues/AgoraIO-Extensions/Electron-SDK/help%20wanted/open\" alt=\"License\"/\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## ✨ Features\n\n- 📦 Newly designed middle-tier API and Native C++ SDK.\n- 🛡 Written in TypeScript with predictable static types.\n\n## 🖥 Environment Support\n\n- 🌈 Support macOS x86-64 and arm64 ([Electron 11+](https://www.electronjs.org/zh/blog/apple-silicon))\n- ⚙️ Support Windows ia32 and x64\n- [Electron](https://www.electronjs.org/): 4.x ~ latest\n\n| [\u003cimg src=\"https://simpleicons.org/icons/macos.svg\" alt=\"Chrome\" width=\"48px\" height=\"24px\" /\u003e]()\u003cbr\u003emacOS | [\u003cimg src=\"https://simpleicons.org/icons/windows.svg\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e]()\u003cbr\u003eWindows | [\u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png\" alt=\"Electron\" width=\"24px\" height=\"24px\" /\u003e](http://godban.github.io/browsers-support-badges/)\u003cbr\u003eElectron |\n| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| x86 \\| arm64                                                                                               | ia32 \\| x64                                                                                                    | 4.0.0 ~ Latest                                                                                                                                                                                                       |\n\n## 📦 Install\n\nIn newest version you can define installation configuration in package.json (or .npmrc, while package.json has a higher\npriority), usually you can just provide \"prebuilt\", and \"arch\".\n\n```json\n// package.json\n{\n  ...\n  \"agora_electron\": {\n    \"prebuilt\": true,\n    \"arch\": \"x64\"\n  }\n  ...\n}\n\n\n// .npmrc\nagora_electron_sdk_pre_built=true // defalut value is true\nagora_electron_sdk_arch=x64 // only support windows:\n```\n\nProperties detail:\n\n- **prebuilt** whether to automatically download prebuilt NodeJS C++ Addon or build locally(which need to provide\n  development env)\n- **arch**: If not set, the script will automatically choose the arch. **only support windows**\n- **platform** darwin or win32\n\n```bash\n## Automatic platform and architecture selection\nnpm install agora-electron-sdk\n```\n\nor\n\n```bash\n## or select 32 bit architecture on Windows\nnpm install --agora_electron_sdk_arch=ia32\n\n## or select 64 bit architecture on Windows\nnpm install --agora_electron_sdk_arch=x64\n```\n\n## 🔨 Usage\n\n```javascript\nimport createAgoraRtcEngine from 'agora-electron-sdk';\n\nconst rtcEngine = createAgoraRtcEngine();\nrtcEngine.initialize({ appId: '\u003cyour agora app id\u003e' });\n```\n\n### When using without electron-webpack\n\nWhen using directly within a web electron project with custom webpack configuration, you may see errors when compiling.\nIt's because you have not properly configured loader for node addon. A convenient way to skip the compile process is to\nset `externals` property of your webpack config to `{\"agora-electron-sdk\": \"commonjs2 agora-electron-sdk\"}`\n\n## 🔗 Links\n\n- [Document](https://docs.agora.io/en/video-call-4.x/API%20Reference/electron_ng/API/rtc_api_overview_ng.html) - Official document\n\n- [Demo](./example/) - A quick start demo based on React and this repo\n\n- [Changelog](./CHANGELOG.md) - Attention to newest information\n\n- [Release Notes](https://docs.agora.io/en/video-call-4.x/release_electron_ng?platform=Electron) - Attention to newest\n  information\n\n## ⌨️ Development\n\n### Build From Source Code\n\nYou will need to build **Agora RTC Electron SDK** from source if you want to work on a new feature/bug fix, try out the\nlatest features which are not released yet, or maintain your own fork with patches that cannot be merged to the core.\n\n### Prerequisites\n\n#### Windows\n\n- Python 2.7\n- Visual Studio Code C++ Desktop Develop Framework\n\n#### MacOS\n\n- Python 2.7\n- XCode\n\n### Clone locally:\n\n```bash\n$ git clone git@github.com:AgoraIO-Extensions/Electron-SDK.git\n$ cd Electron-SDK\n$ npm install #or yarn\n\n# build macOS\n$ npm install --agora_electron_sdk_pre_built=false\n\n# build  32 bit architecture on Windows\n$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=ia32\n\n# build  64 bit architecture on Windows\n$ npm install --agora_electron_sdk_pre_built=false  --agora_electron_sdk_arch=x64\n```\n\n## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/AgoraIO-Extensions/Electron-SDK/pulls)\n\nRead our contributing guide and let's build a better antd together. :)\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-extensions%2Felectron-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio-extensions%2Felectron-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-extensions%2Felectron-sdk/lists"}