Socket
Book a DemoInstallSign in
Socket

custom-audio-node-connect

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

custom-audio-node-connect

A tiny module that allows you to connect custom audio nodes in your Web Audio API audio chain

latest
Source
npmnpm
Version
1.0.1
Version published
Maintainers
1
Created
Source

custom-audio-node-connect

custom-audio-node-connect shims the AudioNode.connect method and lets you choose which audio nodes to actually connect to each other.

This is useful if you want your own custom nodes/effects to be chainable just like any other node.

The code in this module is copied straight from the terrific tuna by Theodeus. All cred goes there!

Installation

npm i -S custom-audio-node-connect

Usage

import enableCustomConnects from 'custom-audio-node-connect'
import BitCrusher from './my-effects/BitCrusher.js'

const ctx = new AudioContext()

// Every time `AudioNode.connect(someAudioNode)` is called, the `inputSelector`
// function will be called to determine what to actually connect to.
//
// In this imaginary example, BitCrusher objects has an `input` property
// which is a regular GainNode. If someAudioNode has an `input` property,
// we let the connecting node connect to that, otherwise we just return
// the node as is.
const inputSelector = (node) => node.input || node
enableCustomConnects(ctx, inputSelector)

// Create an AudioNode, here an oscillator, together with an instance
// of our custom BitCrusher effect.
const osc = ctx.createOscillator()
osc.frequency.value = 440
const crushEffect = new BitCrusher()

// Connecting now works seemlessly. You'll have to implement the
// BitCrusher's `connect()` and `disconnect()` methods yourself. :(
osc.connect(crushEffect)
crushEffect.connect(ctx.destination)

API

### enableCustomConnects(audioContext, inputSelector)

audioContext

An AudioContext instance.

inputSelector
(node: any) => AudioNode

A function that takes any object passed to AudioNode.connect() and return and AudioNode that the connecting node should connect to.

See also

  • audio-param-shim - An AudioParam shim that lets you act on value changes in any way you want
  • Theodeus/tuna - An audio effects library for the Web Audio API.

Keywords

waapi

FAQs

Package last updated on 01 Dec 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts