OBS Controller

### Install obs-websocket-js via npm or yarn Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/README.md Use npm or yarn to install the library for Node.js projects or web applications that use bundlers. ```sh npm install obs-websocket-js ``` ```sh yarn add obs-websocket-js ``` -------------------------------- ### Event Handling Setup Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Sets up event listeners for a component, merging parent listeners with component-specific handlers. Used during component initialization and updates. ```javascript function et(e,n,r,i,o){var a,s,c,u,l=[],f=!1;for(a in e)s=e[a],c=n[a],(u=fo(a)).plain||(f=!0),t(s)||(t(c)?(t(s.fns)&&(s=e[a]=X(s)),u.handler=s,l.push(u)):s!==c&&(c.fns=s,e[a]=c));if(l.length){f&&l.sort(tt);for(var p=0;p OBS Controller

Disconnected

``` -------------------------------- ### Use Plugin Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Registers a Vue plugin. Ensures a plugin is not installed multiple times. ```javascript function Ce(t){t.use=function(t){var e=this._installedPlugins||(this._installedPlugins=[]);if(e.indexOf(t)>-1)return this;var n=m(arguments,1);return n.unshift(this),"function"==typeof t.install?t.install.apply(t,n):"function"==typeof t&&t.apply(null,n),e.push(t),this}} ``` -------------------------------- ### Vue Filter Installation Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Provides a function to install custom Vue filters. It checks for duplicate filter names to prevent conflicts and registers the filters with Vue. ```javascript function e(n){e.each(u,function(t,r){n.filter(r)?console.warn("\n[filter duplication] : A filter named "+r+"has already been installed."): n.filter(r,t)})} var u=r(2),i=r(0); "undefined"!=typeof window&&window.Vue&&Vue.use(e) n.exports=e ``` -------------------------------- ### Get Component Options Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Retrieves and merges component options, including those from the superclass and extended options. ```javascript function ge(t){var e=t.options;if(t.super){var n=ge(t.super);if(n!==t.superOptions){t.superOptions=n;var r=_e(t);r&&y(t.extendOptions,r),(e=t.options=z(n,t.extendOptions)).name&&(e.components[e.name]=t)}}return e} ``` -------------------------------- ### Buffer Slice Method Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Creates a new buffer that references the same memory as the original buffer but with different start and end points. Changes to the new buffer may affect the original. ```javascript l.prototype.slice=function(e,t){var n=this.length;e=~~e,t=t===void 0?n:~~t,0>e?(e+=n,0>e&&(e=0)):e>n&&(e=n),0>t?(t+=n,0>t&&(t=0)):t>n&&(t=n),t",(e=e.firstChild)&&e.setAttribute("data-server-rendered","true"),o(r.staticClass)&&(e.setAttribute("class",r.staticClass)),o(r.class)&&e.setAttribute("class",r.class(e)),o(r.style)&&e.setAttribute("style",r.style(e)),o(r.attrs)&&Object.keys(r.attrs).forEach(function(t){e.setAttribute(t,r.attrs[t])}),o(r.props)&&Object.keys(r.props).forEach(function(t){e[t]=r.props[t]}),o(r.domProps)&&Object.keys(r.domProps).forEach(function(t){e[t]=r.domProps[t]}),o(r.events)&&Object.keys(r.events).forEach(function(t){e.addEventListener(t,r.events[t])}),o(r.nativeEvents)&&Object.keys(r.nativeEvents).forEach(function(t){e.addEventListener(t,r.nativeEvents[t])}),i){for(var a=0;a ``` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```typescript import OBSWebSocket, { EventSubscription } from 'obs-websocket-js'; const obs = new OBSWebSocket(); // Basic connection (no password) const info = await obs.connect('ws://127.0.0.1:4455'); console.log(`OBS WebSocket version: ${info.obsWebSocketVersion}`); // Connection with password const info2 = await obs.connect('ws://127.0.0.1:4455', 'my-secret-password'); // Connection with custom event subscriptions const info3 = await obs.connect( 'ws://127.0.0.1:4455', 'my-secret-password', { rpcVersion: 1, eventSubscriptions: EventSubscription.Scenes | EventSubscription.Inputs | EventSubscription.InputVolumeMeters, } ); // Full error handling example try { const { obsWebSocketVersion, negotiatedRpcVersion } = await obs.connect( 'ws://192.168.1.100:4455', 'password', { rpcVersion: 1 } ); console.log(`Connected to OBS ${obsWebSocketVersion} (RPC ${negotiatedRpcVersion})`); } catch (error) { if (error instanceof OBSWebSocketError) { console.error(`Connection failed [${error.code}]: ${error.message}`); } } ``` ### Response #### Success Response (200) - **obsWebSocketVersion** (string) - The version of obs-websocket. - **negotiatedRpcVersion** (number) - The negotiated RPC version. #### Response Example ```json { "obsWebSocketVersion": "5.3.0", "negotiatedRpcVersion": 1 } ``` ### Error Handling - **OBSWebSocketError** - Thrown on connection failure. Contains `code` and `message` properties. - `4008`: Authentication failed. - `4010`: Only one identify allowed. - `-1`: Non-OBS server or invalid subprotocol. ``` -------------------------------- ### Get Element Static and Inline Styles Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Retrieves static and inline styles from an element and its ancestors, merging them into a single style object. ```javascript function Ln(t,e){var n,r={};if(e)for(var i=t;i.componentInstance;)(i=i.componentInstance._vnode).data&&(n=En(i.data))&&y(r,n);(n=En(t.data))&&y(r,n);for(var o=t;o=o.parent;)o.data&&(n=En(o.data))&&y(r,n);return r} ``` -------------------------------- ### Initialize Component Instance Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Initializes a component instance with its properties, listeners, and render children. Handles inline templates. ```javascript function _init(t,e){t.prototype._init=function(t){var e=this, n=t&&t.propsData;this.isVueInstance=!0,e._update=function(t,n){e._vnode=t,n&&e._update(n)},e.$options=ye(e,t,e),e._render=function(){var t=e.$options.render,n=e.$createElement;return e._vnode=t(n,e,e.data,e.computed,e.methods),e._vnode.parent=null,e._vnode},me(e),t&&t.el&&e.$mount(t.el),e.$vnode=null,e._isMounted=!1,e._isDestroyed=!1,e._isBeingDestroyed=!1},Object.defineProperties(t.prototype,{$data:{get:function(){return this._data}},$props:{get:function(){return this._props}},$attrs:{get:function(){return this._attrs}},$listeners:{get:function(){return this._listeners}},$parent:{get:function(){return this._parent}},$root:{get:function(){return this._root}},$children:{get:function(){return this._children}},$slots:{get:function(){return this._slots}},$scopedSlots:{get:function(){return Ei||(this._scopedSlots={}),this._scopedSlots}},$refs:{get:function(){return this._refs}},$isServer:{get:function(){return!1}},$vue:{get:function(){return!0}}}}} ``` -------------------------------- ### Component Mount Lifecycle Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Handles the mounting process of a component, including calling beforeMount and mounted hooks, and setting up the initial watcher for rendering. ```javascript function Ct(t,e,n){t.$el=e,t.$options.render||(t.$options.render=lo),Ot(t,"beforeMount");var r;return r=function(){t._update(t._render(),n)},t._watcher=new $o(t,r,_),n=!1,null==t.$vnode&&(t._isMounted=!0,Ot(t,"mounted")),t} ``` -------------------------------- ### Connect to OBS WebSocket Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Establishes a connection to the OBS WebSocket server. Handles connection, authentication, and emits events for connection status. Requires an address and optionally a password. ```javascript async connect(e={},t){e=e||{};const n=e.address||'localhost:4444';return this._connected&&this._socket.close(),new Promise(async(t,o)=>{try{await this._connect(n),await this._authenticate(e.password),t()}catch(e){this._socket.close(),this._connected=!1,l(a,'Connection failed:',e),o(e)}}).callback(t)} ``` -------------------------------- ### Sort Listeners by Plainness Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Sorts event listeners based on whether they are 'plain' (likely referring to non-capturing listeners). Used in event handling setup. ```javascript function tt(t,e){return t.plain?-1:e.plain?1:0} ``` -------------------------------- ### Vue Devtools Initialization Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Initializing Vue devtools integration. ```javascript setTimeout(function(){Si.devtools&&Wi&&Wi.emit("init",$e)},0) ``` -------------------------------- ### Get Utility Function Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/samples/web-tester/dist/tester.html Retrieves a value from a nested object structure using a path. If the path does not exist, it returns undefined. This is a safe way to access potentially missing properties. ```javascript function e(n,t){return u.get(n,t)} var u=r(1); n.exports=e ``` -------------------------------- ### Connect to OBS WebSocket Server Source: https://context7.com/obs-websocket-community-projects/obs-websocket-js/llms.txt Establishes a WebSocket connection, performs the handshake, and optionally authenticates. Returns a promise with connection info. Handles clean disconnection if already connected. Includes full error handling for connection failures. ```typescript import OBSWebSocket, { EventSubscription } from 'obs-websocket-js'; const obs = new OBSWebSocket(); // Basic connection (no password) const info = await obs.connect('ws://127.0.0.1:4455'); console.log(`OBS WebSocket version: ${info.obsWebSocketVersion}`); // => "OBS WebSocket version: 5.3.0" console.log(`Negotiated RPC version: ${info.negotiatedRpcVersion}`); // => "Negotiated RPC version: 1" // Connection with password const info2 = await obs.connect('ws://127.0.0.1:4455', 'my-secret-password'); // Connection with custom event subscriptions // Only subscribe to scene and input events; explicitly add high-volume volume meters const info3 = await obs.connect( 'ws://127.0.0.1:4455', 'my-secret-password', { rpcVersion: 1, eventSubscriptions: EventSubscription.Scenes | EventSubscription.Inputs | EventSubscription.InputVolumeMeters, } ); // Full error handling example try { const { obsWebSocketVersion, negotiatedRpcVersion } = await obs.connect( 'ws://192.168.1.100:4455', 'password', { rpcVersion: 1 } ); console.log(`Connected to OBS ${obsWebSocketVersion} (RPC ${negotiatedRpcVersion})`); } catch (error) { // error is OBSWebSocketError with .code and .message if (error instanceof OBSWebSocketError) { console.error(`Connection failed [${error.code}]: ${error.message}`); // Close codes: 4008 = auth failed, 4010 = only one identify allowed // code -1 = non-OBS server or invalid subprotocol } } ``` -------------------------------- ### Connect to OBS WebSocket Source: https://github.com/obs-websocket-community-projects/obs-websocket-js/blob/master/README.md Use the `connect` method to establish a WebSocket connection to the OBS server. It accepts the server URL, an optional password for authentication, and identification parameters like RPC version and event subscriptions. The method returns a promise that resolves with connection details or rejects on error. ```typescript connect(url = 'ws://127.0.0.1:4455', password?: string, identificationParams = {}): Promise ``` ```typescript import OBSWebSocket, {EventSubscription} from 'obs-websocket-js'; const obs = new OBSWebSocket(); // connect to obs-websocket running on localhost with same port await obs.connect(); // Connect to obs-ws running on 192.168.0.4 await obs.connect('ws://192.168.0.4:4455'); // Connect to localhost with password await obs.connect('ws://127.0.0.1:4455', 'super-sekret'); // Connect expecting RPC version 1 await obs.connect('ws://127.0.0.1:4455', undefined, {rpcVersion: 1}); // Connect with request for high-volume event await obs.connect('ws://127.0.0.1:4455', undefined, { eventSubscriptions: EventSubscription.All | EventSubscription.InputVolumeMeters, rpcVersion: 1 }); // A complete example try { const { obsWebSocketVersion, negotiatedRpcVersion } = await obs.connect('ws://192.168.0.4:4455', 'password', { rpcVersion: 1 }); console.log(`Connected to server ${obsWebSocketVersion} (using RPC ${negotiatedRpcVersion})`) } catch (error) { console.error('Failed to connect', error.code, error.message); } ``` -------------------------------- ### Batch Request Execution with `callBatch()` Source: https://context7.com/obs-websocket-community-projects/obs-websocket-js/llms.txt Demonstrates how to execute multiple OBS WebSocket requests in a batch using `callBatch()`. It showcases different execution types: `SerialRealtime` for sequential execution with minimal delay, `SerialFrame` for sequential execution synchronized with OBS frames, and `Parallel` for concurrent execution of requests. ```APIDOC ## `callBatch()` - Execute Multiple Requests ### Description Executes a list of requests in a batch. The `executionType` parameter controls how these requests are processed. ### Parameters #### `requests` (Array