onyx_online/vmrcli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vmrcli.git synced 2025-01-18 08:41:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

add API Commands section to README

Browse Source
This commit is contained in:
onyx-and-iris 2024-06-26 17:13:04 +01:00
parent 276d34feb9
commit 85a47098e1
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -20,6 +20,22 @@ Where:
- `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: