GoXLR Utility API Python Wrapper
A python wrapper for the API of the open-source GoXLR software alternative, GoXLR Utility, that uses asyncio. Disclaimer: This project is not affiliated with the GoXLR brand or TC-Helicon in any way, shape, or form. This is a third-party package made for fun and educational purposes.
Features
- Asynchronous connection to the GoXLR utility daemon
- All methods have been translated to Python
- Handy enumerators for everything
- Very simple and easy to get started
Installation
pip install goxlr
Getting Started
Here's some sample code to get started with this package that pings the utility's daemon.
import asyncio
from goxlr import GoXLR
from goxlr.types import Fader, Channel
async def main():
async with GoXLR() as xlr:
await xlr.set_fader(Fader.A, Channel.Headphones)
await xlr.set_volume(Channel.Headphones, 127)
if __name__ == "__main__":
asyncio.run(main())
You may have noticed that we use with to manage the connection to the GoXLR. You may also wish to use the more traditional open and close methods which is acceptable too.
async def main():
xlr = GoXLR()
await xlr.open()
ping = await xlr.ping()
print(ping) # Ok
await xlr.close()
Contributing
Coming soon. As there isn't a CONTRIBUTING.md yet, please try to emulate the style of the rest of the code. Using snake_case and descriptive method argument names with type hints wherever possible.
Documentation
Please visit the documentation for more information on how to use this package.
1 maintainer
Metadata
1 maintainer
Release files for goxlr 1.4.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| goxlr-1.4.8.tar.gz | 23.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| goxlr-1.4.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 48.7 kB
Release files / goxlr-1.4.8.tar.gz
| Download URL | goxlr-1.4.8.tar.gz |
|---|---|
| Size | 23.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a10ef1d16c5d160e870b9dd109d381cd8ced1baaabb037acdc51ea87e8e3c7d
|
|
BLAKE2b-256 checksum How to use checksums |
dcb3f06c297246582d48451183ba5bae9d280477db33e34f407a8879a785e22c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Release files / goxlr-1.4.8-py3-none-any.whl
| Download URL | goxlr-1.4.8-py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d7fd9075da85224fbd029a7b9573fb8b60253914ba82c96c51f70437aba88c0b
|
|
BLAKE2b-256 checksum How to use checksums |
74899e3be9fb149a8302bb788140ae3e4bed29975b3b0fd6656f320603f4f521
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
