WaveshaperEffect

interface WaveshaperEffect extends AudioEffect {
uuid: string
label: string
enabled: boolean
minimized: boolean
index: number
audioUnit: AnyAudioUnit
key: 'Waveshaper'
equation: string
inputGain: number
outputGain: number
mix: number
remove(): void
move(index: number): void
}

Nonlinear waveshaping distortion

See:
- AudioEffects.Waveshaper

Hierarchy

AudioEffect
WaveshaperEffect

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: 'Waveshaper'`

readonly

Overrides key

Always "Waveshaper"

`equation: string`

Transfer function preset name or custom equation (default "hardclip")

`inputGain: number`

Input gain in dB (0 to 40, default 0)

`outputGain: number`

Output gain in dB (-24 to 24, default 0)

`mix: number`

Dry/wet mix (0.0 to 1.0, default 1.0)

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