Metadata-Version: 2.3
Name: vmr-http
Version: 0.8.1
Summary: HTTP API for controlling Voicemeeter
Author: onyx-and-iris
Author-email: onyx-and-iris <code@onyxandiris.online>
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: fastapi>=0.135.3
Requires-Dist: uvicorn>=0.43.0
Requires-Dist: voicemeeter-api>=2.7.2
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# Voicemeeter HTTP

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![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)

---

## Install

```console
pip install vmr-http
```

## Run

```console
uvicorn vmr_http:app
```

## Documentation

For a few examples see [API_EXAMPLES](./API_EXAMPLES.md).

For an exhaustive list of the endpoints 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

`vmr-http` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

[auto-docs]: https://fastapi.tiangolo.com/features/#automatic-docs
