voicemeeter-api-python/examples/obs/README.md

25 lines
703 B
Markdown
Raw Normal View History

2022-07-02 02:23:22 +01:00
## Requirements
- [OBS Studio](https://obsproject.com/)
2022-09-16 12:46:44 +01:00
- [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsws-python)
2022-07-02 02:23:22 +01:00
## 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`.
2022-07-02 02:23:22 +01:00
A valid `config.toml` file might look like this:
2022-07-02 02:23:22 +01:00
```toml
2022-07-02 02:23:22 +01:00
[connection]
host = "localhost"
port = 4455
password = "mystrongpass"
2022-07-02 02:23:22 +01:00
```
## Notes
2022-09-16 12:46:44 +01:00
For a similar Streamlabs Desktop example:
2022-09-16 13:00:38 +01:00
[Streamlabs example](https://gist.github.com/onyx-and-iris/c864f07126eeae389b011dc49520a19b)