eyeson
TypeScript icon, indicating that this package has built-in type declarations

1.9.1 • Public • Published

eyeson JavaScript Library

A library to easily connect to eyeson video meetings in modern browsers.

  • Simple but powerful: All you need is an access key. The high level abstraction allows easy control of video and audio streams, chat, screen capturing, broadcasting, media integration, document presentation and hardware device handling.
  • Lightweight: Besides offering a simple interface for managing complex workflows, eyeson has only few external dependencies. This keeps the size and potential compatibility risks small.
  • Event Driven: After creating a session, you have full control on how to respond to any events occurring during the session. With a convention based action system you can easily customize the experience for your users. Depending on your needs, events may be handled in individual interface components or managed by a state-drive approach.
  • Framework Agnostic: Using this event driven system, eyeson is seamlessly integrated with other JavaScript libraries and frameworks like Vue, React, Angular, or Elm, with or without using additional event handling libraries like Redux or RxJS.

Install

Use npm or yarn to add the package to your JavaScript project.

$ npm i --save eyeson
$ yarn add eyeson

Usage

The following snippet is a minimal example of how to connect to a eyeson room. See the documentation for details or visit the eyeson GUI to see an demo application.

eyeson.onEvent(event => {
  if (event.type !== 'accept') {
    return;
  }
  let video = document.querySelector('video');
  video.srcObject = event.remoteStream;
  video.play();
});
eyeson.start('my-eyeson-room-key');

Development

$ npm install
$ npm run build # produce bundle and minified bundle
$ npm run start # same as build but keep in watch mode
$ npm run test  # runs test in watch mode

Publishing

Make sure the library is build for production.

$ npm publish

Using babel to convert es6 to es5, webpack to bundle, jest as testing framework.

License

The software is available as open source under the terms of the MIT License.

Package Sidebar

Install

npm i eyeson

Weekly Downloads

58

Version

1.9.1

License

MIT

Unpacked Size

2.72 MB

Total Files

176

Last publish

Collaborators

  • eyeson