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

move link to documentation into its own section

Browse Source
This commit is contained in:
onyx-and-iris 2022-07-26 22:18:32 +01:00
parent 1c24b4bc1e
commit 0819149d09
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,10 +1,7 @@
# obs_sdk # A Python SDK for OBS Studio WebSocket v5.0
### A Python SDK for OBS Studio WebSocket v5.0
This is a wrapper around OBS Websocket. 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. Not all endpoints in the official documentation are implemented.
[obs-websocket github page](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#Requests)
## Requirements ## Requirements
@ -50,3 +47,7 @@ cl = ReqClient('localhost', 4455, 'mystrongpass')
# Toggle the mute state of your Mic input # Toggle the mute state of your Mic input
cl.toggle_input_mute('Mic/Aux') 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)