Tone.Convolver

↳ EXTENDS Tone.Effect

Tone.Convolver is a wrapper around the Native Web Audio ConvolverNode. Convolution is useful for reverb and filter emulation. Read more about convolution reverb on Wikipedia.

CONSTRUCTOR

new Tone.Convolver ( [
url
] ,
onload
)
url

The URL of the impulse response or the Tone.Buffer contianing the impulse response.

type: string or Tone.Buffer or Object
optional
onload

The callback to invoke when the url is loaded.

type: function

DEFAULTS

{
onload : Tone.noOp
}

EXAMPLE

//initializing the convolver with an impulse response
var convolver = new Tone.Convolver("./path/to/ir.wav").toMaster();

Members

.buffer

AudioBuffer #

The convolver’s buffer

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

this

Clean up.

</>

.load ( )

#
url

The url of the buffer to load. filetype support depends on the browser.

type: string
callback
optional
↪ returns Promise

Load an impulse response url as an audio buffer. Decodes the audio asynchronously and invokes the callback once the audio buffer loads.

</>
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();
</>
docs generated May 15 2019