LfoModulator

interface LfoModulator extends Modulator {
uuid: string
label: string
enabled: boolean
index: number
bipolar: boolean
amount: number
modulations: readonly Modulation[]
valueTracks: readonly ValueTrack[]
kind: 'LFO'
shape: 0 | 1 | 2 | 3 | 4
rateSync: number
rateAbsolute: number
phase: number
exponent: number
addValueTrack<T extends AnyModulator | Modulation>(target: T, parameter: ParameterPath<T>, props?: Partial<Pick<Track, 'enabled'>>): ValueTrack
assign<T extends Automatable>(target: T, parameter: ParameterPath<T>, depth?: number): Modulation
remove(): void
}

Low frequency oscillator

See:
- Modulators.LFO

Hierarchy

Modulator
LfoModulator

Properties

`uuid: string`

readonly

Inherited from uuid

Unique id

`label: string`

Inherited from label

Custom label

`enabled: boolean`

Inherited from enabled

Enable the modulator

`index: number`

readonly

Inherited from index

Order in the modulator list

`bipolar: boolean`

Inherited from bipolar

Bipolar output (-1 to 1) instead of unipolar (0 to 1) (default true)

`amount: number`

Inherited from amount

Output amount (0.0 to 1.0, default 1.0)

`modulations: readonly Modulation[]`

readonly

Inherited from modulations

All assignments

`valueTracks: readonly ValueTrack[]`

readonly

Inherited from valueTracks

Automation lanes of this modulator's own parameters and assignment depths

`kind: 'LFO'`

readonly

Overrides kind

Always "LFO"

`shape: 0 | 1 | 2 | 3 | 4`

Shape (0-4): Sine, Triangle, Saw up, Saw down, Square

`rateSync: number`

Synced rate index (0 = free running, 1-12): 8 bars, 4 bars, 2 bars, 1 bar, 1/2, 1/4, 1/6, 1/8, 1/12, 1/16, 1/24, 1/32 (default 4)

`rateAbsolute: number`

Free running rate in Hz (0 to 10, used when rateSync is 0)

`phase: number`

Phase offset (0.0 to 1.0)

`exponent: number`

Curve exponent (-1.0 to 1.0)

Methods

`addValueTrack< T extends AnyModulator | Modulation, >( target: T, parameter: ParameterPath<T>, props?: Partial<Pick<Track, 'enabled'>>, ): ValueTrack`

Inherited from addValueTrack

Add an automation lane for one of this modulator's parameters or an assignment depth

Type Parameters

T extends AnyModulator | Modulation

Parameters

target (T) — This modulator or one of its modulations
parameter (ParameterPath<T>) — Parameter path, e.g. "rateAbsolute" or "depth"
props (Partial<Pick<Track, "enabled">>, optional)

Returns

ValueTrack

`assign< T extends Automatable, >( target: T, parameter: ParameterPath<T>, depth?: number, ): Modulation`

Inherited from assign

Assign this modulator to a parameter

Type Parameters

T extends Automatable

Parameters

target (T) — Any modulatable object (a device, a unit, ...)
parameter (ParameterPath<T>) — Parameter path, e.g. "cutoff"
depth (number, optional) — Modulation depth (-1.0 to 1.0, default 0.25)

Returns

Modulation

Example

CODE

const lfo = project.addModulator("LFO", {rateSync: 6})
lfo.assign(synth.instrument, "cutoff", 0.5)

`remove(): void`

Inherited from remove

Remove this modulator including its assignments

Returns

void