onyx_online/vmrcli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vmrcli.git synced 2024-11-15 17:40:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Voicemeeter Remote CLI Utility
20 Commits 1 Branch 13 Tags 493 KiB
C 99.1%
Makefile 0.9%
85a47098e1
Go to file
onyx-and-iris 85a47098e1 add API Commands section to README
2024-06-26 17:13:04 +01:00
include add logging 2024-06-26 16:44:28 +01:00
src print help() if only program name passed 2024-06-26 16:58:10 +01:00
.gitignore first commit 2024-06-25 04:34:28 +01:00
makefile invoke pwsh 2024-06-25 16:45:46 +01:00
README.md add API Commands section to README 2024-06-26 17:13:04 +01:00

README.md

VMRCLI Command Line Utility

Tested against

  • Basic 1.1.1.1
  • Banana 2.1.1.1
  • Potato 3.1.1.1

Requirements

Use

./vmrcli.exe [-i] [-k] [-D] <api commands>

Where:

  • i: Enable interactive mode. If set any api commands passed will be ignored.
  • k: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
  • D: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL

API Commands

  • Commands starting with ! will be toggled, use it with boolean parameters.
  • Commands containing = will set a value.
  • All other commands with get a value.

Examples:

Launch basic GUI, set debug level to INFO, Toggle Strip 0 Mute, then print its new value

./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute

Launch banana GUI, set debug level to DEBUG, set Strip 0 label to podmic then print Strip 2 label

vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label

Script files

Scripts can be loaded from text files, for example:

./vbantxt-cli $(Get-Content .\example_commands.txt)