Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yocontra/rtc-everywhere
Cross-everything WebRTC mega-project
https://github.com/yocontra/rtc-everywhere
Last synced: 7 days ago
JSON representation
Cross-everything WebRTC mega-project
- Host: GitHub
- URL: https://github.com/yocontra/rtc-everywhere
- Owner: yocontra
- License: mit
- Created: 2015-12-03T00:18:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-09T19:11:13.000Z (over 6 years ago)
- Last Synced: 2024-07-14T03:03:06.524Z (4 months ago)
- Language: JavaScript
- Homepage: http://rtc.works
- Size: 71.3 KB
- Stars: 652
- Watchers: 32
- Forks: 40
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - rtc-everywhere - everything WebRTC mega-project (Modules)
README
# rtc-everywhere [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url]
## What is this?
Sick of the incompatible mess of vendor prefixes, adapters, plugins, extensions, and native modules? rtc-everywhere aims to provide a spec-compliant WebRTC implementation in as many environments as possible.
### Supported Environments
#### :computer: Desktop
- Chrome
- Firefox
- MS Edge [Partial]
- No data channels
- Safari 7+
- Requires Temasys Plugin
- Internet Explorer 9+ [In Progress]
- Requires Temasys Plugin
#### :iphone: Mobile
- Android 5+
- Cordova iOS
- Requires install of `cordova-iosrtc`
- Cordova Android
- Requires install of `cordova-crosswalk`
- react-native iOS/Android [In Progress]
- Requires install of `react-native-webrtc`
#### Other
- Node.js 0.10+
- Requires install of `wrtc`
- Only works on x64 Linux, Mac, and Windows
- MediaStream APIs are not supported at this time
- See [wrtc](https://github.com/js-platform/node-webrtc) for more info.
### Getting Started
```
npm install rtc-everywhere --save
```
```js
var rtc = require('rtc-everywhere')();
// Available:
// rtc.RTCPeerConnection
// rtc.RTCIceCandidate
// rtc.RTCSessionDescription
// rtc.getUserMedia
// rtc.attachStream(stream, videoElement)
```
:crystal_ball: Want a more detailed example that uses these functions? Check out the [loopback stream example!](https://github.com/contra/rtc-everywhere/blob/master/examples/loopback/index.js)
### API
#### RTCPeerConnection
Exactly the same as the specification. See the [Specification Documentation](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)!
#### RTCIceCandidate
Exactly the same as the specification. See the [Specification Documentation](http://html5index.org/WebRTC%20-%20RTCIceCandidate.html)!
#### RTCSessionDescription
Exactly the same as the specification. See the [Specification Documentation](https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription)!
#### getUserMedia(constraints, cb)
Similar to the [specification](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/getUserMedia), but slightly adjusted to have an easier API.
##### Modifications
- `constraints` is optional (makes things easier)
- Defaults to `{video: true, audio: true}`
- `cb` is a node-style error first callback
```js
// these are the same thing
rtc.getUserMedia(function(err, stream){});
rtc.getUserMedia({video: true, audio: true}, function(err, stream){});
```
#### attachStream(stream, element)
- Attaches a stream to a given video element
- Returns the element the video was attached to
- In IE and Safari, the video element will be replaced by an `object` element
- Elements will not be replaced or modified unless they exist on the DOM
- Regardless of replacement, the new `object` element will be returned
### Related Libraries
- [simple-peer](https://github.com/feross/simple-peer)
- [blob-util](https://github.com/nolanlawson/blob-util)
[downloads-image]: http://img.shields.io/npm/dm/rtc-everywhere.svg
[npm-url]: https://npmjs.org/package/rtc-everywhere
[npm-image]: http://img.shields.io/npm/v/rtc-everywhere.svg
[travis-url]: https://travis-ci.org/contra/rtc-everywhere
[travis-image]: https://travis-ci.org/contra/rtc-everywhere.png?branch=master
[depstat-url]: https://david-dm.org/contra/rtc-everywhere
[depstat-image]: https://david-dm.org/contra/rtc-everywhere.png
[david-url]: https://david-dm.org/contra/rtc-everywhere
[david-image]: https://david-dm.org/contra/rtc-everywhere.png?theme=shields.io