goxlr 1.4.6

A Python wrapper for the GoXLR Utility API.

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.