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

0.1.6 • Public • Published

vMix library for NodeJS

⚠️⚠️WORK IN PROGRESS⚠️⚠️

This library allows you to control vMix from NodeJS.

Installation

npm install vmix-node

Quick Start

import { ConnectionVMix, TallyArray } from "vmix-node";

// Create a new connection to vMix
const vMix = new ConnectionVMix();

// Listen for connect event
vMix.on("connect", async () => {
  console.log("Connected to vMix");
});

// Listen for disconnect event
vMix.on("disconnect", () => {
  console.log("Disconnected from vMix");
});

// Listen for tally event
vMix.on("tally", (tally: TallyArray) => {
  console.log('TALLY:', tally);
});

(async () => {
  // connect to vMix
  await vMix.connectAsync();

  // send tally command
  vMix.sendCommand("TALLY");

  // subscribe to tally events
  vMix.subscribe("TALLY");


})();

Implemented Commands

  • ✅ VERSION
  • ✅ TALLY
  • ✅ ACTS
  • ✅ SUBSCRIBE
  • ✅ UNSUBSCRIBE
  • ❌ FUNCTION
  • ❌ XML
  • ❌ XMLTEXT

Readme

Keywords

Package Sidebar

Install

npm i vmix-node

Weekly Downloads

4

Version

0.1.6

License

MIT

Unpacked Size

39.1 kB

Total Files

9

Last publish

Collaborators

  • pausalv