add link to buseqchannelcell

Extends BusEQclass with BusEQChCell, giving access to all bus eq channel cell parameters.

CHANGELOG.md

@@ -11,11 +11,18 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+## [2.7.0] - 2025-06-15
+
+### Added
+
+-   Bus.EQ Channel Cell commands added, see [Bus.EQ.Channel.Cell](https://github.com/onyx-and-iris/voicemeeter-api-python?tab=readme-ov-file#buseqchannelcell).
+    - Added by [PR #16](https://github.com/onyx-and-iris/voicemeeter-api-python/pull/16)
+
 ## [2.6.0] - 2024-06-29
 
 ### Added
 
--   bits kwarg for overriding the type of GUI that is launched on startup. 
+-   bits kwarg for overriding the type of GUI that is launched on startup.
     -   Defaults to 64, set it to either 32 or 64.
 
 ### Fixed

README.md

@@ -292,6 +292,23 @@ example:
 vm.bus[3].eq.on = True
 ```
 
+##### Bus.EQ.Channel.Cell
+
+The following properties are available.
+
+-   `on`: boolean
+-   `type`: int
+-   `f`: float
+-   `gain`: float
+-   `q`: quality
+
+example:
+
+```python
+vm.bus[3].eq.channel[0].cell[2].on = True
+vm.bus[3].eq.channel[0].cell[2].f = 5000
+```
+
 ##### Bus.Modes
 
 The following properties are available.

examples/eq_edit/__main__.py

@@ -2,20 +2,49 @@ import time
 
 import voicemeeterlib
 
+
 def main():
     KIND_ID = 'banana'
+    BUS_INDEX = 0  # Index of the bus to edit, can be changed as needed
+    CHANNEL_INDEX = 0  # Index of the channel to edit, can be changed as needed
 
     with voicemeeterlib.api(KIND_ID) as vm:
-        vm.bus[0].eq.on = True
+        print(f'Bus[{BUS_INDEX}].EQ.on: {vm.bus[BUS_INDEX].eq.on}')
-        vm.bus[0].eq.channel[0].cell[0].on = True
+        print(
-        vm.bus[0].eq.channel[0].cell[0].f = 500
+            f'Bus[{BUS_INDEX}].EQ.channel[{CHANNEL_INDEX}].cell[0].on: {vm.bus[BUS_INDEX].eq.channel[CHANNEL_INDEX].cell[0].on}'
-        vm.bus[0].eq.channel[0].cell[0].type = 3 # Should correspond to LPF
+        )
+
+        print('Check sending commands (should affect your VM Banana window)')
+
+        vm.bus[BUS_INDEX].eq.on = True
+        vm.bus[BUS_INDEX].eq.ab = 0  # corresponds to A EQ memory slot
+        vm.bus[BUS_INDEX].mute = False
+
+        for j, cell in enumerate(vm.bus[BUS_INDEX].eq.channel[CHANNEL_INDEX].cell):
+            cell.on = True
+            cell.f = 500
+            cell.gain = -10
+            cell.type = 3  # Should correspond to LPF
+            cell.q = 10
+
+            print(
+                f'Channel {CHANNEL_INDEX}, Cell {j}: on={cell.on}, f={cell.f}, type={cell.type}, gain={cell.gain}, q={cell.q}'
+            )
+
+            time.sleep(1)  # Sleep to simulate processing time
+
+            cell.on = False
+            cell.f = 50
+            cell.gain = 0
+            cell.type = 0
+            cell.q = 3
+
+            print(
+                f'Channel {CHANNEL_INDEX}, Cell {j}: on={cell.on}, f={cell.f}, type={cell.type} , gain={cell.gain}, q={cell.q}'
+            )
+
+        vm.bus[BUS_INDEX].eq.on = False
 
-        time.sleep(3)
-        vm.bus[0].eq.on = False
-        vm.bus[0].eq.channel[0].cell[0].on = False
-        vm.bus[0].eq.channel[0].cell[0].f = 50
-        vm.bus[0].eq.channel[0].cell[0].type = 0
 
 if __name__ == '__main__':
-    main()
+    main()

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "voicemeeter-api"
-version = "2.6.1"
+version = "2.7.0"
 description = "A Python wrapper for the Voiceemeter API"
 authors = [
     {name = "Onyx and Iris",email = "code@onyxandiris.online"}
@@ -16,7 +16,7 @@ dependencies = [
 packages = [{ include = "voicemeeterlib" }]
 
 [tool.poetry.requires-plugins]
-poethepoet = "^0.32.1"
+poethepoet = "^0.35.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.4"
@@ -37,6 +37,7 @@ levels.script = "scripts:ex_levels"
 midi.script = "scripts:ex_midi"
 obs.script = "scripts:ex_obs"
 observer.script = "scripts:ex_observer"
+eqedit.script = "scripts:ex_eqedit"
 test-basic.script = "scripts:test_basic"
 test-banana.script = "scripts:test_banana"
 test-potato.script = "scripts:test_potato"

scripts.py

@@ -37,6 +37,11 @@ def ex_observer():
     subprocess.run([sys.executable, str(scriptpath)])
 
 
+def ex_eqedit():
+    scriptpath = Path.cwd() / 'examples' / 'eq_edit' / '.'
+    subprocess.run([sys.executable, str(scriptpath)])
+
+
 def test_basic():
     subprocess.run(['tox'], env=os.environ.copy() | {'KIND': 'basic'})
 

voicemeeterlib/bus.py

@@ -96,7 +96,7 @@ class BusEQ(IRemote):
         Returns a BusEQ class.
         """
         kls = (cls,)
-        return type(
+        BusEQ_cls = type(
             'BusEQ',
             kls,
             {
@@ -105,6 +105,7 @@ class BusEQ(IRemote):
                 )
             },
         )
+        return BusEQ_cls(remote, i)
 
     @property
     def identifier(self) -> str:
@@ -136,7 +137,7 @@ class BusEQCh(IRemote):
         Returns a BusEQCh class.
         """
         kls = (cls,)
-        return type(
+        BusEQCh_cls = type(
             'BusEQCh',
             kls,
             {
@@ -145,6 +146,7 @@ class BusEQCh(IRemote):
                 )
             },
         )
+        return BusEQCh_cls(remote, i, j)
 
     def __init__(self, remote, i, j):
         super().__init__(remote, i)

voicemeeterlib/kinds.py

@@ -90,7 +90,7 @@ class BananaMap(KindMapClass):
     asio: tuple = (6, 8)
     insert: int = 22
     composite: int = 8
-    channels: int = 9
+    channels: int = 8
     cells: int = 6
 
 
@@ -102,7 +102,7 @@ class PotatoMap(KindMapClass):
     asio: tuple = (10, 8)
     insert: int = 34
     composite: int = 8
-    channels: int = 9
+    channels: int = 8
     cells: int = 6