Skip to main content

Module audio

Module audio 

Source
Expand description

Stateless audio sources and immutable timeline occurrence metadata.

Structs§

AudioBus
Named submix processed before the master. At most sixteen buses are admitted.
AudioChapter
Container chapter in the same integer tick clock as the timeline.
AudioClip
tick-authored audio occurrence, separate from the retained root AudioClip.
AudioClipParameters
Immutable placement and envelope inputs consumed by audio mixers.
AudioMetadata
Optional media tags and chapters; empty metadata writes none.
Duck
Sidechain ducking parameters. The trigger’s peak-hold envelope is converted to a gain reduction in dB, smoothed by attack/release and applied to the ducked signal.
Ducking
A sidechain ducking assignment.
Limiter
Offline peak limiter parameters. The release is a finite linear gain recovery.
Loudness
EBU R128 target and reconstructed peak ceiling for static normalization.
Master
Optional master processing; the default leaves the mix unchanged.

Enums§

DuckTrigger
Signal that drives a Duck.
PanLaw
Stereo balance law. Mono panning always uses constant power.

Traits§

AudioEffect
A deterministic offline effect. Mixers process from the occurrence origin once, retain the result, then serve exact random-access windows without IIR warmup errors.
AudioSource
A pure, concurrent random-access interleaved PCM source. Repeated reads must not depend on prior requests. Implementations return frames, never samples; EOF/short reads leave the rest of the caller’s buffer silent.

Functions§

ceil_frames
Converts a duration to the smallest covering number of audio frames. Integer arithmetic avoids floating-point endpoint drift.
frames
Converts ticks to the nearest audio frame, with half ties upward. A zero sampling rate produces zero frames.