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

## 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)
obs example added 2022-07-02 02:23:22 +01:00			`## Requirements`

			`- [OBS Studio](https://obsproject.com/)`
update links in obs example readme 2022-09-16 12:46:44 +01:00			`- [OBS Python SDK for Websocket v5](https://github.com/aatikturk/obsws-python)`
obs example added 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`
obs example updated for websocket v5 setup.py added to obs example readme for obs example updated 2022-07-29 20:06:26 +01:00			a config file named `config.toml` placed next to `__main__.py`. It also assumes you have scenes named `START` `BRB` `END` and `LIVE`.
obs example added 2022-07-02 02:23:22 +01:00
obs example updated for websocket v5 setup.py added to obs example readme for obs example updated 2022-07-29 20:06:26 +01:00			A valid `config.toml` file might look like this:
obs example added 2022-07-02 02:23:22 +01:00
obs example updated for websocket v5 setup.py added to obs example readme for obs example updated 2022-07-29 20:06:26 +01:00			```toml
obs example added 2022-07-02 02:23:22 +01:00			`[connection]`
obs example updated for websocket v5 setup.py added to obs example readme for obs example updated 2022-07-29 20:06:26 +01:00			`host = "localhost"`
			`port = 4455`
			`password = "mystrongpass"`
obs example added 2022-07-02 02:23:22 +01:00			```
add link to streamlabs example in obs readme 2022-08-06 08:58:42 +01:00
modify logging config to filter out logs script now ends when OBS is closed. 2023-06-23 17:44:51 +01:00			`Closing OBS will end the script.`

add link to streamlabs example in obs readme 2022-08-06 08:58:42 +01:00			`## Notes`

modify logging config to filter out logs script now ends when OBS is closed. 2023-06-23 17:44:51 +01:00			In this example all but `voicemeeterlib.iremote` logs are filtered out. Log level set at DEBUG.

update links in obs example readme 2022-09-16 12:46:44 +01:00			`For a similar Streamlabs Desktop example:`
add link to streamlabs example in obs readme 2022-08-06 08:58:42 +01:00
point streamlabs example to gist 2022-09-16 13:00:38 +01:00			`[Streamlabs example](https://gist.github.com/onyx-and-iris/c864f07126eeae389b011dc49520a19b)`