mirror of
https://github.com/onyx-and-iris/obsws-python.git
synced 2024-11-22 12:50:53 +00:00
A Python SDK for OBS Studio WebSocket v5.0
2a3a86c277
remove getter, setter for send. add persistend data unit test add hotkey example default event sub now 0. explicitly define subs in event class. now subs can be set as kwarg |
||
|---|---|---|
| examples | ||
| obsstudio_sdk | ||
| tests | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| setup.py | ||
A Python SDK for OBS Studio WebSocket v5.0
This is a wrapper around OBS Websocket. Not all endpoints in the official documentation are implemented.
Requirements
- OBS Studio
- OBS Websocket v5 Plugin
- Python 3.11 or greater
How to install using pip
pip install obsstudio-sdk
How to Use
Load connection info from toml config. A valid config.toml might look like this:
[connection]
host = "localhost"
port = 4455
password = "mystrongpass"
It should be placed next to your __main__.py file.
Otherwise:
Import and start using, parameters are as follows:
host: obs websocket serverport: port to access serverpassword: obs websocket server password
Example __main__.py
import obsstudio_sdk as obs
# pass conn info if not in config.toml
cl = obs.ReqClient('localhost', 4455, 'mystrongpass')
# Toggle the mute state of your Mic input
cl.toggle_input_mute('Mic/Aux')