onyx_online/voicemeeter
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter.git synced 2024-11-16 01:50:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
1b9d633217
voicemeeter/examples/vm-cli/README.md
onyx-and-iris 1b9d633217 add help dialogue 
add guard for toggleCmd to prevent unsafe gain changes.

use logrus for control of log levels.

add an input prompt for interactive mode
2024-07-02 06:50:28 +01:00

1.2 KiB
Raw Blame History

About

A Voicemeeter CLI, offers ability to toggle, get and set parameters.

Install

First build and install it with go install (skip this step if using binary from Releases)

Use

Commands that begin with ! will toggle a parameter, commands that contain = will set a parameter, all other commands will get a value.

You may pass the following optional flags:

  • -h: Print the help dialogue
  • -i: Enable interactive mode
  • -k: The kind of Voicemeeter GUI to launch, defaults to Banana
  • -l: Log level (0 up to 6), defaults to 3, Warn Level
  • -d: Set the delay between commands, defaults to 20ms
  • -v: Enable extra console output (toggle and set messages).

for example:

vm-cli.exe -v -l=4 -k=potato strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1

Expected output:

time="<timestamp>" level=info msg="Logged into Voicemeeter Banana v2.1.1.1"
strip[0].mute: 1.00
Toggling strip[0].mute
strip[0].mute: 0.00
Setting strip[0].label=podmic
strip[0].label: podmic
time="<timestamp>" level=info msg="Logged out of Voicemeeter Banana"

If running in interactive mode enter Q, to exit.