{"repo":"obs-websocket-community-projects/obs-websocket-js","free":true,"listed":false,"github":"https://github.com/obs-websocket-community-projects/obs-websocket-js","clone":"git clone https://github.com/obs-websocket-community-projects/obs-websocket-js.git","description":"Consumes https://github.com/obsproject/obs-websocket","language":"TypeScript","stars":768,"topics":["obs","obs-websocket","javascript","obs-studio","websocket-client","nodejs"],"license":"MIT","category":"dev-tools","readme_excerpt":"obs-websocket-js obs-websocket-js allows Javascript-based connections to the Open Broadcaster Software plugin obs-websocket . Created by Brendan Hagan Maintained by OBS Websocket Community Download Samples Changelog Version Warning! You are currently reading the documentation for v5. For v4 documentation look here --- Installation Via package manager Using a package manager like npm / yarn is the recommended installation method when you're planning to use obs-websocket-js in node.js, building a web app that you'll bundle with webpack or rollup, or for using type definitions. Standalone file / CDN build Standalone js file is available from jsdeliver & unpkg CDN's: Usage Builds dist folder of the npm package includes 2 different builds to support different message encodings supported by obs-websocket. Connection Encoding JSON Msgpack --- --- --- Used by default By web bundles By node.js Manually opting into import OBSWebSocket from 'obs-web-socket/json' import OBSWebSocket from 'obs-web-socket/msgpack' Benefits Easier debugging, smaller bundle Connection uses less bandwidth Downsides Connection uses more bandwidth Harder to debug, bigger bundle size In addition each version has both modern and legacy builds. Modern bundlers will opt into modern build which uses most modern JS features while also being supported by most modern browsers. If you need support for older browsers, make sure to configure your bundler to also transpile dependencies with babel or other such . Creating a","default_branch":null,"files":null,"tree":[],"storefront":"/r/obs-websocket-community-projects","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/obs-websocket-community-projects/obs-websocket-js/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}