t3duk / goxlr-js

GoXLR JS is a JavaScript Wrapper for the GoXLR Utility API made by the GoXLR on Linux Organisation.

Project Update [13/06/24]

Soon, this project wll be renamed to goxlr and will support TypeScript and unit tests.

GoXLR JS

GoXLR JS is a JavaScript Wrapper for GoXLR Utility API made by the GoXLR on Linux Organisation.

Install

You can install GoXLR JS from npm.

npm i goxlr@latest

Usage

To start, import the classes into your project:

const { goxlr } = require("goxlr");
const goxlrInstance = new goxlr();

Refer to the documentation to see the nearly 150 functions you can use.

Example

const { goxlr } = require("goxlr");
const goxlrInstance = new goxlr();

async function mute() {
  await goxlrInstance.setVolume("Mic", 0);
  await goxlrInstance.setVolume("Chat", 0);
  await goxlrInstance.close();
}

mute()

Contributing

We are open to people contributing. Please fork the repo, make any changes, and open a pull request.

Bugs / Features

If you would like to suggest a quality of life update, or there is a bug which needs fixxing you can open an issue here.

Disclaimer

This project is also not supported by, or affiliated in any way with, TC-Helicon. For the official GoXLR software and official GoXLR Mini software, please refer to their website.

In addition, this project accepts no responsibility or liability for use of this software, or any problems which may occur from its use. Please read the LICENSE for more information.

GoXLR JS was created by Ted @ t3d.uk. Thank you to @JulanDeAlb for creating the JSON Command List. Thank you to @FrostyCoolSlug for creating the GoXLR Utility alongside the GoXLR on Linux Organisation.