@vandeurenglenn/wrtc
v0.5.5
Published
Standards-compliant WebRTC implementation for Node
Readme
node-webrtc is a Node.js Native Addon that provides bindings to WebRTC M87. This project aims for spec-compliance and is tested using the W3C's web-platform-tests project. A number of nonstandard APIs for testing are also included.
⚠️ Windows CI Notice (2026):
Native builds of node-webrtc on Windows require Visual Studio 2019 or 2017 due to upstream libwebrtc/Chromium toolchain limitations. GitHub Actions and most CI providers now only offer Visual Studio 2022 (windows-latest, windows-2022), which is not recognized by the upstream build scripts. Until Chromium/libwebrtc adds VS2022 support, Windows native builds may fail in CI. Track upstream for updates.
Prebuilt binaries for Windows are still published and supported.
Install
npm install wrtcInstalling 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.
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, 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.
Examples
See node-webrtc/node-webrtc-examples.
Contributing
Contributions welcome! Please refer to the wiki.
Benchmarking
A repeatable benchmark harness is available to detect performance regressions while improving the library.
See docs/benchmarking.md for usage and workflow.
