voicemeeter-api-python/examples/obs/README.md
2023-06-23 17:44:51 +01:00

29 lines
834 B
Markdown

## Requirements
- [OBS Studio](https://obsproject.com/)
- [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsws-python)
## About
A simple demonstration showing how to sync OBS scene switches to Voicemeeter states. The script assumes you have 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 = "localhost"
port = 4455
password = "mystrongpass"
```
Closing OBS will end the script.
## Notes
In this example all but `voicemeeterlib.iremote` logs are filtered out. Log level set at DEBUG.
For a similar Streamlabs Desktop example:
[Streamlabs example](https://gist.github.com/onyx-and-iris/c864f07126eeae389b011dc49520a19b)