Git Product home page Git Product logo

easy-signaling's Introduction

easy signaling

What is this?

WebRTC Signaling with as few complexity as possible. It is compatible with rtc-lib. You can use the signaling server standalone or integrate it in your Node.js project.

Standalone

Install the package with

npm install -g easy-signaling

To use the signaling server in standalone mode simply run

easy-signaling

You can use the environment variables BIND_PORT (defaults to 8080) and BIND_HOST (defaults to 0.0.0.0) to configure the listening socket of the server. A websocket server will be listening on the specified port and provide signaling to clients.

Library

If you want to include the server in your project install add the dependency 'easy-signaling' to your package.json.

You can either use a Hotel to provide multiple rooms ...

var hotel = new require("easy-signaling").Hotel()
hotel.create_guest(connection, "room_name")

... or use Room if you need only one room ...

var room = new require("easy-signaling").Room()
room.create_guest(connection)

The connection object in the examples is a Channel implementing the connectino to the client. You can implement your own Channel or use WebsocketChannel which is a wrapper around WebSockets provided by the ws library.

The complete documenation is available here.

easy-signaling's People

Contributors

thammi avatar sirka7 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.