AudioEffectCompositeEffect
interface AudioEffectCompositeEffect extends AudioEffect {
uuid: string
label: string
enabled: boolean
minimized: boolean
index: number
audioUnit: AnyAudioUnit
key: 'Composite'
dry: number
wet: number
entries: readonly AudioEffectCompositeEntry[]
remove(): void
move(index: number): void
addEntry(props?: Partial<Pick<AudioEffectCompositeEntry, 'pan' | 'gain' | 'mute' | 'solo'>>): AudioEffectCompositeEntry
}Runs several effect chains in parallel and mixes them back
Hierarchy
AudioEffectAudioEffectCompositeEffect
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: 'Composite'
readonly
Overrides key
Always "Composite"
dry: number
Dry level in dB (default -inf)
wet: number
Wet level in dB (default 0)
entries: readonly AudioEffectCompositeEntry[]
readonly
All entries ordered by index
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
addEntry(
props?: Partial<Pick<AudioEffectCompositeEntry, 'pan' | 'gain' | 'mute' | 'solo'>>,
): AudioEffectCompositeEntry
Add a parallel entry
Parameters
props(Partial<Pick<AudioEffectCompositeEntry, "pan" | "gain" | "mute" | "solo">>, optional)
Returns