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

updated readme

Browse Source
This commit is contained in:
Adem 2023-05-29 10:48:41 +00:00
parent 3adf094481
commit 15559fdb33
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -27,7 +27,7 @@ By default the clients connect with parameters:
- `host`: "localhost" - `host`: "localhost"
- `port`: 4455 - `port`: 4455
- `password`: "" - `password`: ""
- `timeout`: 3
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.
Order of precedence: keyword arguments then config file then default values. Order of precedence: keyword arguments then config file then default values.
@ -41,6 +41,7 @@ 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.
@ -53,7 +54,7 @@ Example `__main__.py`:
import obsws_python as obs import obsws_python as obs
# pass conn info if not in config.toml # pass conn info if not in config.toml
cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass') cl = obs.ReqClient(host='localhost', port=4455, password='mystrongpass', timeout=3)
# 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')