patch bump

add implementation note 4

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.10.7
+    hooks:
+      # Update the uv lockfile
+      - id: uv-lock

README.md

@@ -93,6 +93,20 @@ vban-cli strip 4 eq cell 5 type 5
 
 see `vban-cli strip eq cell --help` for more info.
 
+#### Strip Gainlayer Command
+
+Usage: vban-cli strip \<index> gainlayer \<gainlayer_index> COMMAND [OPTIONS] [ARGS]
+
+examples:
+
+```console
+vban-cli strip 0 gainlayer 0 level
+
+vban-cli strip 3 gainlayer 2 level -13.5
+```
+
+see `vban-cli strip gainlayer --help` for more info.
+
 ### Bus Command
 
 Usage: vban-cli bus \<index> COMMAND [ARGS]
@@ -130,9 +144,9 @@ examples:
 ```console
 vban-cli recorder play
 
-vban-cli recorder rew
+vban-cli recorder pause
 
-vban-cli recorder replay
+vban-cli recorder goto "00:01:30"
 ```
 
 see `vban-cli recorder --help` for more info.
@@ -163,9 +177,10 @@ see `vban-cli sendtext --help` for more info.
 
 ## 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.
+1. The VBAN RT SERVICE 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 current 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].
+4. There doesn't appear to be any way to retrieve the current recorder status, ie, recording, playing, stopped etc. I don't see the data available in either packet structures [ident:0][ident-0] or [ident:1][ident-1].
 
 ---
 
@@ -186,5 +201,5 @@ If there's something missing that you would like to see added the best bet is to
 
 
 [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]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L1053
 [ident-1-peq]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/3be2c1c36563afbd6df3da8436406c77d2cc1f10/VoicemeeterRemote.h#L995

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vban-cli"
-version = "0.8.0"
+version = "0.9.1"
 description = "A command-line interface for Voicemeeter leveraging VBAN."
 readme = "README.md"
 license = { text = "LICENSE" }

src/vban_cli/gainlayer.py

@@ -0,0 +1,51 @@
+from typing import Annotated
+
+from cyclopts import App, Argument, Parameter
+
+from . import console
+from .context import Context
+from .help import GainlayerHelpFormatter
+
+app = App(name='gainlayer', help_formatter=GainlayerHelpFormatter())
+
+
+@app.meta.default
+def launcher(
+    gainlayer_index: 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 gainlayers."""
+    additional_kwargs = {}
+    command, bound, _ = app.parse_args(tokens)
+    if index is not None and gainlayer_index is not None:
+        additional_kwargs['strip_index'] = index
+        additional_kwargs['gainlayer_index'] = gainlayer_index
+    else:
+        raise ValueError('Both gainlayer_index and index must be provided.')
+    if ctx is not None:
+        additional_kwargs['ctx'] = ctx
+
+    return command(*bound.args, **bound.kwargs, **additional_kwargs)
+
+
+@app.command(name='level')
+def level(
+    new_level: Annotated[float, Argument()] = None,
+    *,
+    strip_index: Annotated[int, Parameter(show=False)] = None,
+    gainlayer_index: Annotated[int, Parameter(show=False)] = None,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Get or set the level of the specified gainlayer.
+
+    Parameters
+    ----------
+    new_level : float
+        If provided, sets the level to this value. If not provided, the current level is printed.
+    """
+    if new_level is None:
+        console.out.print(ctx.client.strip[strip_index].gainlayer[gainlayer_index].gain)
+        return
+    ctx.client.strip[strip_index].gainlayer[gainlayer_index].gain = new_level

src/vban_cli/help.py

@@ -95,6 +95,22 @@ class EqHelpFormatter(BaseHelpFormatter):
             console.print(f'[bold]Usage:[/bold] {modified_usage}')
 
 
+class GainlayerHelpFormatter(BaseHelpFormatter):
+    """Help formatter for gainlayer commands that works with strip commands.
+
+    Injects <index> after 'strip' and <gainlayer_index> after 'gainlayer'."""
+
+    def render_usage(self, console: Console, options: ConsoleOptions, usage) -> None:
+        """Render the usage line with proper <index> placement for strip commands."""
+        if usage:
+            modified_usage = re.sub(
+                r'(\S+\s+strip)(\s+gainlayer\s+)(COMMAND)',
+                r'\1 <index>\2<[cyan]gainlayer_index[/cyan]> \3',
+                str(usage),
+            )
+            console.print(f'[bold]Usage:[/bold] {modified_usage}')
+
+
 class CellHelpFormatter(BaseHelpFormatter):
     """Help formatter for cell commands that works with both strip and bus commands.
 
@@ -105,7 +121,7 @@ class CellHelpFormatter(BaseHelpFormatter):
         if usage:
             modified_usage = re.sub(
                 r'(\S+\s+)(\w+)(\s+eq\s+cell\s+)(COMMAND)',
-                r'\1\2 <index>\3<band> \4',
+                r'\1\2 <index>\3<[cyan]band[/cyan]> \4',
                 str(usage),
             )
             console.print(f'[bold]Usage:[/bold] {modified_usage}')

src/vban_cli/recorder.py

@@ -20,26 +20,29 @@ def play(
     console.out.print('Recorder playback started.')
 
 
-@app.command(name='stop')
-def stop(
-    *,
-    ctx: Annotated[Context, Parameter(show=False)] = None,
-):
-    """Stop the recorder playback."""
-    ctx.client.recorder.stop()
-    console.out.print('Recorder playback stopped.')
-
-
 @app.command(name='pause')
 def pause(
     *,
     ctx: Annotated[Context, Parameter(show=False)] = None,
 ):
     """Pause the recorder playback."""
-    ctx.client.recorder.pause()
+    ctx.client.recorder.stop()
     console.out.print('Recorder playback paused.')
 
 
+@app.command(name='stop')
+def stop(
+    *,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Stop the recorder playback/recording and reset to the beginning."""
+    ctx.client.recorder.stop()
+    ctx.client.recorder.goto('00:00:00')
+    # We have no way of knowing if the recorder was playing or recording, so we print a generic message.
+    # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 4.
+    console.out.print('Recorder stopped.')
+
+
 @app.command(name='replay')
 def replay(
     *,
@@ -57,7 +60,17 @@ def record(
 ):
     """Start recording."""
     ctx.client.recorder.record()
-    console.out.print('Recording started.')
+    console.out.print('Recorder recording started.')
+
+
+@app.command(name='pause-recording')
+def pause_recording(
+    *,
+    ctx: Annotated[Context, Parameter(show=False)] = None,
+):
+    """Pause the recorder recording."""
+    ctx.client.recorder.pause()
+    console.out.print('Recorder recording paused.')
 
 
 @app.command(name='ff')

src/vban_cli/strip.py

@@ -2,7 +2,7 @@ from typing import Annotated, Optional
 
 from cyclopts import App, Argument, Parameter
 
-from . import comp, console, denoiser, eq, gate
+from . import comp, console, denoiser, eq, gainlayer, gate
 from .context import Context
 from .help import StripHelpFormatter
 
@@ -11,6 +11,7 @@ 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.command(gainlayer.app.meta, name='gainlayer')
 
 
 @app.meta.default

uv.lock

@@ -124,7 +124,7 @@ wheels = [
 
 [[package]]
 name = "vban-cli"
-version = "0.8.0"
+version = "0.9.1"
 source = { editable = "." }
 dependencies = [
     { name = "cyclopts" },
@@ -141,7 +141,7 @@ requires-dist = [
 
 [[package]]
 name = "vban-cmd"
-version = "2.8.0"
+version = "2.8.1"
 source = { editable = "../vban-cmd-python" }
 
 [package.metadata]