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

update readme Errors section

Browse Source
This commit is contained in:
onyx-and-iris 2023-06-19 17:46:43 +01:00
parent 9e3c1d3f37
commit d84d30b752
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -48,3 +48,6 @@ venv.bak/
# Test/config # Test/config
quick.py quick.py
config.toml config.toml
obsws.log
.vscode/

4
README.md
View File

@ -27,6 +27,7 @@ By default the clients connect with parameters:
- `host`: "localhost" - `host`: "localhost"
- `port`: 4455 - `port`: 4455
- `password`: "" - `password`: ""
- `timeout`: None
You may override these parameters by storing them in a toml config file or passing them as keyword arguments. You may override these parameters by storing them in a toml config file or passing them as keyword arguments.
@ -41,7 +42,6 @@ A valid `config.toml` might look like this:
host = "localhost" host = "localhost"
port = 4455 port = 4455
password = "mystrongpass" password = "mystrongpass"
timeout = 3
``` ```
It should be placed in your user home directory. It should be placed in your user home directory.
@ -132,6 +132,8 @@ If a request fails an `OBSSDKError` will be raised with a 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) 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.
### Logging ### Logging
If you want to see the raw messages simply set log level to DEBUG If you want to see the raw messages simply set log level to DEBUG