Skip to content

Commit e852859

Browse files
committed
Add readme
1 parent 5eef0e3 commit e852859

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# vmcli
2+
3+
## Usage
4+
5+
This tool allows you to set different VoiceMeeter properties from the command line:
6+
7+
```
8+
vmcli <property setting> ...
9+
```
10+
11+
The properties are described in the API documentation [here](https://download.vb-audio.com/Download_CABLE/VoicemeeterRemoteAPI.pdf).
12+
13+
## Examples
14+
15+
Setting the gain of the first input to 0:
16+
17+
```
18+
vmcli Strip[0].Gain=0
19+
```
20+
21+
Increasing the gain by 10:
22+
23+
```
24+
vmcli Strip[0].Gain+=10
25+
```
26+
27+
Decreasing the gain by 10:
28+
29+
```
30+
vmcli Strip[0].Gain-=10
31+
```
32+
33+
Toggling properties:
34+
35+
```
36+
vmcli !Strip[0].Mute
37+
```
38+
39+
Multiple settings can be changed at once:
40+
41+
```
42+
vmcli Strip[0].Mute=0 Strip[0].Gain=10 Strip[1].Mute=1
43+
```

0 commit comments

Comments
 (0)