Voicemeeter Compact
A compact Voicemeeter remote app, works locally and over LAN.
For an outline of past/future changes refer to: CHANGELOG
Prerequisites
- Voicemeeter (Basic v1.0.8.4), (Banana v2.0.6.4) or (Potato v3.0.2.4)
- Python 3.10 or greater
Installation
For a step-by-step guide click here
pip install voicemeeter-compact
Usage
Example __main__.py file:
import voicemeeterlib
import vmcompact
def main():
# choose the kind of Voicemeeter (Local connection)
KIND_ID = 'banana'
# pass the KIND_ID and the vm object to the app
with voicemeeterlib.api(KIND_ID) as vm:
app = vmcompact.connect(KIND_ID, vm)
app.mainloop()
if __name__ == '__main__':
main()
It's important to know that only labelled strips and buses will appear in the Channel frames. Removing a Channels label will cause the GUI to grow/shrink in real time.
If the GUI looks like the above when you first load it, then no channels are labelled. From the menu, Configs->Load config you may load an example config. Save your current Voicemeeter settings first :).
KIND_ID
Set the kind of Voicemeeter, KIND_ID may be:
basicbananapotato
TOML Files
If you've downloaded the binary from Releases you can find configs included in the _internal/configs directory.
You may override these configs by placing a directory vm-compact in one of the following locations:
user home directory / .configuser home directory / Documents / Voicemeeter
The contents should match the following directory structure:
.
├── vm-compact
├── app.toml
├── vban.toml
├── basic
├── example.toml
├── other_config.toml
├── streaming_config.toml
├── banana
├── example.toml
├── other.toml
├── ...
├── potato
├── example.toml
├── ...
Configs
app.toml
Configure certain startup states for the app.
-
configsConfigure a user config to load on app startup. Don't include the .toml extension in the config name. -
themeBy default the app loads up the Sun Valley light or dark theme by @rdbende. You have the option to load up the app without any theme loaded. Simply setenabledto false andmodewill take no effect. -
extendsExtending the app will show both strips and buses. In reduced mode only one or the other. This app will extend both horizontally and vertically, simply setextends_horizontaltrue or false accordingly. -
channelFor each channel labelframe the width and height may be adjusted which effects the spacing between widgets and the length of the scales and progressbars respectively. -
mwscroll_stepSets the amount (in db) the gain slider moves with a single mousewheel step. Default 3. -
submixesSelect the default submix bus when Submix frame is shown. For example, a dedicated bus for OBS.
vban.toml
Configure as many vban connections as you wish. This allows the app to work over a LAN connection as well as with a local Voicemeeter installation.
For vban connections to work correctly VBAN TEXT incoming stream MUST be configured correctly on the remote machine. Both pcs ought to be connected to a local private network and should be able to ping one another.
A valid vban.toml might look like this:
[connection-1]
kind = 'banana'
host = '192.168.1.2'
streamname = 'worklaptop'
port = 6980
[connection-2]
kind = 'potato'
host = '192.168.1.3'
streamname = 'streampc'
port = 6990
basic/ banana/ potato/
Three example user configs are included with the package, one for each kind of Voicemeeter. Use these to configure parameter startup states. Any parameter supported by the underlying interfaces may be used. Check the 'multiple-parameters' section for more info:
Python Interface for the Voicemeeter API
User configs may be loaded at any time via the menu.
Special Thanks
Vincent Burel for creating Voicemeeter and its SDK.
Rdbende for creating the beautiful Sun Valley theme.
1 maintainer
Metadata
1 maintainer
Release files for voicemeeter-compact 1.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| voicemeeter_compact-1.10.0.tar.gz | 44.1 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| voicemeeter_compact-1.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 92.5 kB
Release files / voicemeeter_compact-1.10.0.tar.gz
| Download URL | voicemeeter_compact-1.10.0.tar.gz |
|---|---|
| Size | 44.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a73a15ba776565cfdb8e0062d4d5d3b9cf8b7a346d6bb7a7d3622a551b385b2b
|
|
BLAKE2b-256 checksum How to use checksums |
aea184f072bdf30244caa75a96a0757e4ff7a21a286945b155141097b0fc5bc7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.
Transparency logRelease files / voicemeeter_compact-1.10.0-py3-none-any.whl
| Download URL | voicemeeter_compact-1.10.0-py3-none-any.whl |
|---|---|
| Size | 48.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0f4c78fad27c02dc752685feec7715955397e0f4e606eee3265faf46e71809ff
|
|
BLAKE2b-256 checksum How to use checksums |
d0178ab1a023ba9eb207c494a466f6b88ffeb608f68ad1d66e729cbedafa9132
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.
Transparency logSecurity for voicemeeter-compact 1.10.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for voicemeeter_compact-1.10.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
