Skip to content

Audio

This content is for v0.4. Switch to the latest version for up-to-date documentation.

Generated from project.v1.schema.json at the documented engine version. The schema checks shape only; the engine’s validation also checks ranges, limits, references and keyframe order.

AudioEffect

A serializable single-input audio effect applied to a clip or track bus.

Sidechain ducking is not an entry here because it consumes a second input. It is authored per track through Ducking.

One of:

type: "eq"

Cascaded biquad sections.

FieldTypeDescription
bandsrequiredEqBand[]

Ordered filter sections, 1 to MAX_EQ_BANDS of them.

type: "compressor"

Lookahead dynamic range compression.

FieldTypeDescription
attack_msrequirednumber (float)

Attack time in milliseconds, positive and at most MAX_ENVELOPE_MS.

lookahead_msnumber (float)

Lookahead in milliseconds, at most MAX_LOOKAHEAD_MS. Reported as graph latency.

Default: 0

ratiorequirednumber (float)

Downward ratio, from one (unity) to MAX_COMPRESSOR_RATIO.

release_msrequirednumber (float)

Release time in milliseconds, positive and at most MAX_ENVELOPE_MS.

threshold_dbrequirednumber (float)

Level above which gain reduction begins, in decibels from MIN_LEVEL_DB to 0.

type: "reverb"

Schroeder reverberation.

FieldTypeDescription
dampingrequirednumber (float)

High-frequency damping, in 0..=1.

mixrequirednumber (float)

Wet mix, in 0..=1.

room_sizerequirednumber (float)

Room size, in 0..=1.

AudioProperties

Per-clip audio presentation controls.

FieldTypeDescription
effectsAudioEffect[]

Ordered single-input effects applied before the track bus, at most MAX_CHAIN_EFFECTS.

Default: []

fade_inMediaTime

Fade-in duration measured from the clip's timeline start. Non-negative.

Default: 0

fade_outMediaTime

Fade-out duration measured back from the clip's timeline end. Non-negative.

Default: 0

fade_shapeFadeShape

Curve used by both fades.

Default: "linear"

gainAnimated_float

Animated linear amplitude constrained to 0..=MAX_GAIN.

Default: {"mode":"constant","value":1}

mutedboolean

Silences this clip without removing it.

Default: false

panAnimated_float

Animated stereo position from -1 (left) to 1 (right).

Default: {"mode":"constant","value":0}

AudioStreamShape

An audio stream's channel count and sample rate.

FieldTypeDescription
channelsrequiredinteger (uint32)

Channel count.

sample_raterequiredinteger (uint32)

Samples per second per channel.

Ducking

Sidechain ducking authored on the track that is attenuated.

FieldTypeDescription
attack_msrequirednumber (float)

Attack time in milliseconds, positive and at most MAX_ENVELOPE_MS.

depth_dbrequirednumber (float)

Maximum attenuation in decibels, from MIN_LEVEL_DB to 0.

release_msrequirednumber (float)

Release time in milliseconds, positive and at most MAX_ENVELOPE_MS.

sidechain_trackrequiredTrackId

Track whose mixed output drives the envelope follower.

thresholdrequirednumber (float)

Linear level above which attenuation begins. Positive.

EqBand

A single equalizer section stored independently from its DSP implementation.

FieldTypeDescription
frequency_hzrequirednumber (float)

Center or corner frequency in hertz, within EQ_FREQUENCY_RANGE_HZ.

gain_dbnumber (float)

Peaking gain in decibels, at most MAX_EQ_GAIN_DB either way. Ignored by the pass filters.

Default: 0

kindrequiredEqBandKind

Filter shape.

qrequirednumber (float)

Resonance, within EQ_Q_RANGE. Larger values produce narrower bands.

EqBandKind

The filter shape of one equalizer band.

  • "peaking" Bell-shaped parametric band.
  • "low_pass" Second-order low-pass.
  • "high_pass" Second-order high-pass.

FadeShape

Curve applied by a clip's fade in and fade out.

  • "linear" Amplitude moves linearly. Two linear fades over one overlap dip by 6 dB.
  • "equal_power" Amplitude follows a quarter sine. Two of these crossfade at constant power, which is what overlapping clips normally want.

Limiter

Final peak limiter placed at the end of the master bus.

FieldTypeDescription
release_msrequirednumber (float)

Release time in milliseconds, positive and at most MAX_ENVELOPE_MS.

thresholdrequirednumber (float)

Linear ceiling, positive and at most MAX_GAIN. One is full scale.

MasterAudio

Project-wide master bus settings.

FieldTypeDescription
effectsAudioEffect[]

Ordered single-input effects applied to the summed track buses, at most MAX_CHAIN_EFFECTS.

Default: []

gainAnimated_float

Animated linear master amplitude constrained to 0..=MAX_GAIN.

Default: {"mode":"constant","value":1}

limiterLimiter | null

Final peak limiter. An omitted field is default; an explicit null leaves the mix unlimited.

Default: {"release_ms":50,"threshold":1}

TrackAudio

Per-track audio bus controls.

FieldTypeDescription
duckingDucking | null

Optional sidechain attenuation driven by another track.

Default: null

effectsAudioEffect[]

Ordered single-input effects applied to the summed clip signal, at most MAX_CHAIN_EFFECTS.

Default: []

gainAnimated_float

Animated linear bus amplitude constrained to 0..=MAX_GAIN.

Default: {"mode":"constant","value":1}

mutedboolean

Silences this bus.

Default: false

panAnimated_float

Animated stereo position applied after the clip mix, from -1 (left) to 1 (right).

Default: {"mode":"constant","value":0}

soloboolean

Restricts the mix to soloed buses when any track sets this.

Default: false