Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node-webrtc/node-webrtc
node-webrtc is a Node.js Native Addon that provides bindings to WebRTC M87
https://github.com/node-webrtc/node-webrtc
bindings n-api native-addon node webrtc
Last synced: 2 days ago
JSON representation
node-webrtc is a Node.js Native Addon that provides bindings to WebRTC M87
- Host: GitHub
- URL: https://github.com/node-webrtc/node-webrtc
- Owner: node-webrtc
- License: other
- Created: 2013-07-02T18:21:45.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-01T22:59:54.000Z (9 months ago)
- Last Synced: 2024-10-30T04:51:12.349Z (3 months ago)
- Topics: bindings, n-api, native-addon, node, webrtc
- Language: C++
- Homepage:
- Size: 15.1 MB
- Stars: 2,730
- Watchers: 100
- Forks: 459
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-peer-to-peer - wrtc
- awesome-github-star - node-webrtc - webrtc is a Node.js Native Addon that provides bindings to WebRTC M87 | node-webrtc | 2597 | (C++)
- awesome-webrtc - node-webrtc - Node.js Native Addon that provides bindings to WebRTC. (Libraries / Node)
README
# \#\#\# NOTE \#\#\#
This repository is out-of-date. For an actively maintained fork supporting Node 20 and more recent versions of WebRTC, see [@roamhq/wrtc](https://github.com/WonderInventions/node-webrtc). Once `@roamhq/wrtc` is stable, it will be merged back into this repository.
Other alternatives that might suit your needs are [node-datachannel](https://github.com/murat-dogan/node-datachannel) and [werift](https://github.com/shinyoshiaki/werift-webrtc)
[](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 M87](https://chromium.googlesource.com/external/webrtc/+/branch-heads/4280). 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](docs/nonstandard-apis.md) for testing are also included.
Install
-------
```
npm i -g node-pre-gyp
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](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](docs/build-from-source.md).
Linux
macOS
Windows
armv7l
arm64
x64
arm64
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).