Tone.NoiseSynth

↳ EXTENDS Tone.Instrument

Tone.NoiseSynth is composed of a noise generator (Tone.Noise), one filter (Tone.Filter), and two envelopes (Tone.Envelop). One envelope controls the amplitude of the noise and the other is controls the cutoff frequency of the filter.

CONSTRUCTOR

new Tone.NoiseSynth ( [
options
] )
options

the options available for the synth see defaults below

type: Object
optional

DEFAULTS

{
noise :
{
type : white
}
,
envelope :
{
attack : 0.005 ,
decay : 0.1 ,
sustain : 0
}
}

EXAMPLE

var noiseSynth = new Tone.NoiseSynth().toMaster();
noiseSynth.triggerAttackRelease("8n");

Members

.envelope

↝ Tone.AmplitudeEnvelope #

The amplitude envelope.

</>

.noise

↝ Tone.Noise #

The noise source.

EXAMPLE

noiseSynth.set("noise.type", "brown");
</>
↳ inherited from Tone.AudioNode

.context

↝ Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
↳ inherited from Tone.Instrument
∿

.volume

↝ Decibels #

The volume of the output in decibels.

EXAMPLE

source.volume.value = -6;
</>

Methods

.dispose ( )

#
↪ returns Tone.NoiseSynth

this

Clean up.

</>

.triggerAttack ( )

#
time

the time the attack should start

type: Time
default: now
velocity

the velocity of the note (0-1)

type: number
default: 1
↪ returns Tone.NoiseSynth

this

Start the attack portion of the envelopes. Unlike other instruments, Tone.NoiseSynth doesn’t have a note.

EXAMPLE

noiseSynth.triggerAttack();
</>

.triggerAttackRelease ( )

#
duration

the duration of the note

type: Time
time

the time of the attack

type: Time
default: now
velocity

the velocity

type: number
default: 1
↪ returns Tone.NoiseSynth

this

Trigger the attack and then the release.

</>

.triggerRelease ( )

#
time

the time the release should start

type: Time
default: now
↪ returns Tone.NoiseSynth

this

Start the release portion of the envelopes.

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