openDAW Scripting APIv0.0.87

AudioEffectCompositeEntry

interface AudioEffectCompositeEntry extends AudioEffectHost { uuid: string composite: AudioEffectCompositeEffect | StereoSplitEffect | FrequencySplitEffect index: number gain: number mute: boolean solo: boolean pan: number audioEffects: readonly AnyAudioEffect[] remove(): void addAudioEffect<K extends keyof AudioEffects>(key: K, props?: DeepPartial<AudioEffects[K]>, index?: number): AudioEffects[K] }

One entry (layer) of a parallel effect composite hosting its own effect chain

Hierarchy

Properties

uuid: string

readonly

Unique id

composite: AudioEffectCompositeEffect | StereoSplitEffect | FrequencySplitEffect

readonly

The composite this entry belongs to

index: number

readonly

Position in the composite

gain: number

Entry gain in dB (default 0)

mute: boolean

Mute the entry

solo: boolean

Solo the entry

pan: number

Pan (-1.0 to 1.0, default 0.0)

audioEffects: readonly AnyAudioEffect[]

readonly

Inherited from audioEffects

Audio effects ordered by index

Methods

remove(): void

Remove the entry (only possible on AudioEffectCompositeEffect)

Returns

  • void

addAudioEffect< K extends keyof AudioEffects, >( key: K, props?: DeepPartial<AudioEffects[K]>, index?: number, ): AudioEffects[K]

Inherited from addAudioEffect

Add an audio effect

Type Parameters

Parameters

  • key (K) — Effect type
  • props (DeepPartial<AudioEffects[K]>, optional) — Initial parameter values
  • index (number, optional) — Insert position (default: end of chain)

Returns

Example

CODE
synth.addAudioEffect("Delay", {delay: 13, feedback: 0.4, wet: -9})
const composite = synth.addAudioEffect("Composite")
composite.addEntry({label: "Crushed"}).addAudioEffect("Crusher", {bits: 8})