onyx_online/obsws-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-python.git synced 2026-04-18 05:53:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor OBSSDKRequestError

Browse Source 
reword error section in README
This commit is contained in:
onyx-and-iris
2023-08-14 00:44:59 +01:00
parent 013cf15024
commit a7ef61018b
2 changed files with 12 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -128,13 +128,13 @@ def on_scene_created(data):
### Errors
A base error class `OBSSDKError` may be used to catch OBSSDK error types.
If a request returns an error code an `OBSSDKRequestError` will be raised.
For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
If a timeout occurs during sending/receiving a request or receiving an event an `OBSSDKTimeoutError` will be raised.
- `OBSSDKError`: Base error class.
- `OBSSDKTimeoutError`: Raised if a timeout occurs during sending/receiving a request or receiving an event
- `OBSSDKRequestError`: Raised when a request returns an error code.
- The following attributes are available:
- `req_name`: name of the request.
- `code`: request status code.
- For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
### Logging