VocoderEffect

interface VocoderEffect extends AudioEffect, SideChainable { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit sideChain: Nullable<SideChainSource> key: 'Vocoder' carrierMinFreq: number carrierMaxFreq: number modulatorMinFreq: number modulatorMaxFreq: number qStart: number qEnd: number envAttack: number envRelease: number gain: number mix: number bandCount: 8 | 12 | 16 modulatorSource: 'noise-pink' | 'noise-white' | 'input' remove(): void move(index: number): void }

Classic analysis/synthesis vocoder

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

sideChain: Nullable<SideChainSource>

Inherited from sideChain

External detection source (null = the effect listens to its own input)

key: 'Vocoder'

readonly

Overrides key

Always "Vocoder"

carrierMinFreq: number

Lowest carrier band in Hz (20 to 20000, default 100)

carrierMaxFreq: number

Highest carrier band in Hz (20 to 20000, default 12000)

modulatorMinFreq: number

Lowest modulator band in Hz (20 to 20000, default 100)

modulatorMaxFreq: number

Highest modulator band in Hz (20 to 20000, default 12000)

qStart: number

Filter Q at the lowest band (1 to 60, default 20)

qEnd: number

Filter Q at the highest band (1 to 60, default 2)

envAttack: number

Envelope attack in ms (0.1 to 100, default 5)

envRelease: number

Envelope release in ms (1 to 1000, default 30)

gain: number

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

mix: number

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

bandCount: 8 | 12 | 16

Number of bands (8, 12 or 16, default 16)

modulatorSource: 'noise-pink' | 'noise-white' | 'input'

Modulator source when no sidechain is set (default "noise-pink")

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