Giter VIP home page Giter VIP logo

soundpad.js's Introduction

Soundpad.js

NPM version

An npm package for interacting with Soundpad

Install

npm install --save soundpad.js

Usage

Basic example

import Soundpad, { getSoundpadPath, openSoundpad } from 'soundpad.js';

const soundpad = new Soundpad()

console.log(getSoundpadPath())

async function run () {
  await openSoundpad()

  await soundpad.connect()

  await soundpad.playSound(1)

  soundpad.disconnect()
}

run()

Using in the browser

If you plan to use this package in the browser (with a custom dataDriver), you may get an error because some functions need Node's 'child_process' module. To fix this, you can import soundpad.js with the secondary entry point soundpad.js/web (which does not export those functions) like in this example:

import Soundpad from 'soundpad.js/lib/web';

const soundpad = new Soundpad();

soundpad.connect((query) => {
  return fetch('/api/soundpad/', { method: 'POST', body: query })
    .then((data) => data.text())
});

Changelog

Changes marked with โŒ are breaking changes

2.0.0

  • Fixed the Soundpad.waitForStatus() function
  • Added a secondary entry point soundpad.js/web
  • Exporting the PlayStatus enum
  • Correctly updating the Soundpad.isConnected property when using a custom dataDriver
  • Exposed the previously private property Soundpad.connectionAwaiter, which is a promise that resolves when the connection is established.
  • โŒ Renamed multiple types to remove the "Type" suffix
  • Capitalized the default export for IDE autoimport improvement
  • Fixed various return types to remove unattainable undefined results

Notes

This package is mainly a porting of https://www.leppsoft.com/soundpad/files/rc/SoundpadRemoteControl.java to Typescript, with some utility functions added.

soundpad.js's People

Contributors

seblor avatar

Stargazers

 avatar Nassinger avatar

Watchers

 avatar  avatar

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.