Tone.BitCrusher

↳ EXTENDS Tone.Effect

Tone.Bitcrusher downsamples the incoming signal to a different bitdepth. Lowering the bitdepth of the signal creates distortion. Read more about Bitcrushing on Wikipedia.

CONSTRUCTOR

new Tone.BitCrusher (
bits
)
bits

The number of bits to downsample the signal. Nominal range of 1 to 8.

type: Number

DEFAULTS

{
bits : 4
}

EXAMPLE

//initialize crusher and route a synth through it
var crusher = new Tone.BitCrusher(4).toMaster();
var synth = new Tone.MonoSynth().connect(crusher);

Members

.bits

↝ number #

The bit depth of the effect. Nominal range of 1-8.

</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.Effect
∿

.wet

↝ NormalRange #

The wet control is how much of the effected will pass through to the output. 1 = 100% effected signal, 0 = 100% dry signal.

</>

Methods

.dispose ( )

#
↪ returns Tone.BitCrusher

this

Clean up.

</>
↳ inherited from Tone.AudioNode

.connect ( )

#
unit
outputNum

optionally which output to connect from

type: number
default: 0
inputNum

optionally which input to connect to

type: number
default: 0
↪ returns Tone.AudioNode

this

connect the output of a ToneNode to an AudioParam, AudioNode, or ToneNode

</>
↳ inherited from Tone.AudioNode

.disconnect ( )

#
output

Either the output index to disconnect if the output is an array, or the node to disconnect from.
↪ returns Tone.AudioNode

this

disconnect the output

</>
↳ inherited from Tone.AudioNode

.toMaster ( )

#
↪ returns Tone.AudioNode

this

Connect ‘this’ to the master output. Shorthand for this.connect(Tone.Master)

EXAMPLE

//connect an oscillator to the master output
var osc = new Tone.Oscillator().toMaster();
</>
docs generated Sep 15 2019