onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2025-01-18 18:40:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
add config files section to readme
This commit is contained in:
onyx-and-iris 2022-06-16 16:56:20 +01:00
parent a585285a0f
commit 575b681445
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -171,6 +171,22 @@ vban.strip[0].apply(mute: true, gain: 3.2, A1: true)
vban.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24) vban.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24)
``` ```
## Config Files
`vban.apply_config('config')`
You may load config files in TOML format.
Three example profiles have been included with the package. Remember to save
current settings before loading a profile. To set one you may do:
```python
import vban_cmd
with vban_cmd.api('banana') as vban:
vban.apply_config('config')
```
will load a config file at configs/banana/config.toml for Voicemeeter Banana.
## `Base Module` ## `Base Module`
### VbanCmd class ### VbanCmd class