mirror of
https://github.com/onyx-and-iris/vbantxt.git
synced 2025-06-27 13:50:28 +01:00
200 lines
4.0 KiB
Markdown
200 lines
4.0 KiB
Markdown
|
|
|
|
|
|
# VBAN Sendtext
|
|
|
|
Send Voicemeeter/Matrix vban requests.
|
|
|
|
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
- [Installation](#installation)
|
|
- [VBANTXT Package](#vbantxt-package)
|
|
- [VBANTXT CLI](#vbantxt-cli)
|
|
- [License](#license)
|
|
|
|
## Requirements
|
|
|
|
- [Voicemeeter](https://voicemeeter.com/) or [Matrix](https://vb-audio.com/Matrix/)
|
|
- Go 1.18 or greater (a binary is available in [Releases](https://github.com/onyx-and-iris/vbantxt/releases))
|
|
|
|
## Tested against
|
|
|
|
- Basic 1.1.1.9
|
|
- Banana 2.1.1.9
|
|
- Potato 3.1.1.9
|
|
- Matrix 1.0.1.2
|
|
|
|
---
|
|
|
|
## `VBANTXT Package`
|
|
|
|
```console
|
|
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)
|
|
}
|
|
}
|
|
```
|
|
|
|
## `VBANTXT CLI`
|
|
|
|
### Installation
|
|
|
|
```console
|
|
go install github.com/onyx-and-iris/vbantxt/cmd/vbantxt@latest
|
|
```
|
|
|
|
### Use
|
|
|
|
Simply pass your vban commands as command line arguments:
|
|
|
|
```console
|
|
vbantxt "strip[0].mute=1 strip[1].mono=1"
|
|
```
|
|
|
|
### Configuration
|
|
|
|
#### Flags
|
|
|
|
```console
|
|
FLAGS
|
|
-H, --host STRING VBAN host (default: localhost)
|
|
-p, --port INT VBAN port (default: 6980)
|
|
-s, --streamname STRING VBAN stream name (default: Command1)
|
|
-b, --bps INT VBAN BPS (default: 256000)
|
|
-n, --channel INT VBAN channel (default: 0)
|
|
-r, --ratelimit INT VBAN rate limit (ms) (default: 20)
|
|
-C, --config STRING Path to the configuration file (default: $XDG_CONFIG_HOME/vbantxt/config.toml)
|
|
-l, --loglevel STRING Log level (debug, info, warn, error, fatal, panic) (default: warn)
|
|
-v, --version Show version information
|
|
```
|
|
|
|
Pass --host, --port and --streamname as flags on the root command, for example:
|
|
|
|
```console
|
|
vbantxt --host=localhost --port=6980 --streamname=Command1 --help
|
|
```
|
|
|
|
#### Environment Variables
|
|
|
|
All flags have corresponding environment variables, prefixed with `VBANTXT_`:
|
|
|
|
```bash
|
|
#!/usr/bin/env bash
|
|
|
|
export VBANTXT_HOST=localhost
|
|
export VBANTXT_PORT=6980
|
|
export VBANTXT_STREAMNAME=Command1
|
|
```
|
|
|
|
Flags will override environment variables.
|
|
|
|
#### TOML Config
|
|
|
|
By default the config loader will look for a config in:
|
|
|
|
- $XDG_CONFIG_HOME / vbantxt / config.toml (see [os.UserConfigDir](https://pkg.go.dev/os#UserConfigDir))
|
|
- A custom config path may be passed with the --config/-C flag.
|
|
|
|
All flags have corresponding keys in the config file, for example:
|
|
|
|
```toml
|
|
host="gamepc.local"
|
|
port=6980
|
|
streamname="Command1"
|
|
```
|
|
|
|
---
|
|
|
|
## `Script files`
|
|
|
|
The vbantxt CLI 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:
|
|
|
|
```console
|
|
vbantxt $(Get-Content .\script.txt)
|
|
```
|
|
|
|
Or with Bash:
|
|
|
|
```console
|
|
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:
|
|
|
|
```console
|
|
vbantxt "Point(ASIO128.IN[2],ASIO128.OUT[1]).dBGain = -8"
|
|
```
|
|
|
|
---
|
|
|
|
## `Logging`
|
|
|
|
The --loglevel/-l flag allows you to control the verbosity of the application's logging output.
|
|
|
|
Acceptable values for this flag are:
|
|
|
|
- `debug`
|
|
- `info`
|
|
- `warn`
|
|
- `error`
|
|
- `fatal`
|
|
- `panic`
|
|
|
|
For example, to set the log level to `debug`, you can use:
|
|
|
|
```console
|
|
vbantxt --loglevel=debug "bus[0].eq.on=1 bus[1].gain=-12.8"
|
|
```
|
|
|
|
The default log level is `warn` if the flag is not specified.
|
|
|
|
|
|
## License
|
|
|
|
`vbantxt` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|