{"_id":"@brendonovich/obs-js","_rev":"3-1c35fa5b7e3b67a6e9e46bc146540e8b","name":"@brendonovich/obs-js","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@brendonovich/obs-js","version":"0.0.1","description":"","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest"},"author":"","license":"ISC","dependencies":{"eventemitter3":"^4.0.7","isomorphic-ws":"^4.0.1","nanoid":"^3.1.25"},"devDependencies":{"@types/jest":"^27.0.1","@types/ws":"^7.4.6","ts-node":"^10.2.1","typescript":"^4.4.0-beta"},"gitHead":"cf8f21127817e17019d0f7c60ddbd4000e587441","_id":"@brendonovich/obs-js@0.0.1","_nodeVersion":"15.14.0","_npmVersion":"7.7.6","dist":{"integrity":"sha512-VTTHDfPIta2wy5ZY8/kBBL2OjNT3l5wZBaMXKyfe1EjSKfpUcEVL+q6tOH6FGioVzGqB5FN9Ue7Gbz2wsoHCng==","shasum":"d3db2d56d5c1a85356c062c6a67a8a26c93b5f50","tarball":"https://registry.npmjs.org/@brendonovich/obs-js/-/obs-js-0.0.1.tgz","fileCount":61,"unpackedSize":152736,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhPNL2CRA9TVsSAnZWagAAxysQAIq2kxN7Mn1SzzQnQX8H\nPHmGE6G77YG/mVTlgDbX2P8BLM1HeMCL5qMDRPBmfButM4Vs1OkAqwDXmyMF\n50bMxLrlzwwSLm1X2y/el6qYCGmG55ox4zYdjZDEfiOU1ER03KS2hsd2B0iN\nFsPCSV5hIqul2JE3uCZIXBbbP+LLGqw408iWeG6Jn/8Zd8ybz9XCARtt1ZvF\nZ9MAM2ckU1srT0HzWQxoH4Zl38F9mFFsFtD1DFQWM6ogCi9GCdcO0EtggY5B\nuFAlzAiGX8rXeq73lM8Za8QZQnAx1+rAzGmC0E775CnJG60EKfIqK3dKurHo\nvejmo0xwyqqgItpdhXYbWoD6Fz8I5h5cOzfKhqupsCi3KzhCNeC6+hkJJKXz\n4gvtyXxGb2UwGPW92EiVSmkOVeBOk9IVue+aFHu1ZYnBl6kGOPyYUB4LnbPk\nZbQiwLXW2IXN3I7Drs6GRHhiUtT5xil2I8CK+pCfoBhckbYa7OBMc8OzQY0z\nsPuK4Zyil1nh5CtSvOyYFKzXkYUUnu9liZ47cenpxiGdr5ohUZ/N2Dz1qQXO\nushVxivypYxhSPVS0Jl54Msakh34fl86ZjfzeLlZJuglmm8t5nJRyVLbE5V6\nq30q2Zds1Vme1W2Duh4IntO6uthIRefb75eH9wMVQSjLLscTc+vk2AKgRiHw\nE6a9\r\n=B1Lk\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCjpa0Pm56Y0+twLyq1EQeASdH+ucta8hANK0GGBLz3RgIhAIMfNBXcHFH5oC+ZEgYSmIOt/3sml/YWaDA2LYU699Rv"}]},"_npmUser":{"name":"brendonovich","email":"brendonovich@outlook.com"},"directories":{},"maintainers":[{"name":"brendonovich","email":"brendonovich@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/obs-js_0.0.1_1631376117901_0.48503444772635507"},"_hasShrinkwrap":false},"0.0.2":{"name":"@brendonovich/obs-js","version":"0.0.2","description":"### _The easiest way to communicate with OBS_","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"author":"","license":"ISC","dependencies":{"eventemitter3":"^4.0.7","isomorphic-ws":"^4.0.1","nanoid":"^3.1.25"},"devDependencies":{"@types/jest":"^27.0.1","@types/ws":"^7.4.6","ts-node":"^10.2.1","typescript":"^4.4.0-beta"},"gitHead":"cd6deee75d8a9796791dc99ead4ef3ffd0dcc853","_id":"@brendonovich/obs-js@0.0.2","_nodeVersion":"15.14.0","_npmVersion":"7.7.6","dist":{"integrity":"sha512-9MaJ62L6tXv6nUSHBQKz8WM20x+SRM/y9jlqNv/wvz5wgJnbI3jLP2LRfUBMBc+3iZm2tmq9x9j7TqvvrAwhJA==","shasum":"68769e8c40d36352c73b4ef2811c3b8790c8e60d","tarball":"https://registry.npmjs.org/@brendonovich/obs-js/-/obs-js-0.0.2.tgz","fileCount":62,"unpackedSize":154793,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhPN0vCRA9TVsSAnZWagAADzYP/0frdE7S7ewu+wAorB1s\nkAdZNQHNsrR/qfxbox3soYZTexx8vVhHFB0EYJ9u3RZnE4KcB6fVtZC8zugk\nd1Uv31CW5Z1H4ToVq4IdCk+gMVUShDmx6xW2Uuk8QJAISK6mwHZd7PcI3U7P\nAoYVZVfskEbvGIlmK1I+Got2R20SQ7WHO2HZ6wLkf27RyHtsvbs3qCMH9BOr\nqpxczq18IiAE0XyCeEm4KMP+WsuTSGn/awinkJAiVodoBC6BURtHP05WkPCF\naCZf3jmNQ3vilO9Fip+5fmIVjDVaOPGOIvHelWd8UvtInDAgYtwmly6dvI+5\nPoa42OjO0rvnwmM9wwYsIf4nTEGgcoYOVtDrhvGMGGp5N5F17CWA4oZcqV7m\nxnGFUmuhlgGj5kgJ3YkggS8uVv0AdaiQLrWLHXWTgwVm3YWfvulGmFCpPU2S\nqjDCcIMAVmEcu1A46idPygCpMBjbOILXcwVIagiO006O+BHUqhs3T7JjAyKv\nt8ISVWAzG52aLqRg4i9+1VxRIZZ2vnr0l1aNXYDfFvHrF8shkqM0Agze26sS\nHazok3l9q5ymq97B7CKTfPO7/+x0APLLXg7hSsMtw/9PPt9XVdLwzFIv9I3/\noym+l0pGfu9tMqQ9gPYHnEgpF6cm0ibB2BnLA5LAHyJIT1v2hwaU0tE1rCDN\nWOW9\r\n=lZog\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCiKMhBGLHSi42tVKUBn11jcjQW2HaRj92obg32qesskAIhAPvEeMlU/l8obmojLAsp/5zcrVnmGM5wTjcKRQY7L+vp"}]},"_npmUser":{"name":"brendonovich","email":"brendonovich@outlook.com"},"directories":{},"maintainers":[{"name":"brendonovich","email":"brendonovich@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/obs-js_0.0.2_1631378735725_0.5411692578702965"},"_hasShrinkwrap":false},"0.0.3":{"name":"@brendonovich/obs-js","version":"0.0.3","description":"### _The easiest way to communicate with OBS_","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"test":"jest","build":"tsc"},"author":"","license":"ISC","dependencies":{"eventemitter3":"^4.0.7","isomorphic-ws":"^4.0.1","nanoid":"^3.1.25","ws":"^8.2.2"},"devDependencies":{"@types/jest":"^27.0.1","@types/ws":"^7.4.6","ts-node":"^10.2.1","typescript":"^4.4.0-beta"},"gitHead":"e6d60dc56aebd946bee0b1703e5e80361d597ae5","_id":"@brendonovich/obs-js@0.0.3","_nodeVersion":"15.14.0","_npmVersion":"7.7.6","dist":{"integrity":"sha512-H+7DhZufGg3cT4lvvr4jakaAdJNUeH/Ns02EbXYUnCkDzZkDADiWVQLJLYTmcov2oLKSCta5lQRfFGFcL9br8Q==","shasum":"777b8adbc54c9253a665aaa6442a6f3b803acaa4","tarball":"https://registry.npmjs.org/@brendonovich/obs-js/-/obs-js-0.0.3.tgz","fileCount":74,"unpackedSize":212405,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhQMgCCRA9TVsSAnZWagAAt98QAJK+3Sy8D98XD51NJb+0\n8JGHaf0tCJEeWt4fma1wBM8JEnaV0ySotf0Hfz/4bgb4xCaYHoK3FOAWXVO6\n9t8p8LZiJMFw8v7ypByfySKEdkwMECccTtxkES+VrFhP40lH8ATRmswT/G8Z\n/4znYaES5JZeAIlJZ1G6ZAjaOnCjOgWyzTL2WxmOFNRbvLMFtlQMzS39/E8f\nTN8LJmgE5be8CQXwqLG0D5LK2gQKXq/2cVpw+mVPGVUoEnTUQD7i5+CCIavt\n0xrkqpYydPGGS8CNEsraq04tpp68K5npXKJU4z2JvgcbYbOv8kmpZEIEGeC9\nB2oe3+wypCzgsjuDZ9yHgt/szQaubW9SXJKYFqbmTORKRoEI1Ple9wzp+cOJ\ncdRAiiFq8BxI0W5lc0l8nK4oAjsa9iciycO7H7lnYAyHsePAj6ry9tVndk18\nMFBOidKbm8lkz6KMiKqDP/SahM1wH/NeuRP5qo+UisGcwBkTxZRu7Nu8KfQu\nHEXUNmhWR/TWPcNKrrtWMJZ3kBJr6cPPJ26zaDqXlROgg5BRbSUsI72C6Yc8\nmlxE1TRniyFrwZzqS86+NkcWxlbxq/i3D/E363IwLi49YkabN9oXA9cn2jju\nk0p38Loyl33iv20jzlCnCO7ccifKAjntlGxREX2KvVbWP22eOVPTn1mS+Hzj\nRaVg\r\n=XlQ0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCK4KZ0Oxnfo2vqTnOl4uWz6lwFYH3WmRKwO8ZvF2ofwwIhANC0E8e1LrLYx13UMQqK/J9YD+rh3cOdd8fa3puF5Ish"}]},"_npmUser":{"name":"brendonovich","email":"brendonovich@outlook.com"},"directories":{},"maintainers":[{"name":"brendonovich","email":"brendonovich@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/obs-js_0.0.3_1631635458545_0.12398291823415519"},"_hasShrinkwrap":false}},"time":{"created":"2021-09-11T16:01:57.842Z","0.0.1":"2021-09-11T16:01:58.104Z","modified":"2022-04-04T20:31:21.411Z","0.0.2":"2021-09-11T16:45:35.922Z","0.0.3":"2021-09-14T16:04:18.743Z"},"maintainers":[{"name":"brendonovich","email":"brendonovich@outlook.com"}],"license":"ISC","readme":"# `obs-js`\n\n### _The easiest way to communicate with OBS_\n\n[![Downloads](https://img.shields.io/npm/dt/@brendonovich/obs-js.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@brendonovich/obs-js)\n[![Downloads](https://img.shields.io/npm/v/@brendonovich/obs-js.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@brendonovich/obs-js)\n[![Build Size](https://img.shields.io/bundlephobia/min/@brendonovich/obs-js?label=bundle%20size&style=flat&colorA=000000&colorB=000000)](https://bundlephobia.com/result?p=@brendonovich/obs-js)\n\nControlling 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.\n\nobs-js aims to fix this. By simply working with `Scene`, `Source`, and `SceneItem` objects, you can have unparalleled control over your OBS layout.\n\n# Beta Warning\n\nThis 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.\n\n## Features\n\n- Persistence across code reloads, so scenes and items aren't deleted and recreated each time you run your code\n- Automatic request batching\n- `Scene`, `Source` and `SceneItem` are designed to be overridden, allowing for complex layouts to be abstracted into subclasses\n- Easy integration into existing layouts with `Scene.link()`, allowing for incremental migration to `obs-js` without handing over your entire layout to your code\n\n## Installation\n\n1. Install the [fork of obs-websocket](https://github.com/Palakis/obs-websocket/releases)\n  \n    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.\n\n2. Install obs-js\n\n    ```\n    yarn add @brendonovich/obs-js\n    ```\n\n    or NPM\n\n    ```\n    npm install @brendonovich/obs-js\n    ```\n\n3. Connect to OBS.\n\n    Where you first use OBS in your code, import `obs`:\n\n    ```ts\n    import { obs } from \"@brendonovich/obs-js\";\n    ```\n\n    Then simply connect:\n\n    ```ts\n    await obs.connect({ address: \"localhost:4444\" });\n    ```\n\n4. Create and link with scenes and sources. See the example folder for a tutorial.\n\n## To Do\n\n- [x] Filters\n- [ ] Clean\n- [ ] Ignored symbol\n","readmeFilename":"README.md","description":"### _The easiest way to communicate with OBS_"}