onyx_online/vban-cmd-python
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cmd-python.git synced 2024-09-27 13:17:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
bus modes and gainlayers sections added to readme.
This commit is contained in:
onyx-and-iris 2022-03-18 07:40:24 +00:00
parent 863debdbe7
commit 84cc4d097d
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -120,15 +120,26 @@ The following properties are gettable and settable:
- `solo`: boolean - `solo`: boolean
- `mute`: boolean - `mute`: boolean
- `label`: string - `label`: string
- `gainlayer`: float, -60 to 12
- `gain`: float, -60 to 12 - `gain`: float, -60 to 12
- Output mapping (e.g. `A1`, `B3`, etc.): boolean, depends on the Voicemeeter kind - Output mapping (e.g. `A1`, `B3`, etc.): boolean, depends on the Voicemeeter kind
The following properties are settable: The following properties are settable:
- `comp`: float, from 0.0 to 10.0 - `comp`: float, from 0.0 to 10.0
- `gate`: float, from 0.0 to 10.0 - `gate`: float, from 0.0 to 10.0
- `limit`: int, from -40 to 12 - `limit`: int, from -40 to 12
#### `gainlayer`
- `gainlayer[j].gain`: float, -60 to 12
for example:
```python
# set and get the value of the second input strip, fourth gainlayer
vban.strip[1].gainlayer[3].gain = -6.3
print(vban.strip[1].gainlayer[3].gain)
```
Gainlayers defined for Potato version only.
### `Bus` ### `Bus`
The following properties are gettable and settable: The following properties are gettable and settable:
- `mute`: boolean - `mute`: boolean
@ -138,6 +149,17 @@ The following properties are gettable and settable:
- `label`: string - `label`: string
- `gain`: float, -60 to 12 - `gain`: float, -60 to 12
#### `mode`
Bus modes are gettable and settable
- `normal`, `amix`, `bmix`, `repeat`, `composite`, `tvmix`, `upmix21`,
- `upmix41`, `upmix61`, `centeronly`, `lfeonly`, `rearonly`
for example:
```python
# set leftmost bus mode to tvmix
vban.bus[0].mode.tvmix = True
```
### `VbanCmd` (lower level) ### `VbanCmd` (lower level)
#### `vban.set_rt(id_, param, val)` #### `vban.set_rt(id_, param, val)`
Sends a string request RT Packet where the command would take the form: Sends a string request RT Packet where the command would take the form: