Code Monkey home page Code Monkey logo

goxlr-js's Introduction

GoXLR JS

npm GitHub Repo stars GitHub issues Discord npm

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.

goxlr-js's People

Contributors

inib avatar t3duk avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

inib

goxlr-js's Issues

Some feedbacks

Hello !

First of all, thank you for that work!

I have a few feedbacks if I may :)

The IP is hardcoded to 127.0.0.1 which will work for most people, but it would be nice to expose that as a parameter so we can control a remote device as well.
Same for the port in case we'd like to use another port that's then forwared to the GoXLR socket port.
having the possibility to specify both IP and port would open more usage

If I'm not mistaken your creating/closing the connection for every call?
If so, that seems a bit rough. Keeping the connection open and simply reusing it for every new request would be preferable I think.

Having typescript typings would be pretty awesome as well :D

Because of all the above I can't use that lib but I'm sure it will help others !

Best regards :)

Typescript

Hi,

Just want to ask if you plan to create typescript types for this package ? I use it in typescript and auto complete will help a lot to develop with

Have a nice day,
Kev

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.