# skyway-peerjs

> This branch is a customized version of PeerJS for NTT Communications's WebRTC platform SkyWay.

Latest version **0.4.0** (published 2017-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install skyway-peerjs
pnpm add skyway-peerjs
yarn add skyway-peerjs
bun add skyway-peerjs
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2017-05-16 |
| First published | 2017-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 222 |
| Author | Michelle Bu, Eric Zhang, NTT Communications |
| Maintainers | yusuke84 |

## Links

- npm: https://www.npmjs.com/package/skyway-peerjs
- Repository: https://github.com/nttcom/peerjs
- Homepage: http://skyway.io/en
- Issues: https://github.com/nttcom/peerjs/issues
- npm.io page: https://npm.io/package/skyway-peerjs

## Dependencies (3)

- [reliable](https://npm.io/package/reliable.md) git+https://github.com/michelle/reliable.git
- [eventemitter3](https://npm.io/package/eventemitter3.md) 0.1.5
- [js-binarypack](https://npm.io/package/js-binarypack.md) 0.0.9

## Recent versions

- 0.4.0 (latest) — 2017-05-16

## README

# PeerJS: Simple peer-to-peer with WebRTC #

PeerJS provides a complete, configurable, and easy-to-use peer-to-peer API built on top of WebRTC, supporting both data channels and media streams.

## Notice 
This branch is a customized version of PeerJS for NTT Communications's WebRTC platform SkyWay.
- [http://nttcom.github.io/skyway](http://nttcom.github.io/skyway/en)

## Setup


**Include the library**

```html
<script src="https://skyway.io/dist/0.3/peer.js"></script>
```

**Include with NPM**

```
npm install skyway-peerjs
```

**Create a Peer**  
Get a [free API key](http://nttcom.github.io/skyway/registration.html). Your id only needs to be unique to the namespace of your API key.
```javascript
var peer = new Peer('pick-an-id', {key: 'myapikey'}); 
// You can pick your own id or omit the id if you want to get a random one from the server.
```

## Data connections
**Connect**
```javascript
var conn = peer.connect('another-peers-id');
conn.on('open', function(){
  conn.send('hi!');
});
```
**Receive**
```javascript
peer.on('connection', function(conn) {
  conn.on('data', function(data){
    // Will print 'hi!'
    console.log(data);
  });
});
```

## Media calls
**Call**
```javascript
navigator.getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
navigator.getUserMedia({video: true, audio: true}, function(stream) {
  var call = peer.call('another-peers-id', stream);
  call.on('stream', function(remoteStream) {
    // Show stream in some <video> element.
  });
}, function(err) {
  console.log('Failed to get local stream' ,err);
});

```
**Answer**
```javascript
navigator.getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
peer.on('call', function(call) {
  navigator.getUserMedia({video: true, audio: true}, function(stream) {
    call.answer(stream); // Answer the call with an A/V stream.
    call.on('stream', function(remoteStream) {
      // Show stream in some <video> element.
    });
  }, function(err) {
    console.log('Failed to get local stream' ,err);
  });
});
```

## SkyWay Links

### [Documentation / API Reference](http://nttcom.github.io/skyway/docs)

### [Changelog](https://github.com/nttcom/peerjs/blob/master/changelog.md)

### [free API key](http://nttcom.github.io/skyway/registration.html)

### [Discuss SkyWay on our Google Group](https://groups.google.com/forum/#!forum/skywayjs)

## PeerJS links

### [WebRTC Browser compatibility status](http://peerjs.com/status)

### [PeerServer](https://github.com/peers/peerjs-server)

### [Discuss PeerJS on our Google Group](https://groups.google.com/forum/?fromgroups#!forum/peerjs)

---
_Source: https://npm.io/package/skyway-peerjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._