obs example added.

README for obs example added
This commit is contained in:
onyx-and-iris
2022-10-06 20:29:03 +01:00
parent 4ee37f54c5
commit e0f4aab257
2 changed files with 108 additions and 0 deletions

39
examples/obs/README.md Normal file
View File

@@ -0,0 +1,39 @@
## Requirements
- [OBS Studio](https://obsproject.com/)
- [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsws-python)
## About
Perhaps you have a streaming setup but you want to control OBS and Voicemeeter from a remote location with python installed.
With the vban-cmd and obsws-python packages you may sync a distant Voicemeeter with a distant OBS over LAN.
The script assumes you have OBS connection info saved in a config file named `config.toml` placed next to `__main__.py`.
It also assumes you have scenes named `START` `BRB` `END` and `LIVE`.
A valid `config.toml` file might look like this:
```toml
[connection]
host = "gamepc.local"
port = 4455
password = "mystrongpass"
```
## Use
Simply fill in the OBS websocket details into `config.toml` and your VBAN text request settings in the script (`ip`, `streamname` and `port`).
Make sure you have established a working connection to OBS and the remote Voicemeeter.
Change OBS scenes and watch Voicemeeter parameters change.
Pressing `<Enter>` will exit.
## Notes
This script can be run from a Linux host since the vban-cmd interface relies on UDP packets and obsws-python runs over websockets.
You could for exmaple, set this up to run in the background on a home server such as a Raspberry Pi.
It requires Python 3.10+.