mirror of
https://github.com/onyx-and-iris/vmr-http.git
synced 2026-04-06 09:59:11 +00:00
39 lines
901 B
Markdown
39 lines
901 B
Markdown
# Voicemeeter HTTP
|
|
|
|
[](https://github.com/astral-sh/uv)
|
|
[](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
|