onyx_online/voicemeeter-api-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-python.git synced 2024-11-15 16:40:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

add example configs. move config files section in readme

Browse Source 
add example configs. move config files section in readme
This commit is contained in:
onyx-and-iris 2022-06-16 16:56:45 +01:00
parent b8a773d5a0
commit 9a239bc061
4 changed files with 110 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -30,7 +30,6 @@ Install voicemeeter-api package from your console
`pip install voicemeeter-api` `pip install voicemeeter-api`
## `Use` ## `Use`
Simplest use case, use a context manager to request a Remote class of a kind. Simplest use case, use a context manager to request a Remote class of a kind.
@ -248,6 +247,22 @@ vm.strip[0].apply(mute: true, gain: 3.2, A1: true)
vm.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24) vm.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24)
``` ```
## Config Files
`vm.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 voicemeeterlib
with voicemeeterlib.api('banana') as vm:
vm.apply_config('config')
```
will load a config file at configs/banana/config.toml for Voicemeeter Banana.
## `Base Module` ## `Base Module`
### Remote class ### Remote class
@ -271,22 +286,6 @@ vm.set('Strip[4].Label', 'stripname')
vm.set('Strip[0].Gain', -3.6) vm.set('Strip[0].Gain', -3.6)
``` ```
## Config Files
`vm.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 voicemeeterlib
with voicemeeterlib.api('banana') as vm:
vm.apply_profile('config')
```
will load a config file at configs/banana/config.toml for Voicemeeter Banana.
### Run tests ### Run tests
To run all tests: To run all tests:

35
configs/banana/config.toml Normal file
View File

@ -0,0 +1,35 @@
[strip-0]
limit = 12
label = ""
[strip-1]
A1 = true
A2 = true
A3 = true
B1 = true
B2 = true
mono = true
solo = true
mute = true
limit = 12
label = ""
[strip-2]
limit = 12
label = ""
[strip-3]
limit = 12
label = ""
[strip-4]
A1 = false
A2 = false
A3 = false
B1 = false
B2 = false
k = false
solo = false
mute = false
limit = 12
label = ""

17
configs/basic/config.toml Normal file
View File

@ -0,0 +1,17 @@
[strip-0]
A1 = true
B1 = true
mono = true
solo = true
mute = true
limit = 12
label = ""
[strip-1]
A1 = false
B1 = false
mono = false
solo = false
mute = false
limit = 12
label = ""

42
configs/potato/config.toml Normal file
View File

@ -0,0 +1,42 @@
[strip-0]
limit = 12
label = ""
[strip-1]
limit = 12
label = ""
[strip-2]
A1 = true
A2 = true
A3 = true
A4 = true
A5 = true
B1 = true
B2 = true
B3 = true
mono = true
solo = true
mute = true
limit = 12
label = ""
[strip-3]
limit = 12
label = ""
[strip-4]
limit = 12
label = ""
[strip-5]
limit = 12
label = ""
[strip-6]
limit = 12
label = ""
[strip-7]
limit = 12
label = ""