Home

Awesome

<h1 align="center"> <img height="120px" src="https://upload.wikimedia.org/wikipedia/commons/d/d9/Node.js_logo.svg">&nbsp;&nbsp;&nbsp;&nbsp; <img height="120px" src="https://webrtc.github.io/webrtc-org/assets/images/webrtc-logo-vert-retro-dist.svg"> </h1>

NPM

node-webrtc is a Node.js Native Addon that provides bindings to WebRTC M98. This project is aiming for spec-compliance and will eventually be tested using the W3C's web-platform-tests project. A number of nonstandard APIs for testing are also included.

Install

npm install @roamhq/wrtc

Installing from NPM downloads a prebuilt binary for your operating system × architecture, based on optional dependency filters.

To install a debug build or cross-compile, you should 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.

<table> <thead> <tr> <td colspan="2" rowspan="2"></td> <th colspan="2">Linux</th> <th colspan="2">macOS</th> <th>Windows</th> </tr> <tr> <th>x64</th> <th>arm64</th> <th>x64</th> <th>arm64</th> <th>x64</th> </tr> </thead> <tbody> <tr> <th rowspan="2">Node</th> <th>18</th> <td align="center">✓</td> <td align="center">?</td> <td align="center">✓</td> <td align="center">✓</td> <td align="center">✓</td> </tr> <tr> <th>20</th> <td align="center">✓</td> <td align="center">?</td> <td align="center">✓</td> <td align="center">?</td> <td align="center">✓</td> </tr> </tbody> </table>

Examples

See node-webrtc/node-webrtc-examples.