streamcompanion

Node implementation of StreamCompanion using its built-in WebSocket endpoints.

Table of contents

• Quick Start
• Requirements
• Documentation
• License

Quick Start

Install from npm

npm i --save streamcompanion

Usage

const StreamCompanion = require('streamcompanion');
const options = {
  host: 'localhost',
  port: 20727,
  proto: 'http',
  watchTokens: [],
  listeners: {
    tokens: true,
    mapData: true,
    liveData: false
  }
};
const SC = new StreamCompanion(options);
// Use SC

Requirements

1. Can run StreamCompanion
2. Node 12+

Important

If you can't connect to Stream Companion, go to Settings/Web Overlay and click Enable remote access

Documentation

Click Here to open the documentation

License

This project is using MIT license © Edqe14
Click here to read LICENSE.