A Python SDK for OBS Studio WebSocket v5.0
Go to file
onyx-and-iris c8f2b6419d add subs intenum to baseclient
expand events example
2022-07-26 04:36:55 +01:00
examples add subs intenum to baseclient 2022-07-26 04:36:55 +01:00
obsstudio_sdk add subs intenum to baseclient 2022-07-26 04:36:55 +01:00
.gitignore refreshed ignored files 2022-07-26 01:03:57 +01:00
LICENSE initial commit including request calls to obswebsocket 2022-06-05 14:40:55 +03:00
README.md send event name to callback 2022-07-26 03:31:32 +01:00
setup.py . 2022-06-05 17:14:54 +03:00

obs_sdk

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. But all endpoints in the Requests section is implemented. You can find the relevant document using below link. obs-websocket github page

Requirements

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 server port: port to access server password: obs websocket server password
>>>from obsstudio_sdk.reqs import ReqClient
>>>
>>>client = ReqClient('192.168.1.1', 4444, 'somepassword')

Now you can make calls to OBS

Example: Toggle the mute state of your Mic input

>>>cl.ToggleInputMute('Mic/Aux')
>>>