/metan

Yet another WebSocket client for Open Broadcaster

Primary LanguageJavaScriptMIT LicenseMIT

metan

Yet another WebSocket client for Open Broadcaster

Table of Contents

Install

$ npm install metan

Usage

const { Client } = require("metan");

const client = new Client();

client.on("connected", () => {
  console.log("Connected to OBS");
});

client.on("ready", () => {
  console.log("Client is ready to use");

  client.request("GetVersion").then(({ requestType, responseData }) => {
    console.log("Received %s response: %s", requestType, responseData);
  });
});

client.on("disconnected", () => {
  console.log("Disconnected from OBS");
});

client.on("event", ({ eventName, eventData }) => {
  console.log("New %s event received: %s", eventName, eventData);
});

client.connect({
  address: "ws://localhost:4444",
});

API

See the declaration file.

Author

Alexandre Breteau - @0xSeldszar

License

MIT © Alexandre Breteau