fix the eq router. now it works for both strip and bus.

it uses a factory function to create an eq router for each kind.

add models.eq.EQParams. Use it to define on and ab properties.

minor bump

.gitignore

@@ -88,7 +88,7 @@ ipython_config.py
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:
-# .python-version
+.python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -185,9 +185,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 

.python-version

@@ -1 +0,0 @@
-3.13

README.md

@@ -14,60 +14,23 @@ pip install vmr-http
 ## Run
 
 ```console
-uvicorn vmr_http.app:app
+uvicorn vmr_http:app
-```
-
-## Use
-
-*Set multiple Strip 0 parameters at once*
-
-```console
-curl -X 'PATCH' \
-  'http://127.0.0.1:8000/strip/0' \
-  -H 'accept: application/json' \
-  -H 'Content-Type: application/json' \
-  -d '{
-  "gain": -38.7,
-  "mute": true,
-  "mono": true,
-  "A1": true,
-  "A2": false,
-  "A5": true,
-  "B1": true,
-  "B3": true
-}'
-```
-
-*Set Strip 1 mute*
-
-```console
-curl -X 'PATCH' \
-  'http://127.0.0.1:8000/strip/1' \
-  -H 'accept: application/json' \
-  -H 'Content-Type: application/json' \
-  -d '{
-  "mute": true,
-}'
-```
-
-*Get Bus 3 gain*
-
-```console
-curl -X 'GET' \
-  'http://127.0.0.1:8000/bus/3/gain' \
-  -H 'accept: application/json'
-```
-
-*Get Bus 4 Mode*
-
-```console
-curl -X 'GET' \
-  'http://127.0.0.1:8000/bus/4/mode' \
-  -H 'accept: application/json'
 ```
 
 ## Documentation
 
-FastAPI [generates automatic docs][auto-docs], visit the link in the startup message when you launch the server.
+FastAPI generates [automatic docs][auto-docs], simply launch the server and then visit:
+
+*Swagger UI*
+- http://localhost:8000/docs
+
+*ReDoc*
+- http://localhost:8000/redoc
+
+---
+
+## License
+
+`vban-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
 
 [auto-docs]: https://fastapi.tiangolo.com/features/#automatic-docs

pyproject.toml

@@ -1,15 +1,11 @@
 [project]
 name = "vmr-http"
-version = "0.3.0"
+version = "0.5.0"
 description = "HTTP API for controlling Voicemeeter"
 readme = "README.md"
 authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
 requires-python = ">=3.10"
-dependencies = [
+dependencies = ["fastapi>=0.135.3", "uvicorn>=0.43.0", "voicemeeter-api>=2.7.2"]
-    "fastapi>=0.135.3",
-    "uvicorn>=0.43.0",
-    "voicemeeter-api>=2.7.2",
-]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Programming Language :: Python",
@@ -26,14 +22,10 @@ requires = ["uv_build>=0.11.3,<0.12.0"]
 build-backend = "uv_build"
 
 [dependency-groups]
-dev = [
+dev = ["fastapi[standard]>=0.135.3", "poethepoet>=0.43.0", "ruff>=0.15.9"]
-    "fastapi[standard]>=0.135.3",
-    "poethepoet>=0.43.0",
-    "ruff>=0.15.9",
-]
 
 [tool.fastapi]
-entrypoint = "vmr_http.app:app"
+entrypoint = "vmr_http:app"
 
 [tool.uv.sources]
 voicemeeter-api = { path = "../voicemeeter-api-python", editable = true }

src/vmr_http/__init__.py

@@ -0,0 +1,5 @@
+"""Voicemeeter HTTP API."""
+
+from .app import app
+
+__all__ = ['app']

src/vmr_http/app.py

@@ -27,8 +27,8 @@ app = FastAPI(
         {'name': 'bus', 'description': 'Endpoints for controlling bus parameters.'},
     ],
 )
-app.include_router(strip.router, prefix='/strip')
+app.include_router(strip.router, prefix='/strip/{index}')
-app.include_router(bus.router, prefix='/bus')
+app.include_router(bus.router, prefix='/bus/{index}')
 
 
 @app.get('/health')

src/vmr_http/models/bus.py

@@ -11,4 +11,3 @@ class BusParams(BaseModel):
     gain: Optional[float] = None
     mute: Optional[bool] = None
     mono: Optional[int] = None
-    eq: Optional[bool] = None

src/vmr_http/models/eq.py

@@ -0,0 +1,22 @@
+"""Models for the parameters of an equalizer."""
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class EQParams(BaseModel):
+    """Parameters for an equalizer."""
+
+    on: Optional[bool] = None
+    ab: Optional[bool] = None
+
+
+class EQChannelCellParams(BaseModel):
+    """Parameters for an equalizer channel."""
+
+    on: Optional[bool] = None
+    type: Optional[int] = None
+    f: Optional[float] = None
+    gain: Optional[float] = None
+    q: Optional[float] = None

src/vmr_http/web/bus.py

@@ -5,14 +5,15 @@ from fastapi import APIRouter, Depends
 from vmr_http.dependencies import get_voicemeeter_client
 from vmr_http.models.bus import BusParams
 
-from . import busmode
+from . import busmode, eq
 
 router = APIRouter()
-router.include_router(busmode.router, tags=['bus mode'])
+router.include_router(busmode.router, prefix='/mode', tags=['bus mode'])
+router.include_router(eq.create_router(parent_router_kind='bus'), prefix='/eq', tags=['bus eq'])
 
 
-@router.patch('/{index}', tags=['bus'])
+@router.patch('', tags=['bus'])
-@router.put('/{index}', tags=['bus'])
+@router.put('', tags=['bus'])
 async def update_bus_params(index: int, params: BusParams, voicemeeter=Depends(get_voicemeeter_client)):
     """Update one or more parameters for the specified bus index."""
     bus = voicemeeter.bus[index]
@@ -23,13 +24,20 @@ async def update_bus_params(index: int, params: BusParams, voicemeeter=Depends(g
     return updated
 
 
-@router.get('/{index}/gain', tags=['bus'])
+@router.get('/gain', tags=['bus'])
 async def get_gain(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current gain value for the specified bus index."""
     return {'gain': voicemeeter.bus[index].gain}
 
 
-@router.get('/{index}/mute', tags=['bus'])
+@router.get('/mute', tags=['bus'])
 async def get_mute(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current mute status for the specified bus index."""
     return {'mute': voicemeeter.bus[index].mute}
+
+
+@router.get('/mono', tags=['bus'])
+async def get_mono(index: int, voicemeeter=Depends(get_voicemeeter_client)):
+    """Get the current mono status for the specified bus index."""
+    opts = ['Off', 'On', 'Stereo Reverse']
+    return {'mono': opts[voicemeeter.bus[index].mono]}

src/vmr_http/web/busmode.py

@@ -1,6 +1,6 @@
 """module for bus mode related endpoints."""
 
-from fastapi import APIRouter, Depends, HTTPException
+from fastapi import APIRouter, Body, Depends, HTTPException
 
 from vmr_http.dependencies import get_voicemeeter_client
 
@@ -23,9 +23,9 @@ _readable_busmodes = {
 _reversed_busmodes = {v: k for k, v in _readable_busmodes.items()}
 
 
-@router.patch('/{index}/mode')
+@router.patch('')
-@router.put('/{index}/mode')
+@router.put('')
-async def update_bus_mode(index: int, mode: str, voicemeeter=Depends(get_voicemeeter_client)):
+async def update_bus_mode(index: int, mode: str = Body(..., embed=True), voicemeeter=Depends(get_voicemeeter_client)):
     """Update the bus mode for the specified bus index."""
     if mode not in _reversed_busmodes:
         raise HTTPException(
@@ -35,7 +35,7 @@ async def update_bus_mode(index: int, mode: str, voicemeeter=Depends(get_voiceme
     return {'mode': _readable_busmodes[_reversed_busmodes[mode]]}
 
 
-@router.get('/{index}/mode')
+@router.get('')
 async def get_bus_mode(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current bus mode for the specified bus index."""
     return {'mode': _readable_busmodes.get(voicemeeter.bus[index].mode.get(), 'Unknown')}

src/vmr_http/web/eq.py

@@ -0,0 +1,96 @@
+"""Module for equalizer related endpoints, supporting both strip and bus parents via a factory function."""
+
+from fastapi import APIRouter, Depends
+
+from vmr_http.dependencies import get_voicemeeter_client
+from vmr_http.models.eq import EQChannelCellParams, EQParams
+
+
+def create_router(parent_router_kind: str) -> APIRouter:
+    """Create an APIRouter for equalizer endpoints, with the specified parent kind ('strip' or 'bus')."""
+    if parent_router_kind not in ('strip', 'bus'):
+        raise ValueError(f'Invalid router kind: {parent_router_kind}')
+    parent_attr = parent_router_kind
+
+    def get_parent(voicemeeter, index):
+        return getattr(voicemeeter, parent_attr)[index]
+
+    cell_router = APIRouter()
+
+    @cell_router.patch('')
+    @cell_router.put('')
+    async def update_eq_channel_cell_params(
+        index: int,
+        channel_index: int,
+        cell_index: int,
+        params: EQChannelCellParams,
+        voicemeeter=Depends(get_voicemeeter_client),
+    ):
+        """Update one or more parameters for the specified eq channel cell."""
+        cell = get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index]
+        updated = {}
+        for key, value in params.model_dump(exclude_unset=True).items():
+            setattr(cell, key, value)
+            updated[key] = getattr(cell, key)
+        return updated
+
+    @cell_router.get('/on')
+    async def get_eq_channel_cell_on(
+        index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
+    ):
+        """Get the current on status for the specified eq channel cell."""
+        return {'on': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].on}
+
+    @cell_router.get('/type')
+    async def get_eq_channel_cell_type(
+        index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
+    ):
+        """Get the current type for the specified eq channel cell."""
+        return {'type': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].type}
+
+    @cell_router.get('/f')
+    async def get_eq_channel_cell_f(
+        index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
+    ):
+        """Get the current f value for the specified eq channel cell."""
+        return {'f': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].f}
+
+    @cell_router.get('/gain')
+    async def get_eq_channel_cell_gain(
+        index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
+    ):
+        """Get the current gain value for the specified eq channel cell."""
+        return {'gain': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].gain}
+
+    @cell_router.get('/q')
+    async def get_eq_channel_cell_q(
+        index: int, channel_index: int, cell_index: int, voicemeeter=Depends(get_voicemeeter_client)
+    ):
+        """Get the current q value for the specified eq channel cell."""
+        return {'q': get_parent(voicemeeter, index).eq.channel[channel_index].cell[cell_index].q}
+
+    router = APIRouter()
+    router.include_router(cell_router, prefix='/channel/{channel_index}/cell/{cell_index}')
+
+    @router.patch('')
+    @router.put('')
+    async def update_eq_params(index: int, params: EQParams, voicemeeter=Depends(get_voicemeeter_client)):
+        """Update one or more equalizer parameters for the specified index."""
+        eq = get_parent(voicemeeter, index).eq
+        updated = {}
+        for key, value in params.model_dump(exclude_unset=True).items():
+            setattr(eq, key, value)
+            updated[key] = getattr(eq, key)
+        return updated
+
+    @router.get('/on')
+    async def get_eq_on(index: int, voicemeeter=Depends(get_voicemeeter_client)):
+        """Get the current equalizer on status for the specified index."""
+        return {'on': get_parent(voicemeeter, index).eq.on}
+
+    @router.get('/ab')
+    async def get_eq_ab(index: int, voicemeeter=Depends(get_voicemeeter_client)):
+        """Get the current equalizer A/B status for the specified index."""
+        return {'ab': get_parent(voicemeeter, index).eq.ab}
+
+    return router

src/vmr_http/web/strip.py

@@ -5,16 +5,17 @@ from fastapi import APIRouter, Depends
 from vmr_http.dependencies import get_voicemeeter_client
 from vmr_http.models.strip import StripParams
 
-from . import stripcomp, stripdenoiser, stripgate
+from . import eq, stripcomp, stripdenoiser, stripgate
 
 router = APIRouter()
 router.include_router(stripcomp.router, prefix='/comp', tags=['strip comp'])
 router.include_router(stripgate.router, prefix='/gate', tags=['strip gate'])
 router.include_router(stripdenoiser.router, prefix='/denoiser', tags=['strip denoiser'])
+router.include_router(eq.create_router(parent_router_kind='strip'), prefix='/eq', tags=['strip eq'])
 
 
-@router.patch('/{index}', tags=['strip'])
+@router.patch('', tags=['strip'])
-@router.put('/{index}', tags=['strip'])
+@router.put('', tags=['strip'])
 async def update_strip_params(index: int, params: StripParams, voicemeeter=Depends(get_voicemeeter_client)):
     """Update one or more parameters for the specified strip index."""
     strip = voicemeeter.strip[index]
@@ -25,73 +26,73 @@ async def update_strip_params(index: int, params: StripParams, voicemeeter=Depen
     return updated
 
 
-@router.get('/{index}/gain', tags=['strip'])
+@router.get('/gain', tags=['strip'])
 async def get_gain(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current gain value for the specified strip index."""
     return {'gain': voicemeeter.strip[index].gain}
 
 
-@router.get('/{index}/mute', tags=['strip'])
+@router.get('/mute', tags=['strip'])
 async def get_mute(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current mute status for the specified strip index."""
     return {'mute': voicemeeter.strip[index].mute}
 
 
-@router.get('/{index}/mono', tags=['strip'])
+@router.get('/mono', tags=['strip'])
 async def get_mono(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current mono status for the specified strip index."""
     return {'mono': voicemeeter.strip[index].mono}
 
 
-@router.get('/{index}/solo', tags=['strip'])
+@router.get('/solo', tags=['strip'])
 async def get_solo(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current solo status for the specified strip index."""
     return {'solo': voicemeeter.strip[index].solo}
 
 
-@router.get('/{index}/A1', tags=['strip'])
+@router.get('/A1', tags=['strip'])
 async def get_A1(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current A1 output status for the specified strip index."""
     return {'A1': voicemeeter.strip[index].A1}
 
 
-@router.get('/{index}/A2', tags=['strip'])
+@router.get('/A2', tags=['strip'])
 async def get_A2(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current A2 output status for the specified strip index."""
     return {'A2': voicemeeter.strip[index].A2}
 
 
-@router.get('/{index}/A3', tags=['strip'])
+@router.get('/A3', tags=['strip'])
 async def get_A3(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current A3 output status for the specified strip index."""
     return {'A3': voicemeeter.strip[index].A3}
 
 
-@router.get('/{index}/A4', tags=['strip'])
+@router.get('/A4', tags=['strip'])
 async def get_A4(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current A4 output status for the specified strip index."""
     return {'A4': voicemeeter.strip[index].A4}
 
 
-@router.get('/{index}/A5', tags=['strip'])
+@router.get('/A5', tags=['strip'])
 async def get_A5(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current A5 output status for the specified strip index."""
     return {'A5': voicemeeter.strip[index].A5}
 
 
-@router.get('/{index}/B1', tags=['strip'])
+@router.get('/B1', tags=['strip'])
 async def get_B1(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current B1 output status for the specified strip index."""
     return {'B1': voicemeeter.strip[index].B1}
 
 
-@router.get('/{index}/B2', tags=['strip'])
+@router.get('/B2', tags=['strip'])
 async def get_B2(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current B2 output status for the specified strip index."""
     return {'B2': voicemeeter.strip[index].B2}
 
 
-@router.get('/{index}/B3', tags=['strip'])
+@router.get('/B3', tags=['strip'])
 async def get_B3(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current B3 output status for the specified strip index."""
     return {'B3': voicemeeter.strip[index].B3}

src/vmr_http/web/stripcomp.py

@@ -8,8 +8,8 @@ from vmr_http.models.strip import StripCompParams
 router = APIRouter()
 
 
-@router.patch('/{index}/comp')
+@router.patch('')
-@router.put('/{index}/comp')
+@router.put('')
 async def update_strip_comp_params(index: int, params: StripCompParams, voicemeeter=Depends(get_voicemeeter_client)):
     """Update one or more compressor parameters for the specified strip index."""
     strip_comp = voicemeeter.strip[index].comp
@@ -20,7 +20,7 @@ async def update_strip_comp_params(index: int, params: StripCompParams, voicemee
     return updated
 
 
-@router.get('/{index}/comp/knob')
+@router.get('/knob')
 async def get_strip_comp_knob(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current compressor knob value for the specified strip index."""
     strip_comp = voicemeeter.strip[index].comp

src/vmr_http/web/stripdenoiser.py

@@ -8,8 +8,8 @@ from vmr_http.models.strip import StripDenoiserParams
 router = APIRouter()
 
 
-@router.patch('/{index}/denoiser')
+@router.patch('')
-@router.put('/{index}/denoiser')
+@router.put('')
 async def update_strip_denoiser_params(
     index: int, params: StripDenoiserParams, voicemeeter=Depends(get_voicemeeter_client)
 ):
@@ -22,7 +22,7 @@ async def update_strip_denoiser_params(
     return updated
 
 
-@router.get('/{index}/denoiser/knob')
+@router.get('/knob')
 async def get_strip_denoiser_knob(
     index: int,
     voicemeeter=Depends(get_voicemeeter_client),

src/vmr_http/web/stripgate.py

@@ -8,8 +8,8 @@ from vmr_http.models.strip import StripGateParams
 router = APIRouter()
 
 
-@router.patch('/{index}/gate')
+@router.patch('')
-@router.put('/{index}/gate')
+@router.put('')
 async def update_strip_gate_params(index: int, params: StripGateParams, voicemeeter=Depends(get_voicemeeter_client)):
     """Update one or more gate parameters for the specified strip index."""
     strip_gate = voicemeeter.strip[index].gate
@@ -20,7 +20,7 @@ async def update_strip_gate_params(index: int, params: StripGateParams, voicemee
     return updated
 
 
-@router.get('/{index}/gate/knob')
+@router.get('/knob')
 async def get_strip_gate_knob(index: int, voicemeeter=Depends(get_voicemeeter_client)):
     """Get the current gate knob value for the specified strip index."""
     strip_gate = voicemeeter.strip[index].gate

uv.lock

@@ -1151,7 +1151,7 @@ wheels = [
 
 [[package]]
 name = "vmr-http"
-version = "0.3.0"
+version = "0.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi" },