ConvolverEffect

interface ConvolverEffect extends AudioEffect { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit key: 'Convolver' impulse: Nullable<Sample> wet: number dry: number preDelay: number normalize: boolean reverse: boolean remove(): void move(index: number): void }

Convolution reverb using an impulse response sample

Hierarchy


Properties

uuid: string

readonly

Inherited from uuid

Unique id

label: string

Inherited from label

Custom label

enabled: boolean

Inherited from enabled

Enable or bypass the device

minimized: boolean

Inherited from minimized

Collapse the device editor in the studio

index: number

readonly

Inherited from index

Position in the effect chain (0 = first)

audioUnit: AnyAudioUnit

readonly

Inherited from audioUnit

The audio unit this effect belongs to

key: 'Convolver'

readonly

Overrides key

Always "Convolver"

impulse: Nullable<Sample>

Impulse response sample (null = none)

wet: number

Wet level in dB (default -3)

dry: number

Dry level in dB (default 0)

preDelay: number

Pre-delay in seconds (0.0 to 0.5, default 0.0)

normalize: boolean

Normalize the impulse response (default true)

reverse: boolean

Play the impulse response reversed (default false)

Methods

remove(): void

Inherited from remove

Remove this device from its host

Returns

  • void

move(index: number): void

Inherited from move

Move this effect to another position in its chain

Parameters

  • index (number)

Returns

  • void