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

.channelCount

Number READONLY #

channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

</>
inherited from Tone.AudioNode

.channelCountMode

String READONLY #

channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is “max”. This attribute has no effect for nodes with no inputs.

</>
inherited from Tone.AudioNode

.channelInterpretation

String READONLY #

channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is “speakers”.

</>
inherited from Tone.AudioNode

.context

Tone.Context READONLY #

Get the audio context belonging to this instance.

</>
inherited from Tone.AudioNode

.numberOfInputs

Number READONLY #

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

</>
inherited from Tone.AudioNode

.numberOfOutputs

Number READONLY #

The number of outputs coming out of the AudioNode.

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

</>

.sync ( )

#
↪ returns Tone.Instrument

this

Sync the instrument to the Transport. All subsequent calls of triggerAttack and triggerRelease will be scheduled along the transport.

EXAMPLE

synth.sync()
//schedule 3 notes when the transport first starts
synth.triggerAttackRelease('8n', 0)
synth.triggerAttackRelease('8n', '8n')
synth.triggerAttackRelease('8n', '4n')
//start the transport to hear the notes
Transport.start()
</>

.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 ( )

#
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();
</>
inherited from Tone.Instrument

.unsync ( )

#
↪ returns Tone.Instrument

this

Unsync the instrument from the Transport

</>
docs generated Jan 11 2019