vban-cli 0.3.0__tar.gz

vban_cli-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Onyx and Iris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vban_cli-0.3.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: vban-cli
+Version: 0.3.0
+Summary: A command-line interface for Voicemeeter leveraging VBAN.
+License: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cyclopts>=4.6.0
+Requires-Dist: vban-cmd>=2.6.0
+Dynamic: license-file
+
+# vban-cli
+
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+---
+
+## Install
+
+#### With uv
+
+```console
+uv tool install vban-cli
+```
+
+#### With pipx
+
+```console
+pipx install vban-cli
+```
+
+The CLI should now be discoverable as `vban-cli`
+
+---
+
+## Configuration
+
+### Flags
+
+```console
+vban-cli --host=localhost --port=6980 --streamname=Command1
+```
+
+### Environment Variables
+
+example .envrc:
+
+```env
+#!/usr/bin/env bash
+
+export VBAN_CLI_HOST="localhost"
+export VBAN_CLI_PORT=6980
+export VBAN_CLI_STREAMNAME=Command1
+```
+
+---
+
+## Use
+
+```console
+Usage: vban-cli COMMAND
+
+╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
+│ bus          Control the bus parameters.                                                         │
+│ strip        Control the strip parameters.                                                       │
+│ --help (-h)  Display this message and exit.                                                      │
+│ --version    Display application version.                                                        │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Parameters ─────────────────────────────────────────────────────────────────────────────────────╮
+│ --kind        Kind of Voicemeeter [env var: VBAN_CLI_KIND] [default: potato]                     │
+│ --host        VBAN host [env var: VBAN_CLI_HOST] [default: localhost]                            │
+│ --port        VBAN port [env var: VBAN_CLI_PORT] [default: 6980]                                 │
+│ --streamname  VBAN stream name [env var: VBAN_CLI_STREAMNAME] [default: Command1]                │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+For every command and subcommand there exists a `--help` flag for further usage information.
+
+---
+
+## Implementation Notes
+
+1. The VBAN TEXT subprotocol defines two packet structures [ident:0][ident-0] and [ident:1][ident-1]. Neither of them contain the data for Bus EQ parameters.
+2. Packet structure with [ident:1][ident-1] is emitted by the VBAN server only on pdirty events. This means we do not receive the initial state of those parameters on initial subscription. Therefore any commands which are intended to fetch the value of parameters defined in packet [ident:1][ident-1] will not work in this CLI.
+3. Packet structure with [ident:1][ident-1] defines parameteric EQ data only for the [first channel][ident-1-peq].
+
+
+---
+
+## Further Notes
+
+I've made the effort to set up the basic skeletal structure of the CLI as well as demonstrate how to combine subcommand groups with subcommand groups so more can be implemented, it just needs doing. There may be restrictions on some things however, for example, retrieving values is only possible for parameters [defined in the protocol](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L787). Setting parameters can be done for anything possible by a string request.
+
+If there's something missing that you would like to see added the best bet is to submit a PR. You may raise an issue and if it's quick and simple to do I may (or may not) do it.
+
+---
+
+## License
+
+`vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+ 
+
+
+[ident-0]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L896
+[ident-1]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L982
+[ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995

vban_cli-0.3.0/README.md

@@ -0,0 +1,96 @@
+# vban-cli
+
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+---
+
+## Install
+
+#### With uv
+
+```console
+uv tool install vban-cli
+```
+
+#### With pipx
+
+```console
+pipx install vban-cli
+```
+
+The CLI should now be discoverable as `vban-cli`
+
+---
+
+## Configuration
+
+### Flags
+
+```console
+vban-cli --host=localhost --port=6980 --streamname=Command1
+```
+
+### Environment Variables
+
+example .envrc:
+
+```env
+#!/usr/bin/env bash
+
+export VBAN_CLI_HOST="localhost"
+export VBAN_CLI_PORT=6980
+export VBAN_CLI_STREAMNAME=Command1
+```
+
+---
+
+## Use
+
+```console
+Usage: vban-cli COMMAND
+
+╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
+│ bus          Control the bus parameters.                                                         │
+│ strip        Control the strip parameters.                                                       │
+│ --help (-h)  Display this message and exit.                                                      │
+│ --version    Display application version.                                                        │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Parameters ─────────────────────────────────────────────────────────────────────────────────────╮
+│ --kind        Kind of Voicemeeter [env var: VBAN_CLI_KIND] [default: potato]                     │
+│ --host        VBAN host [env var: VBAN_CLI_HOST] [default: localhost]                            │
+│ --port        VBAN port [env var: VBAN_CLI_PORT] [default: 6980]                                 │
+│ --streamname  VBAN stream name [env var: VBAN_CLI_STREAMNAME] [default: Command1]                │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+For every command and subcommand there exists a `--help` flag for further usage information.
+
+---
+
+## Implementation Notes
+
+1. The VBAN TEXT subprotocol defines two packet structures [ident:0][ident-0] and [ident:1][ident-1]. Neither of them contain the data for Bus EQ parameters.
+2. Packet structure with [ident:1][ident-1] is emitted by the VBAN server only on pdirty events. This means we do not receive the initial state of those parameters on initial subscription. Therefore any commands which are intended to fetch the value of parameters defined in packet [ident:1][ident-1] will not work in this CLI.
+3. Packet structure with [ident:1][ident-1] defines parameteric EQ data only for the [first channel][ident-1-peq].
+
+
+---
+
+## Further Notes
+
+I've made the effort to set up the basic skeletal structure of the CLI as well as demonstrate how to combine subcommand groups with subcommand groups so more can be implemented, it just needs doing. There may be restrictions on some things however, for example, retrieving values is only possible for parameters [defined in the protocol](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L787). Setting parameters can be done for anything possible by a string request.
+
+If there's something missing that you would like to see added the best bet is to submit a PR. You may raise an issue and if it's quick and simple to do I may (or may not) do it.
+
+---
+
+## License
+
+`vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+ 
+
+
+[ident-0]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L896
+[ident-1]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L982
+[ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995

vban_cli-0.3.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "vban-cli"
+version = "0.3.0"
+description = "A command-line interface for Voicemeeter leveraging VBAN."
+readme = "README.md"
+license = { text = "LICENSE" }
+requires-python = ">=3.13"
+dependencies = ["cyclopts>=4.6.0", "vban-cmd>=2.6.0"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+
+[project.scripts]
+vban-cli = "vban_cli.app:run"
+
+[tool.uv]
+package = true
+
+[tool.uv.sources]
+vban-cmd = { path = "../vban-cmd-python" }

vban_cli-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vban_cli-0.3.0/src/vban_cli/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version('vban-cli')

vban_cli-0.3.0/src/vban_cli/app.py

@@ -0,0 +1,53 @@
+from dataclasses import dataclass
+from typing import Annotated
+
+import vban_cmd
+from cyclopts import App, Parameter, config
+
+from . import __version__ as version
+from . import bus, console, strip
+from .context import Context
+
+app = App(
+    config=config.Env(
+        'VBAN_CLI_',
+    ),  # Environment variable prefix for configuration parameters
+    version=version,
+)
+app.command(strip.app.meta, name='strip')
+app.command(bus.app.meta, name='bus')
+
+
+@Parameter(name='*')
+@dataclass
+class VBANConfig:
+    kind: Annotated[str, Parameter(help='Kind of Voicemeeter')] = 'potato'
+    host: Annotated[str, Parameter(help='VBAN host')] = 'localhost'
+    port: Annotated[int, Parameter(help='VBAN port')] = 6980
+    streamname: Annotated[str, Parameter(help='VBAN stream name')] = 'Command1'
+
+
+@app.meta.default
+def launcher(
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    vban_config: Annotated[VBANConfig, Parameter()] = VBANConfig(),
+):
+    with vban_cmd.api(
+        vban_config.kind,
+        ip=vban_config.host,
+        port=vban_config.port,
+        streamname=vban_config.streamname,
+    ) as client:
+        additional_kwargs = {}
+        command, bound, _ = app.parse_args(tokens)
+        additional_kwargs['ctx'] = Context(client=client)
+
+        return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+def run():
+    try:
+        app.meta()
+    except Exception as e:
+        console.err.print(f'Error: {e}')
+        return e.code

vban_cli-0.3.0/src/vban_cli/bus.py

@@ -0,0 +1,106 @@
+from typing import Annotated, Literal, Optional
+
+from cyclopts import App, Argument, Parameter
+
+from . import console
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='bus', help_formatter=CustomHelpFormatter())
+# See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 1.
+# app.command(eq.app.meta, name='eq')
+
+
+@app.meta.default
+def launcher(
+    index: Annotated[int, Argument()] = None,
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the bus parameters."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='mono')
+def mono(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the mono state of the specified bus.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the mono state to this value. If not provided, the current mono state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.bus[index].mono)
+        return
+    ctx.client.bus[index].mono = new_value
+
+
+@app.command(name='mute')
+def mute(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the mute state of the specified bus.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the mute state to this value. If not provided, the current mute state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.bus[index].mute)
+        return
+    ctx.client.bus[index].mute = new_value
+
+
+@app.command(name='mode')
+def mode(
+    type_: Annotated[
+        Optional[
+            Literal[
+                'normal',
+                'amix',
+                'bmix',
+                'repeat',
+                'composite',
+                'tvmix',
+                'upmix21',
+                'upmix41',
+                'upmix61',
+                'centeronly',
+                'lfeonly',
+                'rearonly',
+            ]
+        ],
+        Argument(),
+    ] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the bus mode of the specified bus.
+
+    Parameters
+    ----------
+    type_ : str, optional
+        If provided, sets the bus mode to this value. If not provided, the current bus mode is printed.
+    """
+    if type_ is None:
+        console.out.print(ctx.client.bus[index].mode.get())
+        return
+    setattr(ctx.client.bus[index].mode, type_, True)

vban_cli-0.3.0/src/vban_cli/comp.py

@@ -0,0 +1,67 @@
+from typing import Annotated
+
+from cyclopts import App, Argument, Parameter
+
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='comp', help_formatter=CustomHelpFormatter())
+
+
+@app.meta.default
+def launcher(
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    index: Annotated[int, Argument()] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the compressor parameters."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='knob')
+def knob(
+    new_knob: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the knob of the specified compressor.
+
+    Parameters
+    ----------
+    new_knob : int, optional
+        If provided, sets the knob to this value. If not provided, the current knob is printed.
+    """
+    if new_knob is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].comp.knob)
+        return
+    ctx.client.strip[index].comp.knob = new_knob
+
+
+@app.command(name='input-gain')
+def input_gain(
+    new_gain: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the input gain of the specified compressor.
+
+    Parameters
+    ----------
+    new_gain : float, optional
+        If provided, sets the input gain to this value. If not provided, the current input gain is printed.
+    """
+    if new_gain is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].comp.gainin)
+        return
+    ctx.client.strip[index].comp.gainin = new_gain

vban_cli-0.3.0/src/vban_cli/console.py

@@ -0,0 +1,4 @@
+from rich.console import Console
+
+out = Console()
+err = Console(stderr=True)

vban_cli-0.3.0/src/vban_cli/context.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+from vban_cmd.vbancmd import VbanCmd
+
+
+@dataclass
+class Context:
+    client: VbanCmd

vban_cli-0.3.0/src/vban_cli/denoiser.py

@@ -0,0 +1,46 @@
+from typing import Annotated
+
+from cyclopts import App, Argument, Parameter
+
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='denoiser', help_formatter=CustomHelpFormatter())
+
+
+@app.meta.default
+def launcher(
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    index: Annotated[int, Argument()] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the denoiser parameters."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='knob')
+def knob(
+    new_knob: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the knob of the specified denoiser.
+
+    Parameters
+    ----------
+    new_knob : int, optional
+        If provided, sets the knob to this value. If not provided, the current knob is printed.
+    """
+    if new_knob is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].denoiser.knob)
+        return
+    ctx.client.strip[index].denoiser.knob = new_knob

vban_cli-0.3.0/src/vban_cli/eq.py

@@ -0,0 +1,53 @@
+from typing import Annotated
+
+from cyclopts import App, Argument, Parameter
+
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='eq', help_formatter=CustomHelpFormatter())
+
+
+@app.meta.default
+def launcher(
+    band: Annotated[int, Argument()] = None,
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    index: Annotated[int, Argument()] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the EQ parameters.
+
+    Only channel 0 is supported, see https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 3.
+    """
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if band is not None:
+        additional_kwargs['band'] = band
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='on')
+def on(
+    new_state: Annotated[bool, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    band: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the on state of the specified EQ band.
+
+    Parameters
+    ----------
+    new_state : bool
+        If provided, sets the on state to this value. If not provided, the current on state is printed.
+    """
+    if new_state is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].eq.channel[0].cell[band].on)
+        return
+    ctx.client.strip[index].eq.channel[0].cell[band].on = new_state

vban_cli-0.3.0/src/vban_cli/gate.py

@@ -0,0 +1,67 @@
+from typing import Annotated
+
+from cyclopts import App, Argument, Parameter
+
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='gate', help_formatter=CustomHelpFormatter())
+
+
+@app.meta.default
+def launcher(
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    index: Annotated[int, Argument()] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the compressor parameters."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='knob')
+def knob(
+    new_knob: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the knob of the specified gate.
+
+    Parameters
+    ----------
+    new_knob : int, optional
+        If provided, sets the knob to this value. If not provided, the current knob is printed.
+    """
+    if new_knob is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].gate.knob)
+        return
+    ctx.client.strip[index].gate.knob = new_knob
+
+
+@app.command(name='threshold')
+def threshold(
+    new_threshold: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the threshold of the specified gate.
+
+    Parameters
+    ----------
+    new_threshold : float, optional
+        If provided, sets the threshold to this value. If not provided, the current threshold is printed.
+    """
+    if new_threshold is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # console.out.print(ctx.client.strip[index].gate.threshold)
+        return
+    ctx.client.strip[index].gate.threshold = new_threshold

vban_cli-0.3.0/src/vban_cli/help.py

@@ -0,0 +1,43 @@
+import re
+
+from cyclopts.help import DefaultFormatter, HelpPanel
+from rich.console import Console, ConsoleOptions
+
+
+class CustomHelpFormatter(DefaultFormatter):
+    """Custom help formatter that injects an index argument into the usage line and filters it out from the parameters list.
+
+    This formatter modifies the usage line to include an <index> argument after the 'strip' command,
+    and filters out any parameters related to 'index' from the Parameters section of the help output.
+    """
+
+    def render_usage(self, console: Console, options: ConsoleOptions, usage) -> None:
+        """Render the usage line with index argument injected."""
+        if usage:
+            modified_usage = re.sub(
+                r'(\S+\s+[a-z]+)\s+(COMMAND)', r'\1 <index> \2', str(usage)
+            )
+            console.print(f'[bold]Usage:[/bold] {modified_usage}')
+
+    def __call__(
+        self, console: Console, options: ConsoleOptions, panel: HelpPanel
+    ) -> None:
+        """Render a help panel, filtering out the index parameter from Parameters sections."""
+        if panel.title == 'Parameters':
+            filtered_entries = [
+                entry
+                for entry in panel.entries
+                if not (
+                    entry.names and any('index' in name.lower() for name in entry.names)
+                )
+            ]
+
+            filtered_panel = HelpPanel(
+                title=panel.title,
+                entries=filtered_entries,
+                description=panel.description,
+                format=panel.format,
+            )
+            super().__call__(console, options, filtered_panel)
+        else:
+            super().__call__(console, options, panel)

vban_cli-0.3.0/src/vban_cli/strip.py

@@ -0,0 +1,270 @@
+from typing import Annotated, Optional
+
+from cyclopts import App, Argument, Parameter
+
+from . import comp, console, denoiser, eq, gate
+from .context import Context
+from .help import CustomHelpFormatter
+
+app = App(name='strip', help_formatter=CustomHelpFormatter())
+app.command(eq.app.meta, name='eq')
+app.command(comp.app.meta, name='comp')
+app.command(gate.app.meta, name='gate')
+app.command(denoiser.app.meta, name='denoiser')
+
+
+@app.meta.default
+def launcher(
+    index: Annotated[int, Argument()] = None,
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Control the strip parameters."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None:
+        additional_kwargs['index'] = index
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='mono')
+def mono(
+    new_state: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the mono state of the specified strip.
+
+    Parameters
+    ----------
+    new_state : bool, optional
+        If provided, sets the mono state to this value. If not provided, the current mono state is printed.
+    """
+    if new_state is None:
+        console.out.print(ctx.client.strip[index].mono)
+        return
+    ctx.client.strip[index].mono = new_state
+
+
+@app.command(name='solo')
+def solo(
+    new_state: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the solo state of the specified strip.
+
+    Parameters
+    ----------
+    new_state : bool, optional
+        If provided, sets the solo state to this value. If not provided, the current solo state is printed.
+    """
+    if new_state is None:
+        console.out.print(ctx.client.strip[index].solo)
+        return
+    ctx.client.strip[index].solo = new_state
+
+
+@app.command(name='mute')
+def mute(
+    new_state: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the mute state of the specified strip.
+
+    Parameters
+    ----------
+    new_state : bool, optional
+        If provided, sets the mute state to this value. If not provided, the current mute state is printed.
+    """
+    if new_state is None:
+        console.out.print(ctx.client.strip[index].mute)
+        return
+    ctx.client.strip[index].mute = new_state
+
+
+@app.command(name='gain')
+def gain(
+    new_value: Annotated[Optional[float], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the gain of the specified strip.
+
+    Parameters
+    ----------
+    new_value : float, optional
+        If provided, sets the gain to this value. If not provided, the current gain is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].gain)
+        return
+    ctx.client.strip[index].gain = new_value
+
+
+@app.command(name='A1')
+def a1(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the A1 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the A1 state to this value. If not provided, the current A1 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].A1)
+        return
+    ctx.client.strip[index].A1 = new_value
+
+
+@app.command(name='A2')
+def a2(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the A2 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the A2 state to this value. If not provided, the current A2 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].A2)
+        return
+    ctx.client.strip[index].A2 = new_value
+
+
+@app.command(name='A3')
+def a3(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the A3 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the A3 state to this value. If not provided, the current A3 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].A3)
+        return
+    ctx.client.strip[index].A3 = new_value
+
+
+@app.command(name='A4')
+def a4(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the A4 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the A4 state to this value. If not provided, the current A4 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].A4)
+        return
+    ctx.client.strip[index].A4 = new_value
+
+
+@app.command(name='A5')
+def a5(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the A5 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the A5 state to this value. If not provided, the current A5 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].A5)
+        return
+    ctx.client.strip[index].A5 = new_value
+
+
+@app.command(name='B1')
+def b1(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the B1 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the B1 state to this value. If not provided, the current B1 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].B1)
+        return
+    ctx.client.strip[index].B1 = new_value
+
+
+@app.command(name='B2')
+def b2(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the B2 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the B2 state to this value. If not provided, the current B2 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].B2)
+        return
+    ctx.client.strip[index].B2 = new_value
+
+
+@app.command(name='B3')
+def b3(
+    new_value: Annotated[Optional[bool], Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the B3 state of the specified strip.
+
+    Parameters
+    ----------
+    new_value : bool, optional
+        If provided, sets the B3 state to this value. If not provided, the current B3 state is printed.
+    """
+    if new_value is None:
+        console.out.print(ctx.client.strip[index].B3)
+        return
+    ctx.client.strip[index].B3 = new_value

vban_cli-0.3.0/src/vban_cli.egg-info/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: vban-cli
+Version: 0.3.0
+Summary: A command-line interface for Voicemeeter leveraging VBAN.
+License: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cyclopts>=4.6.0
+Requires-Dist: vban-cmd>=2.6.0
+Dynamic: license-file
+
+# vban-cli
+
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+---
+
+## Install
+
+#### With uv
+
+```console
+uv tool install vban-cli
+```
+
+#### With pipx
+
+```console
+pipx install vban-cli
+```
+
+The CLI should now be discoverable as `vban-cli`
+
+---
+
+## Configuration
+
+### Flags
+
+```console
+vban-cli --host=localhost --port=6980 --streamname=Command1
+```
+
+### Environment Variables
+
+example .envrc:
+
+```env
+#!/usr/bin/env bash
+
+export VBAN_CLI_HOST="localhost"
+export VBAN_CLI_PORT=6980
+export VBAN_CLI_STREAMNAME=Command1
+```
+
+---
+
+## Use
+
+```console
+Usage: vban-cli COMMAND
+
+╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
+│ bus          Control the bus parameters.                                                         │
+│ strip        Control the strip parameters.                                                       │
+│ --help (-h)  Display this message and exit.                                                      │
+│ --version    Display application version.                                                        │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Parameters ─────────────────────────────────────────────────────────────────────────────────────╮
+│ --kind        Kind of Voicemeeter [env var: VBAN_CLI_KIND] [default: potato]                     │
+│ --host        VBAN host [env var: VBAN_CLI_HOST] [default: localhost]                            │
+│ --port        VBAN port [env var: VBAN_CLI_PORT] [default: 6980]                                 │
+│ --streamname  VBAN stream name [env var: VBAN_CLI_STREAMNAME] [default: Command1]                │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+For every command and subcommand there exists a `--help` flag for further usage information.
+
+---
+
+## Implementation Notes
+
+1. The VBAN TEXT subprotocol defines two packet structures [ident:0][ident-0] and [ident:1][ident-1]. Neither of them contain the data for Bus EQ parameters.
+2. Packet structure with [ident:1][ident-1] is emitted by the VBAN server only on pdirty events. This means we do not receive the initial state of those parameters on initial subscription. Therefore any commands which are intended to fetch the value of parameters defined in packet [ident:1][ident-1] will not work in this CLI.
+3. Packet structure with [ident:1][ident-1] defines parameteric EQ data only for the [first channel][ident-1-peq].
+
+
+---
+
+## Further Notes
+
+I've made the effort to set up the basic skeletal structure of the CLI as well as demonstrate how to combine subcommand groups with subcommand groups so more can be implemented, it just needs doing. There may be restrictions on some things however, for example, retrieving values is only possible for parameters [defined in the protocol](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L787). Setting parameters can be done for anything possible by a string request.
+
+If there's something missing that you would like to see added the best bet is to submit a PR. You may raise an issue and if it's quick and simple to do I may (or may not) do it.
+
+---
+
+## License
+
+`vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+ 
+
+
+[ident-0]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L896
+[ident-1]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L982
+[ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995

vban_cli-0.3.0/src/vban_cli.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+src/vban_cli/__init__.py
+src/vban_cli/app.py
+src/vban_cli/bus.py
+src/vban_cli/comp.py
+src/vban_cli/console.py
+src/vban_cli/context.py
+src/vban_cli/denoiser.py
+src/vban_cli/eq.py
+src/vban_cli/gate.py
+src/vban_cli/help.py
+src/vban_cli/strip.py
+src/vban_cli.egg-info/PKG-INFO
+src/vban_cli.egg-info/SOURCES.txt
+src/vban_cli.egg-info/dependency_links.txt
+src/vban_cli.egg-info/entry_points.txt
+src/vban_cli.egg-info/requires.txt
+src/vban_cli.egg-info/top_level.txt

vban_cli-0.3.0/src/vban_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

vban_cli-0.3.0/src/vban_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+vban-cli = vban_cli.app:run

vban_cli-0.3.0/src/vban_cli.egg-info/requires.txt

@@ -0,0 +1,2 @@
+cyclopts>=4.6.0
+vban-cmd>=2.6.0

vban_cli-0.3.0/src/vban_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+vban_cli