SinkEffect

interface SinkEffect extends AudioEffect {
uuid: string
label: string
enabled: boolean
minimized: boolean
index: number
audioUnit: AnyAudioUnit
key: 'Sink'
target: Nullable<AuxAudioUnit | GroupAudioUnit>
pass: number
remove(): void
move(index: number): void
}

Routes the signal at its chain position into a group or auxiliary bus (a 1:1 cable, unity into the bus). pass is the level the chain continues at: -inf (default) means the unit sounds only through the bus, 0 dB keeps a full copy on the chain. No target, or a disabled sink, sends nothing.

See:
- AudioEffects.Sink

Hierarchy

AudioEffect
SinkEffect

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

readonly

Overrides key

Always "Sink"

`target: Nullable<AuxAudioUnit | GroupAudioUnit>`

The bus receiving the signal, null = nothing is sent

See:
- AuxAudioUnit
- GroupAudioUnit

`pass: number`

Level the signal continues down the chain at, in dB (-inf to 0, default -inf)

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