Tone.PluckSynth

↳ EXTENDS Tone.Instrument

Karplus-String string synthesis. Often out of tune. Will change when the AudioWorkerNode is available across browsers.

CONSTRUCTOR

new Tone.PluckSynth ( [
options
] )
options

see the defaults

type: Object
optional

DEFAULTS

{
attackNoise : 1 ,
dampening : 4000 ,
resonance : 0.9
}

EXAMPLE

var plucky = new Tone.PluckSynth().toMaster();
plucky.triggerAttack("C4");

Members

.attackNoise

number #

The amount of noise at the attack. Nominal range of [0.1, 20]

</>

.dampening

Frequency #

The dampening control. i.e. the lowpass filter frequency of the comb filter

</>

.resonance

NormalRange #

The resonance control.

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

this

Clean up.

</>

.triggerAttack ( )

#
note

The note to trigger.

time

When the note should be triggered.

type: Time
default: now
↪ returns Tone.PluckSynth

this

Trigger the note.

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

.triggerAttackRelease ( )

#
note

The note to trigger.

duration

How long the note should be held for before triggering the release. This value must be greater than 0.

type: Time
time

When the note should be triggered.

type: Time
default: now
velocity

The velocity the note should be triggered at.

default: 1
↪ returns Tone.Instrument

this

Trigger the attack and then the release after the duration.

EXAMPLE

//trigger "C4" for the duration of an 8th note
synth.triggerAttackRelease("C4", "8n");
</>
docs generated Sep 15 2019