Update README.md

add types to props in readme.

add gainlayers, busmodes to readme
This commit is contained in:
onyx-and-iris 2022-03-08 23:04:01 +00:00
parent 10c326a2f5
commit 88d4e6b6f5

View File

@ -74,19 +74,47 @@ There is no bounds checking in this wrapper, meaning if you attempt to set a
parameter that does not exist for that version of Voicemeeter the wrapper will parameter that does not exist for that version of Voicemeeter the wrapper will
throw an error. So make sure what you are settings actually exists. throw an error. So make sure what you are settings actually exists.
### Strip|Bus ### Strip
The following strip/bus commands are available: The following strip commands are available:
- mute - mute: bool
- mono - mono: bool
- solo - mc: bool
- A1-A5 - k: int, from 0 to 4
- B1-B3 - solo: bool
- limit - A1-A5: bool
- gain - B1-B3: bool
- comp - limit: int, from -40 to 12
- gate - gain: float, from -60 to 12
- comp: float, from 0 to 10
- gate: float, from 0 to 10
- gainlayer0-gainlayer7: float
for example:
```
$vmr.strip[5].gainlayer1 = -8.3
```
A,B commands depend on Voicemeeter type. A,B commands depend on Voicemeeter type.
gainlayers defined for Potato version only.
mc, k for virtual strips only.
### Bus
The following strip commands are available:
- mute: bool
- mono: bool
- eq: bool
- limit: int, from -40 to 12
- gain: float, from -60 to 12
- mode_: bool, any of the following:
@('normal', 'amix', 'bmix', 'repeat', 'composite', 'tvmix', 'upmix21',
'upmix41', 'upmix61', 'centeronly', 'lfeonly', 'rearonly')
for example:
```
$vmr.button[3].mode_repeat = $true
```
A,B commands depend on Voicemeeter type.
gainlayers defined for Potato version only.
### Macrobuttons ### Macrobuttons
Three modes defined: state, stateonly and trigger. Three modes defined: state, stateonly and trigger.
@ -133,6 +161,7 @@ Certain 'special' commands are defined by the API as performing actions rather t
The following methods are available: The following methods are available:
- show - show
- hide
- restart - restart
- shutdown - shutdown