Tone.Distortion

↳ EXTENDS Tone.Effect

Tone.Distortion is a simple distortion effect using Tone.WaveShaper. Algorithm from a stackoverflow answer.

CONSTRUCTOR

new Tone.Distortion ( [
distortion
] )
distortion

The amount of distortion (nominal range of 0-1)

type: Number or Object
optional

DEFAULTS

{
distortion : 0.4 ,
oversample : none
}

EXAMPLE

var dist = new Tone.Distortion(0.8).toMaster();
var fm = new Tone.SimpleFM().connect(dist);
//this sounds good on bass notes
fm.triggerAttackRelease("A1", "8n");

Members

.distortion

↝ NormalRange #

The amount of distortion.

</>

.oversample

↝ string #

The oversampling of the effect. Can either be “none”, “2x” or “4x”.

</>
↳ 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.Distortion

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