Updates the internal selected nodes array with a collection of audio nodes matching the selector provided. Type, Class & Id selectors are supported.

//type selector using the node name, sets the frequency for all sines
__("sine").frequency(200);

//set the frequency for the node with id "foo"
__("#foo").frequency(200);

//set the frequency for any nodes with a class of "bar"
__(".bar").frequency(200);

//select all sines, any nodes with classname "bar" or id of "foo"
//and set their frequencies to 200
__("sine,.bar,#foo").frequency(200);

If invoked without arguments, cracked() resets the selection/connection state, removing any record of previous nodes and effectively marking the start of a new connection chain. Since a new node will try to connect to any previous node, calling __() tells a node that there is no previous node to connect to. For example:

//Create & connect sine -> lowpass -> dac
__().sine();
__.lowpass();
__.dac();

//Create but don't connect
__().sine();
__().lowpass();
__().dac();

cracked is also the namespace for public methods and also can be written as a double underscore __

__("sine"); //same as cracked("sine")

Source:

src/find.js, line 53

Methods

Find

reset() → {cracked}

resets everything to its initial state

//reset state for the entire app
 cracked.reset();

Source:

src/find.js, line 148

Returns:

Type: cracked

exec(method, args, nodes) → {cracked}

executes a method with a specific set of selected nodes without modifying the internal selectedNodes array

//filter everything but the sines from currently selected nodes and
//execute the frequency method against the remaining sines.
//the internal _selectedNodes array remains unchanged
cracked.exec(
   "frequency",
   200,
   cracked.filter("sine")
);

Parameters:

Name	Type	Description
`method`	String	method name
`args`	Array	arguments to supply to the method
`nodes`	Array	node array to execute against

Source:

src/find.js, line 168

Returns:

Type: cracked

each(type, fn) → {cracked}

iterate over the selectedNodes array, executing the supplied function for each element

__.each(type, function(node,index,array){
     //Loops over any selected nodes. Parameters are the
     //current node, current index, and the selectedNode array
});

Parameters:

Name	Type	Description
`type`	String	string to be checked against the node type
`fn`	function	function to be called on each node

Source:

src/find.js, line 197

Returns:

Type: cracked

filter(selector) → {Array}

Filter selected nodes with an additional selector returns node array that can used with exec()

//select any sine & sawtooth oscillators
__("sine,saw");

//filter out everything but the sines and
//execute the frequency method against those nodes.
//the internal _selectedNodes array remains unchanged
cracked.exec(
   "frequency",
   200,
   cracked.filter("sine")
);

Parameters:

Name	Type	Description
`selector`	String	selector expression

Source:

src/find.js, line 225

Returns:

Type: Array

find(selector) → {Array}

Find nodes with a selector returns node array that can used with exec()

//find all the sines in the patch and
//execute the frequency method against those nodes.
//the internal _selectedNodes array remains unchanged
cracked.exec(
   "frequency",
   200,
   cracked.find("sine")
);

Parameters:

Name	Type	Description
`selector`	String	selector expression

Source:

src/find.js, line 267

Returns:

Type: Array

Control

start()

Calls start() on the currently selected nodes. Throws no error if there aren't any selected nodes with a start method

//create and connect sine->lowpass->dac
__().sine().lowpass().dac();
//start the sine node
__("sine").start();

See more control examples

Source:

src/control.js, line 7

stop()

Calls stop() on the currently selected nodes. Throws no error if there are no selected nodes that have a stop method.

//create and connect sine->lowpass->dac
__().sine().lowpass().dac();
//stop the sine node
__("sine").stop();

See more control examples

Source:

src/control.js, line 46

ramp(target, timeToRamp, paramToRamp, initial, type)

Public method to ramp a parameter on currently selected nodes. Target & timeToRamp parameters can be numbers or arrays of numbers for multisegement ramps. Initial value param is optional, if omitted, then the current value is used as the initial value. If loop is running, then ramp start times are snapped to the sequencer grid.

//create and connect sine->lowpass->dac & play
__().sine().lowpass().dac().play();
//ramp the frequency of the sine. 220 to 880 in 5 seconds
__("sine").ramp(880,5,"frequency",220);

See more envelope examples

Parameters:

Name	Type	Description
`target`	Number \| Array	value to ramp to
`timeToRamp`	Number \| Array	length of ramp in seconds
`paramToRamp`	String	name of parameter to ramp
`initial`	Number	value to start the ramp at
`type`	String	of ramp, "exp" is exponential. defaults to linear.

Source:

src/control.js, line 71

attr(userParams, userParams)

Set or get attribute values on a node. Takes an object with any number of key:value pairs to set. A string with the param name returns the current value of that param on the first selected node.

//create and connect sine->lowpass->dac & play
__().sine().lowpass().dac().play();
//set the frequency of the sine to 880
__("sine").attr({"frequency":880});

//get the frequency
__("sine").attr("frequency"); //880

See more control examples

Parameters:

Name Type Description

userParams

Object

options object

Properties

Name	Type	Description
`paramName`	String
`paramValue`

userParams String

Source:

src/control.js, line 131

Node

script(userParamsopt)

Native Script node

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default
`buffersize`	Number	<optional>	4096
`channels`	Number	<optional>	1
`fn`	function	<optional>	defaultFunction

Source:

src/nodes.js, line 6

waveshaper(userParamsopt)

Native Waveshaper

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`drive`	Number	<optional>	50

Source:

src/nodes.js, line 44

compressor(userParamsopt)

Native Compressor

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`threshold`	Number	<optional>	-24	in decibels, nominal range of -100 to 0.
`knee`	Number	<optional>	30	in decibels, range of 0 to 40
`ratio`	Number	<optional>	12	nominal range of 1 to 20
`attack`	Number	<optional>	0.003	time in seconds, nominal range of 0 to 1
`release`	Number	<optional>	0.250	time in seconds, nominal range of 0 to 1

Source:

src/nodes.js, line 95

gain(userParamsopt)

Native Gain

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`threshold`	Number	<optional>	-24	in decibels, nominal range of -100 to 0.

Source:

src/nodes.js, line 126

native_delay(userParamsopt)

Naming this with prefix native so I can use "delay" as a plugin name max buffer size three minutes

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`delay`	Number	<optional>	0	in seconds.

Source:

src/nodes.js, line 152

osc(userParamsopt)

Native oscillator, used the oscillator plugins

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`detune`	Number	<optional>	0
`type`	String	<optional>	sine

Source:

src/nodes.js, line 176

biquadFilter(userParamsopt)

Native biquad filter, used by filter plugins

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`q`	Number	<optional>	0
`gain`	String	<optional>	0
`type`	String	<optional>	lowpass

Source:

src/nodes.js, line 201

channelMerger(userParamsopt)

Native channelMerger

Parameters:

Name	Type	Attributes	Description
`userParams`	Object	<optional>	map of optional values

Source:

src/nodes.js, line 228

channelSplitter(userParamsopt)

Native channelSplitter

Parameters:

Name	Type	Attributes	Description
`userParams`	Object	<optional>	map of optional values

Source:

src/nodes.js, line 259

convolver(userParamsopt)

Native convolver, used by reverb

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Description
`path`	String	<optional>	path to remote impulse
`fn`	function	<optional>	function to generate impulse

Source:

src/nodes.js, line 280

stereoPanner(userParamsopt)

Native stereo panner, used by panner

Parameters:

Name	Type	Attributes	Description
`userParams`	Object	<optional>	map of optional values

Source:

src/nodes.js, line 305

destination(userParamsopt)

Native destination, used by the dac plugin

Parameters:

Name	Type	Attributes	Description
`userParams`	Object	<optional>	map of optional values

Source:

src/nodes.js, line 328

origin(userParamsopt)

Native sound input node, used by the adc plugin origin = opposite of destination

Parameters:

Name	Type	Attributes	Description
`userParams`	Object	<optional>	map of optional values

Source:

src/nodes.js, line 345

buffer(userParamsopt)

Native audio source node and buffer combined.

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`path`	String	<optional>		path to remote file
`speed`	Number	<optional>	1	playback speed
`start`	Number	<optional>	0	play head start value in seconds
`end`	Number	<optional>	0	play head end value in seconds
`loop`	Boolean	<optional>	false	loop?

Source:

src/nodes.js, line 424

Sequence

loop(argopt, configopt) → {cracked}

main method for loop

//configure the loop: 8 steps, 100ms between steps
__.loop({steps:8,interval:100});

//start
__.loop("start");
//stop
__.loop("stop");
//reset the loop params
__.loop("reset");

See sequencing examples

Parameters:

Name Type Attributes Description

arg

String

stop/start/reset commands

config

Object

configuration object

Properties

Name	Type	Attributes	Default	Description
`interval`	Number	<optional>	100	step length in ms

Source:

src/sequence.js, line 24

Returns:

Type: cracked

bind(eventType, fn, data) → {cracked}

Listener - binds a set of audio nodes and a callback to loop step events

Parameters:

Name	Type	Description
`eventType`	String	currently just "step"
`fn`	function	callback to be invoked at each step
`data`	Array	should the same length as the number of steps

Source:

src/sequence.js, line 254

Returns:

Type: cracked

unbind(eventType)

Remove any steps listeners registered on these nodes

Parameters:

Name	Type	Description
`eventType`	String

Source:

src/sequence.js, line 282

Macro

begin(name, userParams)

start macro recording, add any user parameters (id,classname,etc) to the container macro

//define a simple macro named "microsynth"
__().begin("microsynth").sine().gain(0).dac().end("microsynth");

Parameters:

Name	Type	Description
`name`	String	macro name
`userParams`	Object	options object

Source:

src/macro.js, line 8

end(name)

end macro recording

//define a simple macro named "microsynth"
__().begin("microsynth").sine().gain(0).dac().end("microsynth");

Parameters:

Name	Type	Description
`name`	String	macro name

Source:

src/macro.js, line 28

Midi

midi_supported() → {boolean}

Is midi supported?

if(__.midi_supported()) {
     //do midi stuff here
     //cuz you can
}

Source:

src/midi.js, line 16

Returns:

Type: boolean

midi_init(callback)

Initialize midi. Callback is invoked when ready.

//when midi is ready...
__.midi_init(function(){
     //...call this function
});

Parameters:

Name	Type	Description
`callback`	function

Source:

src/midi.js, line 33

midi_receive(callback)

Midi input. Bind handler for the onMIDIMessage event.

//when midi is ready...
__.midi_init(function(){
     __.midi_receive(function(midiEvent){
         //handle incoming raw midi events here...
     });
});

Parameters:

Name	Type	Description
`callback`	function

Source:

src/midi.js, line 66

midi_noteon(callback)

Midi input. Shorthand binding for note ons

//when midi is ready...
__.midi_init(function(){
     //get midi noteon events
     __.midi_noteon(function(noteData){
         //note data = [status,pitch,velocity]
         //handle midi note ons...
     });
});

Parameters:

Name	Type	Description
`callback`	function

Source:

src/midi.js, line 129

midi_noteoff(callback)

Midi input. Shorthand binding for note offs

//when midi is ready...
__.midi_init(function(){
     //get midi noteoff events
     __.midi_noteoff(function(noteData){
         //note data = [status,pitch,velocity]
         //handle midi note offs...
     });
});

Parameters:

Name	Type	Description
`callback`	function

Source:

src/midi.js, line 153

midi_control(callback)

Midi input. Shorthand binding for midi control messages

//when midi is ready...
__.midi_init(function(){
     //get midi control events
     __.midi_control(function(noteData){
         //note data = [status,pitch,velocity]
         //handle midi control events...
     });
});

Parameters:

Name	Type	Description
`callback`	function

Source:

src/midi.js, line 177

Connect

connect(selector)

chainable method to connect nodes to previously instantiated nodes. Takes a selector to find the nodes to connect to.

//create and connect sine->lowpass->dac
__().sine().lowpass().dac();
//create a sawtooth and connect to the lowpass instantiated above
__().saw().connect("lowpass");

Parameters:

Name	Type	Description
`selector`	String	selector expression

Source:

src/connect.js, line 7

Returns:

cracked

remove(time)

chainable method to stop, disconnect and remove the currently selected nodes. Takes a time in ms to schedule the node removal.

//create and connect sine->lowpass->dac
__().sine().lowpass().dac();
//remove the lowpass instantiated above in 100ms
__("lowpass").remove(100);

Parameters:

Name	Type	Description
`time`	Number	in ms to schedule node removal

Source:

src/connect.js, line 60

Returns:

cracked

Debug

log()

log selected nodes to console if any.

//create and connect sine -> lowpass -> dac
__().sine().lowpass().dac();

//logs the [oscillatorNode] object to the console
__("sine").log()

Source:

src/debug.js, line 6

size() → {Number}

return the length of selected nodes array

//create and connect sine -> lowpass -> dac
__().sine().lowpass().dac();

//returns 2
__("sine,lowpass").size();

Source:

src/debug.js, line 50

Returns:

Type: Number

_dumpState()

dump the node lookup object to the console works in debug only

Source:

src/debug.js, line 91

_getNode(uuid) → {*}

debug method to get a node with a uuid works in debug only

Parameters:

Name	Type	Description
`uuid`

Source:

src/debug.js, line 104

Returns:

Type: *

Type

ifUndef(test, def)

Returns the 2nd argument if the 1st is undefined

Parameters:

Name	Type	Description
`test`	*	thing to test for undefined
`def`	*	default value to return if test is undefined

Source:

src/type.js, line 1

isNotUndef(test)

Returns true if not undefined

Parameters:

Name	Type	Description
`test`	*	thing to test for undefined

Source:

src/type.js, line 15

isUndef(test)

Returns true if undefined

Parameters:

Name	Type	Description
`test`	*	thing to test for undefined

Source:

src/type.js, line 28

isObj(obj)

Returns true if param is an object

Parameters:

Name	Type	Description
`obj`	*	thing to test

Source:

src/type.js, line 41

isNum(num)

Returns true if param is a number

Parameters:

Name	Type	Description
`num`	*	thing to test

Source:

src/type.js, line 54

isStr(str)

Returns true if param is a string

Parameters:

Name	Type	Description
`str`	*	thing to test

Source:

src/type.js, line 71

isArr(arr)

Returns true if param is an array

Parameters:

Name	Type	Description
`arr`	*	thing to test

Source:

src/type.js, line 84

isFun(fn)

Returns true if param is a function

Parameters:

Name	Type	Description
`fn`	*	thing to test

Source:

src/type.js, line 97

Algorithmic

random_interval(callback, minTime, maxTime)

execute a callback at random intervals within a range

Parameters:

Name	Type	Description
`callback`	function	to be invoked at every interval
`minTime`	Number	minimum value for the random interval
`maxTime`	Number	maximum value for the random interval

Source:

plugins/algorithmic.cracked.js, line 1

random_envelope(length) → {Array}

create a adsr envelope with random values scaled to a length

Parameters:

Name	Type	Description
`length`	Number	in sec

Source:

plugins/algorithmic.cracked.js, line 28

Returns:

Type: Array

fill_array(size, fn) → {Array}

fill an array with some values

Parameters:

Name	Type	Description
`size`	Number	of the array to be filled
`fn`	function	to provide the value, if absent then array is filled with 0's.

Source:

plugins/algorithmic.cracked.js, line 62

Returns:

Type: Array

array_next(arr, offset, limit, callback)

advance thru array one step at a time. start over when arriving at the end

Parameters:

Name	Type	Description
`arr`	Array	to loop over
`offset`	Number	added to index
`limit`	Number	upper bound to iteration
`callback`	function	invoked when the count resets

Source:

plugins/algorithmic.cracked.js, line 84

chance(percentage) → {boolean}

Returns a boolean based on percentage.

Parameters:

Name	Type	Description
`percentage`	Number

Source:

plugins/algorithmic.cracked.js, line 111

Returns:

Type: boolean

scales(type)

Returns a musical scale/mode based on type

Parameters:

Name	Type	Description
`type`	String	scale type

Source:

plugins/algorithmic.cracked.js, line 126

chords(type)

Returns a musical scale/mode based on type

Parameters:

Name	Type	Description
`type`	String	scale type

Source:

plugins/algorithmic.cracked.js, line 148

random_scale(scale, octave_lower, octave_upper)

Return a random series of frequencies from randomly selected octaves from a given scale

Parameters:

Name	Type	Description
`scale`	String
`octave_lower`	Number
`octave_upper`	Number

Source:

plugins/algorithmic.cracked.js, line 173

random_arpeggio(chord, octave_lower, octave_upper)

Return a random series of frequencies from a randomly selected octave from a given chord

Parameters:

Name	Type	Description
`chord`	String
`octave_lower`	Number
`octave_upper`	Number

Source:

plugins/algorithmic.cracked.js, line 191

shuffle(arr)

Takes a reference to an array, shuffles it and returns it

Parameters:

Name	Type	Description
`arr`	Array

Source:

plugins/algorithmic.cracked.js, line 209

urnFactory(max)

Returns a function that generates a unique random number between 0 & max. If max is exceeded, then repeat the sequence of random numbers.

Parameters:

Name	Type	Description
`max`	Number

Source:

plugins/algorithmic.cracked.js, line 240

random(min, max)

Returns a random number between min & max

Parameters:

Name	Type	Description
`min`	Number
`max`	Number

Source:

plugins/algorithmic.cracked.js, line 267

throttle_factory(num)

Factory to create a throttling function that returns true when called every nth times

Parameters:

Name	Type	Description
`num`	Number

Source:

plugins/algorithmic.cracked.js, line 282

sequence(name)

Sequence - create a series of steps that take a function to execute and a time in minutes (including fractions) for when to execute it

See more sampler examples

Parameters:

Name	Type	Description
`name`	String	name of sequence

Source:

plugins/algorithmic.cracked.js, line 314

Delay

reverb(paramsopt)

Convolver Reverb

See more reverb examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`reverse`	Boolean	<optional>	false	reverse reverb
`path`	String	<optional>		path to impulse file. if no path, impulse is generated.
`seconds`	Number	<optional>	3	if generated impulse, length in seconds.
`decay`	Number	<optional>	2	if generated impulse, length of decay in seconds
`fn`	function	<optional>	buildImpulse	custom function to generate an impulse buffer

Source:

plugins/delays.cracked.js, line 1

delay(paramsopt)

Delay

See more delay examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`delay`	Number	<optional>	1	delay time in seconds
`damping`	Number	<optional>	0.84	feedback input gain
`cutoff`	Number	<optional>	1500	frequency of lowpass filtering on feedback loop
`feedback`	Number	<optional>	0.5	feedback gain output

Source:

plugins/delays.cracked.js, line 60

comb(paramsopt)

Comb

See more reverb examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`delay`	Number	<optional>	0.027	delay time in seconds
`damping`	Number	<optional>	0.84	feedback input gain
`cutoff`	Number	<optional>	3000	frequency of lowpass filtering on feedback loop
`feedback`	Number	<optional>	0.84	feedback gain output

Source:

plugins/delays.cracked.js, line 134

Distortion

bitcrusher(paramsopt)

Bitcrusher

See more bitcrusher examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	0.1
`bits`	Number	<optional>	6

Source:

plugins/distortion.cracked.js, line 1

ring(paramsopt)

Ring Modulator

See more ring modulator examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`distortion`	Number	<optional>	1
`frequency`	Number	<optional>	30

Source:

plugins/distortion.cracked.js, line 54

overdrive(paramsopt)

Overdrive, waveshaper with additional parameters

See more overdrive examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`drive`	Number	<optional>	0.5
`color`	Number	<optional>	800
`postCut`	Number	<optional>	3000

Source:

plugins/distortion.cracked.js, line 210

Envelope

adsr(userParamsopt, userParamsopt, userParamsopt, userParamsopt, userParamsopt)

Attack Decay Sustain Release envelope

See more adsr examples

Attack time is the time taken for initial run-up of level from nil to peak, beginning when the key is first pressed. Decay time is the time taken for the subsequent run down from the attack level to the designated sustain level. Sustain level is the level during the main sequence of the sound's duration, until the key is released. Release time is the time taken for the level to decay from the sustain level to zero after the key is released.

Parameters:

Name	Type	Attributes	Default	Description
`userParams`	Array	<optional>		5 values: attack,decay,sustain,hold,release
`userParams`	Array	<optional>		4 values: attack,decay,sustain,release
`userParams`	Array	<optional>		3 values: attack,decay,sustain (holds until released)
`userParams`	String	<optional>		"slow" or "fast"
`userParams`	Number	<optional>	0.5	length of the total envelope

Source:

plugins/envelopes.cracked.js, line 1

Filter

lowpass(paramsopt)

Lowpass Filter

See more lowpass examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q

Source:

plugins/filters.cracked.js, line 1

highpass(paramsopt)

Highpass Filter

See more highpass examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q

Source:

plugins/filters.cracked.js, line 30

bandpass(paramsopt)

Bandpass Filter

See more bandpass examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q

Source:

plugins/filters.cracked.js, line 59

lowshelf(paramsopt)

Lowshelf Filter

See more lowshelf examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q
`gain`	Number	<optional>	0	gain

Source:

plugins/filters.cracked.js, line 88

highshelf(paramsopt)

Highshelf Filter

See more highshelf examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q
`gain`	Number	<optional>	0	gain

Source:

plugins/filters.cracked.js, line 119

peaking(paramsopt)

Peaking Filter

See more peaking examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q
`gain`	Number	<optional>	0	gain

Source:

plugins/filters.cracked.js, line 150

notch(paramsopt)

Notch Filter

See more notch examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q

Source:

plugins/filters.cracked.js, line 181

allpass(paramsopt)

Allpass Filter

See more allpass examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`frequency`	Number	<optional>	440	frequency
`q`	Number	<optional>	0	Q

Source:

plugins/filters.cracked.js, line 210

Interaction

mouse_movement()

Passes mouse move events to a callback. Tracks the movement of the mouse. web audio

Source:

plugins/interaction.cracked.js, line 1

key_press()

Passes key press events to a callback. Tracks keyboard activity. web audio

Source:

plugins/interaction.cracked.js, line 21

Miscellaneous

clip()

Clips audio level at 1/-1

Source:

plugins/miscellaneous.cracked.js, line 1

dac(paramsopt)

System out - destination with a master volume. Output is clipped if gain is 1 or less.

Parameters:

Name	Type	Attributes	Default	Description
`params`	Number	<optional>	1	system out gain

Source:

plugins/miscellaneous.cracked.js, line 25

adc(paramsopt)

System in - input with a master volume

Parameters:

Name	Type	Attributes	Default	Description
`params`	Number	<optional>	1	system in gain

Source:

plugins/miscellaneous.cracked.js, line 47

out(paramsopt)

System out - destination with a master volume Alias for dac

Parameters:

Name	Type	Attributes	Default	Description
`params`	Number	<optional>	1	system out gain

Source:

plugins/miscellaneous.cracked.js, line 65

multi_out(userParamsopt)

System multi_out - destination with a master volume w/ multi-channel support

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`gain`	Number	<optional>	1
`channel`	Number	<optional>	1

Source:

plugins/miscellaneous.cracked.js, line 84

in(paramsopt)

System in - input with a master volume Alias for adc

Parameters:

Name	Type	Attributes	Default	Description
`params`	Number	<optional>	1	system in gain

Source:

plugins/miscellaneous.cracked.js, line 105

panner(paramsopt)

Panner - simple stereo panner

Parameters:

Name	Type	Attributes	Description
`params`	Object	<optional>	map of optional values

Source:

plugins/miscellaneous.cracked.js, line 161

sampler(userParamsopt)

Sampler - sound file player

See more sampler examples

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`speed`	Number	<optional>	1
`start`	Number	<optional>	1
`end`	Number	<optional>	1
`path`	String	<optional>	''	path to sound file to play
`loop`	Boolean	<optional>	false

Source:

plugins/miscellaneous.cracked.js, line 181

Modulator

lfo(userParamsopt)

Low Frequency Oscillator

See more LFO examples

Parameters:

Name Type Attributes Description

userParams

Object

map of optional values

Properties

Name	Type	Attributes	Default
`modulates`	String	<optional>	frequency
`type`	String	<optional>	saw
`frequency`	Number	<optional>	6
`gain`	Number	<optional>	1000

Source:

plugins/modulators.cracked.js, line 1

stepper(paramsopt)

Stepper

fill an audio buffer with a series of discrete values.

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`modulates`	String	<optional>	frequency
`fn`	function	<optional>	function to generate values (if not supplied, then random values between -1 & 1)
`steps`	Number	<optional>	number of steps in the buffer
`length`	Number	<optional>	length of the buffer in seconds
`gain`	Number	<optional>	1000

Source:

plugins/modulators.cracked.js, line 49

Noise

noise(paramsopt)

noise parametrized noise node

See more noise examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`type`	String	<optional>	white

Source:

plugins/noise.cracked.js, line 1

pink(paramsopt)

Pink Noise

See more noise examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`channels`	Number	<optional>	1
`length`	Number	<optional>	1

Source:

plugins/noise.cracked.js, line 27

white(paramsopt)

White Noise

See more noise examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`channels`	Number	<optional>	1
`length`	Number	<optional>	1

Source:

plugins/noise.cracked.js, line 108

brown(paramsopt)

Brown Noise

See more noise examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default	Description
`channels`	Number	<optional>	1
`length`	Number	<optional>	1

Source:

plugins/noise.cracked.js, line 155

Oscillator

sine(paramsopt)

Sine Wave Oscillator

See more oscillator examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`detune`	Number	<optional>	0
`type`	String	<optional>	sine

Source:

plugins/oscillators.cracked.js, line 3

square(paramsopt)

Square Wave Oscillator

See more oscillator examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`detune`	Number	<optional>	0
`type`	String	<optional>	sine

Source:

plugins/oscillators.cracked.js, line 33

saw(paramsopt)

Sawtooth Wave Oscillator

See more oscillator examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`detune`	Number	<optional>	0
`type`	String	<optional>	sine

Source:

plugins/oscillators.cracked.js, line 63

triangle(paramsopt)

Triangle Wave Oscillator

See more oscillator examples

Parameters:

Name Type Attributes Description

params

Object

map of optional values

Properties

Name	Type	Attributes	Default
`frequency`	Number	<optional>	440
`detune`	Number	<optional>	0
`type`	String	<optional>	sine

Source:

plugins/oscillators.cracked.js, line 93

Setters

frequency(userParam)

See more control examples

Frequency setter convenience method

Parameters:

Name	Type	Description
`userParam`	Number	frequency to set

Source:

plugins/setters.cracked.js, line 1

detune(userParam)

Detune setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	detune frequency to set

Source:

plugins/setters.cracked.js, line 23

type(userParam)

Type setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	String	oscillator type to set

Source:

plugins/setters.cracked.js, line 45

volume(userParam)

Gain setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	gain to set

Source:

plugins/setters.cracked.js, line 67

fadeOut(userParam)

Fade out convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	optional time to set in seconds. Defaults to 0.02

Source:

plugins/setters.cracked.js, line 89

fadeIn(userParam)

Fade in convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	optional time to set in seconds. Defaults to 0.02

Source:

plugins/setters.cracked.js, line 108

time(userParam)

Delay time setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	delay time to set

Source:

plugins/setters.cracked.js, line 127

feedback(userParam)

Feedback setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	feedback amount to set

Source:

plugins/setters.cracked.js, line 149

speed(userParam)

Speed setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	sampler speed to set

Source:

plugins/setters.cracked.js, line 171

drive(userParam)

Drive setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	drive distortion/waveshaper/etc to set

Source:

plugins/setters.cracked.js, line 194

distortion(userParam)

Distortion setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	distortion to set

Source:

plugins/setters.cracked.js, line 216

q(userParam)

q setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	q value to set

Source:

plugins/setters.cracked.js, line 238

pan(userParam)

pan setter convenience method

See more control examples

Parameters:

Name	Type	Description
`userParam`	Number	pan value (1 to -1) to set

Source:

plugins/setters.cracked.js, line 260

Synth

gang_of_oscillators(paramsopt)

gang_of_oscillators

Just a bunch of oscillators

See more synth examples

Parameters:

Name	Type	Attributes	Description
`params`	Object	<optional>	map of optional values

Source:

plugins/synths.cracked.js, line 1

monosynth(paramsopt)

monosynth

Simple monophonic synth

See more synth examples

Parameters:

Name	Type	Attributes	Description
`params`	Object	<optional>	map of optional values

Source:

plugins/synths.cracked.js, line 43

polysynth(paramsopt)

polysynth

Simple polyphonic synth

See more synth examples

Parameters:

Name	Type	Attributes	Description
`params`	Object	<optional>	map of optional values

Source:

plugins/synths.cracked.js, line 167

Utility

play()

Convenient way to say start everything

See more control examples

Source:

plugins/utilities.cracked.js, line 1

scale(position, inMin, inMax, outMin, outMax, type)

Scale an input number between min & max to an output number between a min & max. Supports logarithmic or linear scaling.

Parameters:

Name	Type	Description
`position`	Number
`inMin`	Number
`inMax`	Number
`outMin`	Number
`outMax`	Number
`type`	String

Source:

plugins/utilities.cracked.js, line 18

sec2ms(second)

Converts a second value to millisecond value

Parameters:

Name	Type	Description
`second`	Number

Source:

plugins/utilities.cracked.js, line 49

ms2sec(ms)

Converts a millisecond value to second value

Parameters:

Name	Type	Description
`ms`	Number

Source:

plugins/utilities.cracked.js, line 68

ms2min(ms)

Converts a millisecond value to minute value

Parameters:

Name	Type	Description
`ms`	Number

Source:

plugins/utilities.cracked.js, line 87

min2ms(minute)

Converts a minute value to a millisecond value

Parameters:

Name	Type	Description
`minute`	Number

Source:

plugins/utilities.cracked.js, line 106

isSupported()

Returns a boolean true if the browser supports web audio

Source:

plugins/utilities.cracked.js, line 125

pitch2freq(pitch)

Converts a pitch value to frequency

Parameters:

Name	Type	Description
`pitch`	Number

Source:

plugins/utilities.cracked.js, line 140

freq2pitch(freq)

Converts a frequency to a pitch value

Parameters:

Name	Type	Description
`freq`	Number

Source:

plugins/utilities.cracked.js, line 154

pitch2note(freq)

Converts a midi number to a note value

Parameters:

Name	Type	Description
`freq`	Number

Source:

plugins/utilities.cracked.js, line 168