mirror of
https://github.com/onyx-and-iris/vbantxt.git
synced 2025-04-07 23:03:49 +01:00
onyx-and-iris
b070fb615e
add some validation logic update Logging section in README bps now defaults to 256000 (same as the vban-text-client) see: https://github.com/vburel2018/VBAN-Text-Client
138 lines
2.6 KiB
Markdown
138 lines
2.6 KiB
Markdown
|
|
|
|
|
|
# VBAN Sendtext
|
|
|
|
Send Voicemeeter/Matrix vban requests.
|
|
|
|
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|
|
|
## Tested against
|
|
|
|
- Basic 1.0.8.4
|
|
- Banana 2.0.6.4
|
|
- Potato 3.0.2.4
|
|
- Matrix 1.0.0.3
|
|
|
|
## Requirements
|
|
|
|
- [Voicemeeter](https://voicemeeter.com/) or [Matrix](https://vb-audio.com/Matrix/)
|
|
- Go 1.18 or greater (if you want to compile yourself, otherwise check `Releases`)
|
|
|
|
---
|
|
|
|
## `Use`
|
|
|
|
`go get github.com/onyx-and-iris/vbantxt`
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
|
|
"github.com/onyx-and-iris/vbantxt"
|
|
)
|
|
|
|
func main() {
|
|
var (
|
|
host string = "vm.local"
|
|
port int = 6980
|
|
streamname string = "onyx"
|
|
)
|
|
|
|
client, err := vbantxt.New(host, port, streamname)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
defer client.Close()
|
|
|
|
err = client.Send("strip[0].mute=0")
|
|
if err != nil {
|
|
_, _ = fmt.Fprintf(os.Stderr, "Error: %s", err)
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
```
|
|
|
|
## `Command Line`
|
|
|
|
Pass `host`, `port` and `streamname` as flags, for example:
|
|
|
|
```
|
|
vbantxt -h="gamepc.local" -p=6980 -s=Command1 "strip[0].mute=1 strip[1].mono=1"
|
|
```
|
|
|
|
You may also store them in a `config.toml` located in `home directory / .config / vbantxt /`
|
|
|
|
A valid `config.toml` might look like this:
|
|
|
|
```toml
|
|
[connection]
|
|
host="gamepc.local"
|
|
port=6980
|
|
streamname="Command1"
|
|
```
|
|
|
|
- `host` defaults to "localhost"
|
|
- `port` defaults to 6980
|
|
- `streamname` defaults to "Command1"
|
|
|
|
Command line flags will override values in a config.toml.
|
|
|
|
---
|
|
|
|
## `Script files`
|
|
|
|
The vbantxt-cli utility accepts a single string request or an array of string requests. This means you can pass scripts stored in files.
|
|
|
|
For example, in Windows with Powershell you could:
|
|
|
|
`vbantxt $(Get-Content .\script.txt)`
|
|
|
|
Or with Bash:
|
|
|
|
`xargs vbantxt < script.txt`
|
|
|
|
to load commands from a file:
|
|
|
|
```
|
|
strip[0].mute=1;strip[0].mono=0
|
|
strip[1].mute=0;strip[1].mono=1
|
|
bus[3].eq.On=0
|
|
```
|
|
|
|
---
|
|
|
|
## `Matrix`
|
|
|
|
Sending commands to VB-Audio Matrix is also possible, for example:
|
|
|
|
```
|
|
vbantxt -s=streamname "Point(ASIO128.IN[2],ASIO128.OUT[1]).dBGain = -8"
|
|
```
|
|
|
|
---
|
|
|
|
## `Logging`
|
|
|
|
The `-log-level` flag allows you to control the verbosity of the application's logging output.
|
|
|
|
Acceptable values for this flag are:
|
|
|
|
- `trace`
|
|
- `debug`
|
|
- `info`
|
|
- `warn`
|
|
- `error`
|
|
- `fatal`
|
|
- `panic`
|
|
|
|
For example, to set the log level to `debug`, you can use:
|
|
|
|
```
|
|
vbantxt -s=streamname -log-level=debug "bus[0].eq.on=1 bus[1].gain=-12.8"
|
|
```
|
|
|
|
The default log level is `warn` if the flag is not specified.
|