mirror of
https://github.com/onyx-and-iris/xair-api-python.git
synced 2026-04-18 13:33:31 +00:00
rename xair obs dir
upd poetry script
This commit is contained in:
26
examples/xair_obs/README.md
Normal file
26
examples/xair_obs/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
## 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 XAir states with OBS scene switches. 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 = "localhost"
|
||||
port = 4455
|
||||
password = "mystrongpass"
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Change the xair ip argument from `mixer.local` to the ip of your xair mixer. Run the code and switch between scenes in OBS.
|
||||
|
||||
## Notes
|
||||
|
||||
This example was inspired by [OBS-to-XAir](https://github.com/lebaston100/OBS-to-XAir)
|
||||
Reference in New Issue
Block a user