onyx_online/obsws-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-python.git synced 2024-11-23 21:30:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

expand the Requests section in README

Browse Source 
add a section about the {ReqClient}.send() method.
This commit is contained in:
onyx-and-iris 2023-08-14 11:11:46 +01:00
parent a7ef61018b
commit 70a422696e
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -62,7 +62,7 @@ cl.toggle_input_mute('Mic/Aux')
### Requests
Method names for requests match the API calls but snake cased.
Method names for requests match the API calls but snake cased. If a successful call is made with the Request client and the response is expected to contain fields then a response object will be returned. You may then access the response fields as class attributes. They will be snake cased.
example:
@ -70,13 +70,28 @@ example:
# load conn info from config.toml
cl = obs.ReqClient()
# GetVersion
# GetVersion, returns a response object
resp = cl.get_version()
# Access it's field as an attribute
print(f"OBS Version: {resp.obs_version}")
# SetCurrentProgramScene
cl.set_current_program_scene("BRB")
```
#### `send(param, data=None, raw=False)`
If you prefer to work with the JSON data directly the {ReqClient}.send() method accepts an argument, `raw`. If set to True the raw response data will be returned, instead of a response object.
example:
```python
resp = cl_req.send("GetVersion", raw=True)
print(f"response data: {resp}")
```
For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
### Events