voicemeeter/examples/vm-cli/README.md

33 lines
927 B
Markdown
Raw Normal View History

2022-09-17 03:21:04 +01:00
## About
A simple voicemeeter-cli program. Offers ability to toggle, get and set parameters.
2022-09-29 18:17:23 +01:00
## Install
2022-09-29 18:27:26 +01:00
First build and install it with `go install` (skip this step if using binary from [Releases](https://github.com/onyx-and-iris/voicemeeter/releases))
2022-09-29 18:17:23 +01:00
2022-09-17 03:21:04 +01:00
## Use
Toggle with `!` prefix, get by excluding `=` and set by including `=`. Mix and match arguments.
2022-09-18 05:45:09 +01:00
You may pass the following optional flags:
2022-09-18 05:45:09 +01:00
2022-09-29 18:31:15 +01:00
- -v: (-verbose) to toggle console output.
- -k: (-kind) to set the kind of Voicemeeter. Defaults to banana.
- -d: (-delay) to set a delay on the getters. Defaults to 20ms.
2022-09-17 03:21:04 +01:00
for example:
2022-09-29 18:17:23 +01:00
`vm-cli.exe -v -k=potato -d=25 strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
2022-09-17 03:21:04 +01:00
Expected output:
```
Running command strip[0].mute=0
Value of strip[0].mute is: 0
Toggling strip[0].mute
Value of strip[0].mute is: 1
Running command bus[0].gain=-8.8
Running command command.lock=1
2022-09-17 03:21:04 +01:00
```