obs-js

The easiest way to communicate with OBS

Controlling OBS with code is difficult. Simple manipulations of scenes and scene items can be manageable, but can easily spiral out of control having to keep track of scenes, sources, settings, filters and more.

obs-js aims to fix this. By simply working with Scene, Source, and SceneItem objects, you can have unparalleled control over your OBS layout.

Beta Warning

This library is not well tested and is still under heavy development. Feel free to use it, but make sure you make a backup of your scene collections before doing anything with obs-js.

Features

• Persistence across code reloads, so scenes and items aren't deleted and recreated each time you run your code
• Automatic request batching
• Scene, Source and SceneItem are designed to be overridden, allowing for complex layouts to be abstracted into subclasses
• Easy integration into existing layouts with Scene.link(), allowing for incremental migration to obs-js without handing over your entire layout to your code

Installation

1. Install the fork of obs-websocket

   obs-js exposes some functionality (eg. obs.clean(), Scene.remove()) that requires installing a custom fork of obs-websocket. This fork simply adds support for removing scenes, retaining all other previous functionality. obs-js will support obs-websocket v5 when it is released, which has native support for removing scenes, and also v4 for backwards compatibility.

2. Install obs-js

   yarn add @brendonovich/obs-js

   or NPM

   npm install @brendonovich/obs-js

3. Connect to OBS.

   Where you first use OBS in your code, import obs:

   import { obs } from "@brendonovich/obs-js";

   Then simply connect:

   await obs.connect({ address: "localhost:4444" });

4. Create and link with scenes and sources. See the example folder for a tutorial.

To Do

• [x] Filters
• [ ] Clean
• [ ] Ignored symbol