{"id":29741827,"url":"https://github.com/onyx-and-iris/voicemeeter-api-python","last_synced_at":"2025-07-26T01:35:08.419Z","repository":{"id":48130155,"uuid":"504153539","full_name":"onyx-and-iris/voicemeeter-api-python","owner":"onyx-and-iris","description":"A Python wrapper around the Voiceemeter Remote API","archived":false,"fork":false,"pushed_at":"2025-06-15T22:50:29.000Z","size":414,"stargazers_count":28,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"dev","last_synced_at":"2025-06-15T23:04:37.936Z","etag":null,"topics":["voicemeeter","voicemeeter-api","voicemeeter-py","voicemeeter-python","voicemeeter-remote"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/onyx-and-iris.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-16T12:49:32.000Z","updated_at":"2025-06-15T22:50:32.000Z","dependencies_parsed_at":"2023-01-21T04:48:29.192Z","dependency_job_id":"91ac4f26-8b40-4241-b6c7-abf4070c29db","html_url":"https://github.com/onyx-and-iris/voicemeeter-api-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/onyx-and-iris/voicemeeter-api-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyx-and-iris%2Fvoicemeeter-api-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyx-and-iris%2Fvoicemeeter-api-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyx-and-iris%2Fvoicemeeter-api-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyx-and-iris%2Fvoicemeeter-api-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/onyx-and-iris","download_url":"https://codeload.github.com/onyx-and-iris/voicemeeter-api-python/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/onyx-and-iris%2Fvoicemeeter-api-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265950636,"owners_count":23853788,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["voicemeeter","voicemeeter-api","voicemeeter-py","voicemeeter-python","voicemeeter-remote"],"created_at":"2025-07-26T01:35:07.661Z","updated_at":"2025-07-26T01:35:08.410Z","avatar_url":"https://github.com/onyx-and-iris.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/voicemeeter-api.svg)](https://badge.fury.io/py/voicemeeter-api)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-python/blob/dev/LICENSE)\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![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)\n![Tests Status](./tests/reports/badge-basic.svg?dummy=8484744)\n![Tests Status](./tests/reports/badge-banana.svg?dummy=8484744)\n![Tests Status](./tests/reports/badge-potato.svg?dummy=8484744)\n\n# Python Wrapper for Voicemeeter API\n\nThis package offers a Python interface for the Voicemeeter Remote C API.\n\nFor an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)\n\n## Tested against\n\n-   Basic 1.1.1.1\n-   Banana 2.1.1.1\n-   Potato 3.1.1.1\n\n## Requirements\n\n-   [Voicemeeter](https://voicemeeter.com/)\n-   Python 3.10 or greater\n\n## Installation\n\n`pip install voicemeeter-api`\n\n## `Use`\n\nSimplest use case, use a context manager to request a Remote class of a kind.\n\nLogin and logout are handled for you in this scenario.\n\n#### `__main__.py`\n\n```python\nimport voicemeeterlib\n\n\nclass ManyThings:\n    def __init__(self, vm):\n        self.vm = vm\n\n    def things(self):\n        self.vm.strip[0].label = 'podmic'\n        self.vm.strip[0].mute = True\n        print(\n            f'strip 0 ({self.vm.strip[0].label}) mute has been set to {self.vm.strip[0].mute}'\n        )\n\n    def other_things(self):\n        self.vm.bus[3].gain = -6.3\n        self.vm.bus[4].eq.on = True\n        info = (\n            f'bus 3 gain has been set to {self.vm.bus[3].gain}',\n            f'bus 4 eq has been set to {self.vm.bus[4].eq.on}',\n        )\n        print('\\n'.join(info))\n\n\ndef main():\n    KIND_ID = 'banana'\n\n    with voicemeeterlib.api(KIND_ID) as vm:\n        do = ManyThings(vm)\n        do.things()\n        do.other_things()\n\n        # set many parameters at once\n        vm.apply(\n            {\n                'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},\n                'bus-2': {'mute': True, 'eq': {'on': True}},\n                'button-0': {'state': True},\n                'vban-in-0': {'on': True},\n                'vban-out-1': {'name': 'streamname'},\n            }\n        )\n\n\nif __name__ == '__main__':\n    main()\n```\n\nOtherwise you must remember to call `vm.login()`, `vm.logout()` at the start/end of your code.\n\n## `KIND_ID`\n\nPass the kind of Voicemeeter as an argument. KIND_ID may be:\n\n-   `basic`\n-   `banana`\n-   `potato`\n\n## `Available commands`\n\n### Strip\n\nThe following properties are available.\n\n-   `mono`: boolean\n-   `solo`: boolean\n-   `mute`: boolean\n-   `gain`: float, from -60.0 to 12.0\n-   `audibility`: float, from 0.0 to 10.0\n-   `limit`: int, from -40 to 12\n-   `A1 - A5`, `B1 - B3`: boolean\n-   `label`: string\n-   `mc`: boolean\n-   `k`: int, from 0 to 4\n-   `bass`: float, from -12.0 to 12.0\n-   `mid`: float, from -12.0 to 12.0\n-   `treble`: float, from -12.0 to 12.0\n-   `reverb`: float, from 0.0 to 10.0\n-   `delay`: float, from 0.0 to 10.0\n-   `fx1`: float, from 0.0 to 10.0\n-   `fx2`: float, from 0.0 to 10.0\n-   `pan_x`: float, from -0.5 to 0.5\n-   `pan_y`: float, from 0.0 to 1.0\n-   `color_x`: float, from -0.5 to 0.5\n-   `color_y`: float, from 0.0 to 1.0\n-   `fx_x`: float, from -0.5 to 0.5\n-   `fx_y`: float, from 0.0 to 1.0\n-   `postreverb`: boolean\n-   `postdelay`: boolean\n-   `postfx1`: boolean\n-   `postfx2`: boolean\n\nexample:\n\n```python\nvm.strip[3].gain = 3.7\nprint(vm.strip[0].label)\n```\n\nThe following methods are available.\n\n-   `appgain(name, value)`: string, float, from 0.0 to 1.0\n\nSet the gain in db by value for the app matching name.\n\n-   `appmute(name, value)`: string, bool\n\nSet mute state as value for the app matching name.\n\nexample:\n\n```python\nvm.strip[5].appmute('Spotify', True)\nvm.strip[5].appgain('Spotify', 0.5)\n```\n\n#### Strip.Comp\n\nThe following properties are available.\n\n-   `knob`: float, from 0.0 to 10.0\n-   `gainin`: float, from -24.0 to 24.0\n-   `ratio`: float, from 1.0 to 8.0\n-   `threshold`: float, from -40.0 to -3.0\n-   `attack`: float, from 0.0 to 200.0\n-   `release`: float, from 0.0 to 5000.0\n-   `knee`: float, from 0.0 to 1.0\n-   `gainout`: float, from -24.0 to 24.0\n-   `makeup`: boolean\n\nexample:\n\n```python\nprint(vm.strip[4].comp.knob)\n```\n\nStrip Comp parameters are defined for PhysicalStrips.\n\n`knob` defined for all versions, all other parameters potato only.\n\n#### Strip.Gate\n\nThe following properties are available.\n\n-   `knob`: float, from 0.0 to 10.0\n-   `threshold`: float, from -60.0 to -10.0\n-   `damping`: float, from -60.0 to -10.0\n-   `bpsidechain`: int, from 100 to 4000\n-   `attack`: float, from 0.0 to 1000.0\n-   `hold`: float, from 0.0 to 5000.0\n-   `release`: float, from 0.0 to 5000.0\n\nexample:\n\n```python\nvm.strip[2].gate.attack = 300.8\n```\n\nStrip Gate parameters are defined for PhysicalStrips.\n\n`knob` defined for all versions, all other parameters potato only.\n\n#### Strip.Denoiser\n\nThe following properties are available.\n\n-   `knob`: float, from 0.0 to 10.0\n\nexample:\n\n```python\nvm.strip[0].denoiser.knob = 0.5\n```\n\nStrip Denoiser parameters are defined for PhysicalStrips, potato version only.\n\n#### Strip.EQ\n\nThe following properties are available.\n\n-   `on`: boolean\n-   `ab`: boolean\n\nexample:\n\n```python\nvm.strip[0].eq.ab = True\n```\n\n##### Strip.EQ.Channel.Cell\n\nThe following properties are available.\n\n-   `on`: boolean\n-   `type`: int, from 0 up to 6\n-   `f`: float, from 20.0 up to 20_000.0\n-   `gain`: float, from -36.0 up to 18.0\n    -   currently there is a bug with the remote API, only values -12 up to +12 are settable, this will be fixed in an upcoming patch.\n-   `q`: float, from 0.3 up to 100\n\nexample:\n\n```python\nvm.strip[0].eq.channel[0].cell[2].on = True\nvm.strip[1].eq.channel[0].cell[2].f = 5000\n```\n\nStrip EQ parameters are defined for PhysicalStrips, potato version only.\n\n##### Strip.Gainlayers\n\n-   `gain`: float, from -60.0 to 12.0\n\nexample:\n\n```python\nvm.strip[3].gainlayer[3].gain = 3.7\n```\n\nGainlayers are defined for potato version only.\n\n##### Strip.Levels\n\nThe following properties are available.\n\n-   `prefader`\n-   `postfader`\n-   `postmute`\n\nexample:\n\n```python\nprint(vm.strip[3].levels.prefader)\n```\n\nLevel properties will return -200.0 if no audio detected.\n\n### Bus\n\nThe following properties are available.\n\n-   `mono`: boolean\n-   `mute`: boolean\n-   `sel`: boolean\n-   `gain`: float, from -60.0 to 12.0\n-   `label`: string\n-   `returnreverb`: float, from 0.0 to 10.0\n-   `returndelay`: float, from 0.0 to 10.0\n-   `returnfx1`: float, from 0.0 to 10.0\n-   `returnfx2`: float, from 0.0 to 10.0\n-   `monitor`: boolean\n\nexample:\n\n```python\nvm.bus[3].gain = 3.7\nprint(vm.bus[0].label)\n\nvm.bus[4].mono = True\n```\n\n##### Bus.EQ\n\nThe following properties are available.\n\n-   `on`: boolean\n-   `ab`: boolean\n\nexample:\n\n```python\nvm.bus[3].eq.on = True\n```\n\n##### Bus.EQ.Channel.Cell\n\nThe following properties are available.\n\n-   `on`: boolean\n-   `type`: int, from 0 up to 6\n-   `f`: float, from 20.0 up to 20_000.0\n-   `gain`: float, from -36.0 up to 18.0\n    -   currently there is a bug with the remote API, only values -12 up to +12 are settable, this will be fixed in an upcoming patch.\n-   `q`: float, from 0.3 up to 100.0\n\nexample:\n\n```python\nvm.bus[3].eq.channel[0].cell[2].on = True\nvm.bus[3].eq.channel[0].cell[2].f = 5000\n```\n\n##### Bus.Modes\n\nThe following properties are available.\n\n-   `normal`: boolean\n-   `amix`: boolean\n-   `bmix`: boolean\n-   `composite`: boolean\n-   `tvmix`: boolean\n-   `upmix21`: boolean\n-   `upmix41`: boolean\n-   `upmix61`: boolean\n-   `centeronly`: boolean\n-   `lfeonly`: boolean\n-   `rearonly`: boolean\n\nThe following methods are available.\n\n-   `get()`: Returns the current bus mode\n\nexample:\n\n```python\nvm.bus[4].mode.amix = True\n\nprint(vm.bus[2].mode.get())\n```\n\n##### Bus.Levels\n\nThe following properties are available.\n\n-   `all`\n\nexample:\n\n```python\nprint(vm.bus[0].levels.all)\n```\n\n`levels.all` will return -200.0 if no audio detected.\n\n### Strip | Bus\n\nThe following methods are available.\n\n-   `fadeto(amount, time)`: float, int\n-   `fadeby(amount, time)`: float, int\n\nModify gain to or by the selected amount in db over a time interval in ms.\n\nexample:\n\n```python\nvm.strip[0].fadeto(-10.3, 1000)\nvm.bus[3].fadeby(-5.6, 500)\n```\n\n#### Strip.Device | Bus.Device\n\nThe following properties are available\n\n-   `name`: str\n-   `sr`: int\n-   `wdm`: str\n-   `ks`: str\n-   `mme`: str\n-   `asio`: str\n\nexample:\n\n```python\nprint(vm.strip[0].device.name)\nvm.bus[0].device.asio = 'Audient USB Audio ASIO Driver'\n```\n\nstrip|bus device parameters are defined for physical channels only.\n\nname, sr are read only. wdm, ks, mme, asio are write only.\n\n### Macrobuttons\n\nThe following properties are available.\n\n-   `state`: boolean\n-   `stateonly`: boolean\n-   `trigger`: boolean\n\nexample:\n\n```python\nvm.button[37].state = True\nvm.button[55].trigger = False\n```\n\n### Recorder\n\nThe following methods are available\n\n-   `play()`\n-   `stop()`\n-   `pause()`\n-   `record()`\n-   `ff()`\n-   `rew()`\n-   `load(filepath)`: raw string\n-   `goto(time_string)`: time string in format `hh:mm:ss`\n-   `filetype(filetype)`: string, (\"wav\", \"aiff\", \"bwf\", \"mp3\")\n\nThe following properties are available\n\n-   `A1 - A5`: boolean\n-   `B1 - B3`: boolean\n-   `samplerate`: int, (22050, 24000, 32000, 44100, 48000, 88200, 96000, 176400, 192000)\n-   `bitresolution`: int, (8, 16, 24, 32)\n-   `channel`: int, from 1 to 8\n-   `kbps`: int, (32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320)\n-   `gain`: float, from -60.0 to 12.0\n\nexample:\n\n```python\nvm.recorder.play()\nvm.recorder.stop()\n\n# Disable recorder out channel B2\nvm.recorder.B2 = False\n\n# filepath as raw string\nvm.recorder.load(r'C:\\music\\mytune.mp3')\n\n# set the goto time to 1m 30s\nvm.recorder.goto('00:01:30')\n```\n\n#### Recorder.Mode\n\nThe following properties are available\n\n-   `recbus`: boolean\n-   `playonload`: boolean\n-   `loop`: boolean\n-   `multitrack`: boolean\n\nexample:\n\n```python\n# Enable loop play\nvm.recorder.mode.loop = True\n```\n\n#### Recorder.ArmStrip[i]|ArmBus[i]\n\nThe following method is available\n\n-   `set(val)`: boolean\n\nexample:\n\n```python\n# Arm strip 3\nvm.recorder.armstrip[3].set(True)\n# Arm bus 0\nvm.recorder.armbus[0].set(True)\n```\n\n### VBAN\n\n-   `vm.vban.enable()` `vm.vban.disable()` Turn VBAN on or off\n\n##### Instream | Outstream\n\nThe following properties are available.\n\n-   `on`: boolean\n-   `name`: string\n-   `ip`: string\n-   `port`: int, range from 1024 to 65535\n-   `sr`: int, (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)\n-   `channel`: int, from 1 to 8\n-   `bit`: int, 16 or 24\n-   `quality`: int, from 0 to 4\n-   `route`: int, from 0 to 8\n\n`SR`, `channel` and `bit` are defined as:\n\n-   readonly for instreams.\n-   read and write for outstreams.\n\nexample:\n\n```python\n# turn VBAN on\nvm.vban.enable()\n\n# turn on vban instream 0\nvm.vban.instream[0].on = True\n\n# set bit property for outstream 3 to 24\nvm.vban.outstream[3].bit = 24\n```\n\n### Command\n\nCertain 'special' commands are defined by the API as performing actions rather than setting values.\n\nThe following methods are available:\n\n-   `show()` : Bring Voiceemeter GUI to the front\n-   `shutdown()` : Shuts down the GUI\n-   `restart()` : Restart the audio engine\n-   `reset()`: Applies the `reset` config. (phys strip B1, virt strip A1, gains, comp, gate 0.0, mute, mono, solo, eq false)\n\nThe following properties are available.\n\n-   `showvbanchat`: boolean\n-   `lock`: boolean\n\nexample:\n\n```python\nvm.command.restart()\nvm.command.showvbanchat = True\n```\n\n`showvbanchat` and `lock` are write only.\n\n### Device\n\n-   `ins` `outs` : Returns the number of input/output devices\n-   `input(i)` `output(i)` : Returns a dict of device properties for device[i]\n\nexample:\n\n```python\nimport voicemeeterlib\nwith voicemeeterlib.api(KIND_ID) as vm:\n    for i in range(vm.device.ins):\n        print(vm.device.input(i))\n```\n\n### FX\n\nThe following properties are available:\n\n-   `reverb`: boolean\n-   `reverb_ab`: boolean\n-   `delay`: boolean\n-   `delay_ab`: boolean\n\nexample:\n\n```python\nvm.fx.reverb_ab = True\n```\n\n### Patch\n\nThe following properties are available:\n\n-   `postfadercomposite`: boolean\n-   `postfxinsert`: boolean\n\nexample:\n\n```python\nvm.patch.postfxinsert = False\n```\n\n##### asio[i]\n\n-   `get()`: int\n-   `set(patch_in)`: int, valid range determined by connected device.\n\nexample:\n\n```python\nvm.patch.asio[3].set(4)\n```\n\ni, from 0 to 10\n\n##### A2[i] - A5[i]\n\n-   `get()`: int\n-   `set(patch_out)`: int, valid range determined by connected device.\n\nexample:\n\n```python\nvm.patch.A3[5].set(3)\n```\n\ni, from 0 to 8.\n\n##### composite[i]\n\n-   `get()`: int\n-   `set(channel)`: int, from 0 up to number of channels depending on version.\n\nexample:\n\n```python\nvm.patch.composite[7].set(4)\n```\n\ni, from 0 to 8.\n\n##### insert[i]\n\n-   `on`: boolean\n\nexample:\n\n```python\nvm.patch.insert[18].on = True\n```\n\ni, from 0 up to number of channels depending on version.\n\n### Option\n\nThe following properties are available:\n\n-   `sr`: int\n-   `asiosr`: boolean\n-   `monitoronsel`: boolean\n\nexample:\n\n```python\nvm.option.sr = 48000\n```\n\nThe following methods are available:\n\n-   `buffer(driver, buf)` : Set buffer size for particular audio driver.\n    -   buf: int, from 128 to 2048\n    -   driver:str, (\"mme\", \"wdm\", \"ks\", \"asio\")\n\nexample:\n\n```python\nvm.option.buffer(\"wdm\", 512)\n```\n\n##### delay[i]\n\n-   `get()`: int\n-   `set(delay)`: int, from 0 to 500\n\nexample:\n\n```python\nvm.option.delay[4].set(30)\n```\n\ni, from 0 up to 4.\n\n### Midi\n\nThe following properties are available:\n\n-   `channel`: int, returns the midi channel\n-   `current`: int, returns the current (or most recently pressed) key\n\nThe following methods are available:\n\n-   `get(key)`: int, returns most recent velocity value for a key\n\nexample:\n\n```python\nprint(vm.midi.get(12))\n```\n\nget() may return None if no value for requested key in midi cache\n\n### Multiple parameters\n\n-   `apply`\n    Set many strip/bus/macrobutton/vban parameters at once, for example:\n\n```python\nvm.apply(\n    {\n        'strip-2': {'A1': True, 'B1': True, 'gain': -6.0},\n        'bus-2': {'mute': True, 'eq': {'on': True}},\n        'button-0': {'state': True},\n        'vban-in-0': {'on': True},\n        'vban-out-1': {'name': 'streamname'},\n    }\n)\n```\n\nOr for each class you may do:\n\n```python\nvm.strip[0].apply({'mute': True, 'gain': 3.2, 'A1': True})\nvm.vban.outstream[0].apply({'on': True, 'name': 'streamname', 'bit': 24})\n```\n\n## Config Files\n\n`vm.apply_config(configname)`\n\nYou may load config files in TOML format.\nThree example configs have been included with the package. Remember to save\ncurrent settings before loading a user config. To load one you may do:\n\n```python\nimport voicemeeterlib\nwith voicemeeterlib.api('banana') as vm:\n    vm.apply_config('example')\n```\n\nYour configs may be located in one of the following paths:\n-   \\\u003ccurrent working directory\\\u003e / \"configs\" / kind_id\n-   \\\u003cuser home directory\\\u003e / \".config\" / \"voicemeeter\" / kind_id\n-   \\\u003cuser home directory\\\u003e / \"Documents\" / \"Voicemeeter\" / \"configs\" / kind_id\n\nIf a config with the same name is located in multiple locations, only the first one found is loaded into memory, in the above order.\n\n#### `config extends`\n\nYou may also load a config that extends another config with overrides or additional parameters.\n\nYou just need to define a key `extends` in the config TOML, that names the config to be extended.\n\nThree example 'extender' configs are included with the repo. You may load them with:\n\n```python\nimport voicemeeterlib\nwith voicemeeterlib.api('banana') as vm:\n    vm.apply_config('extender')\n```\n\n## Events\n\nBy default, NO events are listened for. Use events kwargs to enable specific event types.\n\nexample:\n\n```python\nimport voicemeeterlib\n# Set event updates to occur every 50ms\n# Listen for level updates only\nwith voicemeeterlib.api('banana', ratelimit=0.05, ldirty=True) as vm:\n    ...\n```\n\n#### `vm.observer`\n\nUse the Subject class to register an app as event observer.\n\nThe following methods are available:\n\n-   `add`: registers an app as an event observer\n-   `remove`: deregisters an app as an event observer\n\nexample:\n\n```python\n# register an app to receive updates\nclass App():\n    def __init__(self, vm):\n        vm.observer.add(self)\n        ...\n```\n\n#### `vm.event`\n\nUse the event class to toggle updates as necessary.\n\nThe following properties are available:\n\n-   `pdirty`: boolean\n-   `mdirty`: boolean\n-   `midi`: boolean\n-   `ldirty`: boolean\n\nexample:\n\n```python\nvm.event.ldirty = True\n\nvm.event.pdirty = False\n```\n\nOr add, remove a list of events.\n\nThe following methods are available:\n\n-   `add()`\n-   `remove()`\n-   `get()`\n\nexample:\n\n```python\nvm.event.remove(['pdirty', 'mdirty', 'midi'])\n\n# get a list of currently subscribed\nprint(vm.event.get())\n```\n\n## Remote class\n\n`voicemeeterlib.api(KIND_ID: str)`\n\nYou may pass the following optional keyword arguments:\n\n-   `sync`: boolean=False, force the getters to wait for dirty parameters to clear. For most cases leave this as False.\n-   `ratelimit`: float=0.033, how often to check for updates in ms.\n-   `pdirty`: boolean=False, parameter updates\n-   `mdirty`: boolean=False, macrobutton updates\n-   `midi`: boolean=False, midi updates\n-   `ldirty`: boolean=False, level updates\n-   `timeout`: float=2.0, maximum time to wait for a successful login in seconds\n-   `bits`: int=64, (may be one of 32 or 64), overrides the type of Voicemeeter GUI {Remote}.run_voicemeeter() will launch\n\nAccess to lower level Getters and Setters are provided with these functions:\n\n-   `vm.get(param, is_string=False)`: For getting the value of any parameter. Set string to True if getting a property value expected to return a string.\n-   `vm.set(param, value)`: For setting the value of any parameter.\n\nexample:\n\n```python\nvm.get('Strip[2].Mute')\nvm.set('Strip[4].Label', 'stripname')\nvm.set('Strip[0].Gain', -3.6)\n```\n\nAccess to lower level polling functions are provided with the following property objects:\n\n##### `vm.pdirty`\n\nTrue iff a parameter has been updated.\n\n##### `vm.mdirty`\n\nTrue iff a macrobutton has been updated.\n\n##### `vm.ldirty`\n\nTrue iff a level has been updated.\n\n\n### Errors\n\n-   `errors.VMError`: Base custom exception class.\n-   `errors.InstallError`: Exception raised when installation errors occur.\n-   `errors.CAPIError`: Exception raised when the C-API returns error values.\n    -   The following attributes are available:\n        -   `fn_name`: C-API function name.\n        -   `code`: error code\n    -   For a full list of error codes check the [VoicemeeterRemote header file][Voicemeeter Remote Header].\n\n\n### Logging\n\nIt's possible to see the messages sent by the interface's setters and getters, may be useful for debugging.\n\nexample:\n```python\nimport voicemeeterlib\n\nlogging.basicConfig(level=logging.DEBUG)\n\nwith voicemeeterlib.api('banana') as vm:\n    ...\n```\n\n\n### Run tests\n\nInstall [poetry](https://python-poetry.org/docs/#installation) and then:\n\n```powershell\npoetry poe test-basic\npoetry poe test-banana\npoetry poe test-potato\n```\n\n### Official Documentation\n\n-   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)\n\n\n[Voicemeeter Remote Header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonyx-and-iris%2Fvoicemeeter-api-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fonyx-and-iris%2Fvoicemeeter-api-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fonyx-and-iris%2Fvoicemeeter-api-python/lists"}