[](https://www.npmjs.com/package/wrtc) [](https://circleci.com/gh/node-webrtc/node-webrtc) [](https://ci.appveyor.com/project/markandrus/node-webrtc-7bnua)
node-webrtc is a Node.js Native Addon that provides bindings to [WebRTC M81](https://chromium.googlesource.com/external/webrtc/+/branch-heads/4044). This project aims for spec-compliance and is tested using the W3C's [web-platform-tests](https://github.com/web-platform-tests/wpt) project. A number of [nonstandard APIs](https://github.com/node-webrtc/node-webrtc/blob/v0.4.7/docs/nonstandard-apis.md) for testing are also included.
Install
-------
```
npm install wrtc
```
Installing from NPM downloads a prebuilt binary for your operating system × architecture. Set the `TARGET_ARCH` environment variable to "arm" or "arm64" to download for armv7l or arm64, respectively. Linux and macOS users can also set the `DEBUG` environment variable to download debug builds.
You can also [build from source](https://github.com/node-webrtc/node-webrtc/blob/v0.4.7/docs/build-from-source.md).
Supported Platforms
-------------------
The following platforms are confirmed to work with node-webrtc and have prebuilt binaries available. Since node-webrtc targets [N-API version 3](https://nodejs.org/api/n-api.html), there may be additional platforms supported that are not listed here. If your platform is not supported, you may still be able to [build from source](https://github.com/node-webrtc/node-webrtc/blob/v0.4.7/docs/build-from-source.md).
|
Linux |
macOS |
Windows |
| armv7l |
arm64 |
x64 |
x64 |
x64 |
| Node |
8 |
✓ |
✓ |
✓ |
✓ |
✓ |
| 10 |
✓ |
✓ |
✓ |
✓ |
✓ |
| 11 |
✓ |
✓ |
✓ |
✓ |
✓ |
| 12 |
✓ |
✓ |
✓ |
✓ |
✓ |
| 13 |
✓ |
✓ |
✓ |
✓ |
✓ |
| 14 |
✓ |
✓ |
✓ |
✓ |
✓ |
| Electron |
4 |
|
|
✓ |
✓ |
✓ |
| 5 |
|
|
✓ |
✓ |
✓ |
Examples
--------
See [node-webrtc/node-webrtc-examples](https://github.com/node-webrtc/node-webrtc-examples).
Contributing
------------
Contributions welcome! Please refer to the [wiki](https://github.com/node-webrtc/node-webrtc/wiki/Contributing).