AutotuneEffect

interface AutotuneEffect extends AudioEffect { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit key: 'Autotune' scaleKey: number scale: number amount: number retune: number shift: number smooth: number remove(): void move(index: number): void }

Pitch correction towards a key and scale

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: 'Autotune'

readonly

Overrides key

Always "Autotune"

scaleKey: number

Key (0-11): C, C#, D, D#, E, F, F#, G, G#, A, A#, B (default 0)

scale: number

Scale (0-7): Chromatic, Major, Minor, Major Pentatonic, Minor Pentatonic, Blues, Dorian, Mixolydian (default 1)

amount: number

Correction amount (0.0 to 1.0, default 1.0)

retune: number

Retune speed (0.0 to 1.0, default 0.5)

shift: number

Pitch shift in semitones (-12 to 12, default 0)

smooth: number

Smoothing (0.0 to 1.0, default 0.6)

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