TidalEffect

interface TidalEffect extends AudioEffect { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit key: 'Tidal' slope: number symmetry: number rate: number depth: number offset: number channelOffset: number remove(): void move(index: number): void }

Tremolo and auto-pan

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

readonly

Overrides key

Always "Tidal"

slope: number

Waveform slope (-1.0 to 1.0, default -0.25)

symmetry: number

Waveform symmetry (0.0 to 1.0, default 0.5)

rate: number

Rate in cycles per bar (0 to 16, default 3)

depth: number

Depth (0.0 to 1.0, default 0.75)

offset: number

Phase offset in degrees (-180 to 180, default 0)

channelOffset: number

Phase offset between channels in degrees (-180 to 180, default 0; 180 = auto-pan)

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