mirror of
https://github.com/onyx-and-iris/vban-cmd-python.git
synced 2025-01-18 10:30:48 +00:00
Update README.md
add profiles section to readme
This commit is contained in:
parent
1c57528cd8
commit
06c005ab5e
34
README.md
34
README.md
@ -90,6 +90,39 @@ vban.bus[0].eq = not vban.bus[0].eq
|
|||||||
vban.logout()
|
vban.logout()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Profiles
|
||||||
|
Profiles through config files are supported.
|
||||||
|
|
||||||
|
Three example profiles are provided with the package, one for each kind of Voicemeeter.
|
||||||
|
To test one first rename _profiles directory to profiles.
|
||||||
|
They will be loaded into memory but not applied. To apply one you may do:
|
||||||
|
`vmr.apply_profile('config')`, but remember to save your current settings first.
|
||||||
|
|
||||||
|
profiles directory can be safely deleted if you don't wish to load them each time.
|
||||||
|
|
||||||
|
A config can contain any key that `remote.apply()` would accept. Additionally, `extends` can be provided to inherit from another profile. Two profiles are available by default:
|
||||||
|
- `blank`, all strip off and all sliders to `0.0`. mono, solo, mute, eq all disabled.
|
||||||
|
- `base`, all physical strip to `A1`, all virtual strip to `B1`, all sliders to `0.0`.
|
||||||
|
|
||||||
|
Sample `mySetup.toml`
|
||||||
|
```toml
|
||||||
|
extends = 'base'
|
||||||
|
[strip-0]
|
||||||
|
mute = 1
|
||||||
|
|
||||||
|
[strip-5]
|
||||||
|
A1 = 0
|
||||||
|
A2 = 1
|
||||||
|
A4 = 1
|
||||||
|
gain = 0.0
|
||||||
|
|
||||||
|
[strip-6]
|
||||||
|
A1 = 0
|
||||||
|
A2 = 1
|
||||||
|
A4 = 1
|
||||||
|
gain = 0.0
|
||||||
|
```
|
||||||
|
|
||||||
## API
|
## API
|
||||||
### Kinds
|
### Kinds
|
||||||
A *kind* specifies a major Voicemeeter version. Currently this encompasses
|
A *kind* specifies a major Voicemeeter version. Currently this encompasses
|
||||||
@ -137,7 +170,6 @@ vban.apply({
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### `Strip`
|
### `Strip`
|
||||||
The following properties are gettable and settable:
|
The following properties are gettable and settable:
|
||||||
- `mono`: boolean
|
- `mono`: boolean
|
||||||
|
Loading…
Reference in New Issue
Block a user