webchuck
TypeScript icon, indicating that this package has built-in type declarations

1.2.7 • Public • Published

WebChucK

Node.js Build

site | docs | npm

WebChucK brings ChucK, a strongly-timed audio programming language, to the web! ChucK's C++ source code has been compiled with Emscripten and targets WebAssembly (WASM) to run via the AudioWorkletNode interface of the Web Audio API. With near-native performance, WebChucK runs on modern desktop browsers as well as tablets and mobile devices! Bring together ChucK's real-time sound synthesis engine and web tools to create new experiences and develop creative workflows. Embed WebChucK into any website to build online audiovisual experiences, immersive multi-channel audio web apps, or shareable musical instruments! To learn more about WebChucK and what it can do, check out https://chuck.stanford.edu/webchuck/

Try out WebChucK in action through WebChucK IDE!

Getting Started

NPM

Install WebChucK via npm and use it with TypeScript:

npm install webchuck
import { Chuck } from 'webchuck'

// Create the default ChucK object
const theChuck = await Chuck.init([]);

// Run ChucK code
theChuck.runCode(`
    SinOsc sin => dac;
    440 => sin.freq;
    1::second => now;
`);

Note that many browsers do not let audio run without a user interaction (e.g. button press). You can check for a suspended audio context and resume like this:

if (theChuck.context.state === "suspended") {
    theChuck.context.resume();
}

CDN

You can also embed WebChucK as a JS module into your index.html.

<html>
  <head>
    <script type="module" defer>
      import { Chuck } from 'https://cdn.jsdelivr.net/npm/webchuck/+esm';

      document.getElementById('action').addEventListener('click', async () => {
        // Initialize default ChucK object, if not already initialized
        window.theChuck ??= await Chuck.init([]);
        // Run ChucK code
        theChuck.runCode(`
          SinOsc sin => dac;
          440 => sin.freq;
          1::second => now;
        `);
      });
    </script>
  </head>
  <body>
    <button id="action">Start and Play</button>
  </body>
</html>

You now have a WebChucK instance in the global variable theChuck. Read the API reference to see how to communicate between JS and ChucK e.g. removing shreds, syncing variables, monitoring the VM etc.

Documentation

WebChucK full documentation and API reference: here

For Developers

If you are a developer, check out the Developer Guide to get started.

Readme

Keywords

Package Sidebar

Install

npm i webchuck

Weekly Downloads

49

Version

1.2.7

License

MIT

Unpacked Size

96.8 kB

Total Files

17

Last publish

Collaborators

  • colesimmons
  • terryzfeng