AudioGraphParamsUpdate interface

A runtime parameter update for AudioGraphNode.setParams(). Fields are op-friendly (mapped to the engine’s parameter names internally); only those the target node supports take effect. Grows as ops gain runtime parameters.

Signature:

export interface AudioGraphParamsUpdate

Properties

Property Type Description

attackMs?

number

(Optional) New attack time in ms — for a compressor / limiter node.

autoMakeup?

boolean

(Optional) Auto makeup-gain on/off — for a compressor node.

autoRelease?

boolean

(Optional) Program-dependent (auto) release on/off — for a compressor node.

bypass?

boolean

(Optional) Bypass this node — it passes its input straight through with no processing (a live, click-free effect bypass for any 1-in/1-out op: compressor, EQ, limiter, AGC, gain, gap-conceal). No graph rebuild.

ceilingDb?

number

(Optional) New ceiling in dBFS — for a limiter node.

cutoffHz?

number

(Optional) New corner/centre frequency in Hz — for a biquad node (live retune).

db?

number

(Optional) New gain in dB — for a gain node.

detector?

"peak" | "rms"

(Optional) Detector mode — for a compressor node ("peak" | "rms").

device?

string

(Optional) Output device name — for a monitor node (empty = default device).

downDbPerS?

number

(Optional) New downward slew rate in dB/s — for an agc node.

driveDb?

number

(Optional) Input drive in dB — for a limiter node.

enabled?

boolean

(Optional) Enable/disable playback — for a monitor node.

eqBands?

{ cutoffHz?: number; q?: number; gainDb?: number; }[]

(Optional) Per-band tuning — for an eq node (entry i tunes band i).

gainsDb?

number[]

(Optional) New per-channel gains in dB — for a channelGain node (entry i tunes channel i).

gapMs?

number

(Optional) New gap length in ms — for a gapInject audition node.

gateLufs?

number

(Optional) New adaptation gate in LUFS — for an agc node.

kneeDb?

number

(Optional) New knee width in dB — for a compressor node.

makeupDb?

number

(Optional) New makeup gain in dB — for a compressor node (honours transition).

maxGainDb?

number

(Optional) New maximum gain in dB — for an agc node.

minGainDb?

number

(Optional) New minimum gain in dB — for an agc node.

muted?

boolean

(Optional) Mute / unmute — for a mute node (ramped, click-free).

periodMs?

number

(Optional) New gap period in ms — for a gapInject audition node.

q?

number

(Optional) New filter Q — for a biquad node.

ratio?

number

(Optional) New ratio — for a compressor node.

releaseMs?

number

(Optional) New release time in ms — for a compressor / limiter node.

resetIntegrated?

boolean

(Optional) Restart the integrated-loudness measurement — for a loudness tap (the "start metering at the top of the programme" control).

rmsMs?

number

(Optional) RMS averaging window in ms — for a compressor node.

sidechainHpHz?

number

(Optional) Sidechain high-pass on the detector (Hz; 0 = off) — for a compressor node.

targetLufs?

number

(Optional) New target loudness in LUFS — for an agc node.

thresholdDb?

number

(Optional) New threshold in dBFS — for a compressor node.

transition?

PartTransition

(Optional) Optional ramp so the change is click-free.

upDbPerS?

number

(Optional) New upward slew rate in dB/s — for an agc node.

volume?

number

(Optional) Output level (linear, 1 = unity) — for a monitor node.

weights?

number[]

(Optional) New linear input weights — for a mix node (entry i tunes input i).