onyx_online/obsws-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-python.git synced 2024-11-22 12:50:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
A Python SDK for OBS Studio WebSocket v5.0
7 Commits 5 Branches 0 Tags 432 KiB
Python 100%
b5b69de218
Go to file
onyx-and-iris b5b69de218 add support for toml config. 
subject module added, supports callbacks.

events module added. Provides an event listener and callback trigger.

import isorted, code run through black.

toml section added to readme.

added a couple of examples.
2022-07-25 23:51:30 +01:00
build/lib/obsstudio_sdk add support for toml config. 2022-07-25 23:51:30 +01:00
examples add support for toml config. 2022-07-25 23:51:30 +01:00
obsstudio_sdk add support for toml config. 2022-07-25 23:51:30 +01:00
.gitignore add support for toml config. 2022-07-25 23:51:30 +01:00
LICENSE initial commit including request calls to obswebsocket 2022-06-05 14:40:55 +03:00
README.md add support for toml config. 2022-07-25 23:51:30 +01:00
setup.py . 2022-06-05 17:14:54 +03:00

README.md

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

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')
>>>