mirror of
https://github.com/onyx-and-iris/obsws-python.git
synced 2024-11-22 12:50:53 +00:00
54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# 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](https://obsproject.com/)
|
|
- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
|
|
- 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:
|
|
|
|
```toml
|
|
[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 server
|
|
- `port`: port to access server
|
|
- `password`: obs websocket server password
|
|
|
|
Example `__main__.py`
|
|
|
|
```python
|
|
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')
|
|
```
|
|
|
|
### Official Documentation
|
|
|
|
- [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)
|