A webrtc-signal-http extension that only displays relevant peers to connected clients and servers
This ensures that all connected peers only see the peers that they can connect to. Therefore, servers only see clients, and vice versa. Unidentified clients see both.
Learn about the RESTful API extension via the OpenAPI Doc (hosted) to understand how clients should change their interaction with the service when using this extension.
To install a signal server including this extension that can be used in a cli npm install -g webrtc-signal-http-peer-identification
. To run it, just use webrtc-signal-http-peer-identification
from the command line, using the PORT
environment variable to configure it's listening port.
To consume this server in combination with webrtc-signal-http and other possible extensions, npm install webrtc-signal-http webrtc-signal-http-capacity
and then see this sample file for an example of code that works using the server and this extension.
To understand the base API provided by webrtc-signal-http, look at the docs for that project. This documents the API endpoints this extension adds.
To understand the base API provided by webrtc-signal-http, look at the docs for that project. This documents the javascript API this extension adds. ✨
This is the exported behavior, you access it with
require('webrtc-signal-http-peer-identification') [Function] - __Returns__ an [express](https://expressjs.com/)
router` object.
[Object] - can be used to retrieve a PeerList
from the express router
. Returns a recognitionPeerList object.
####recognitionPeerList
[Class] - Extends PeerList with the ability to sort peers and only display relevant, complementary peers
[Object] - An existing PeerList to base our recognitionPeerList on.
MIT