audio.md

September 12, 2026 ยท View on GitHub

An audio clip: no picture, carries volume. When timing is omitted, the node fits its natural duration (see timing.md).

It draws nothing inside a scene, but on the canvas it is still something to point at: the editor shows its waveform in a box, and x/y/width/height are where that box is. Leave them off inside a scene, where they mean nothing.

<audio src="music/bed.mp3" start={2.2} sourceOut={16} volume={-6} />

Props

PropTypeDefaultMeaning
srcstring | AssetRefrequiredSee media.md.
id, namestringsee elements.mdAddress and label.
x, ynumber0Where the waveform box sits on the canvas. No meaning inside a scene.
width, heightnumber500, 150Size of that box.
start, end, sourceIn, sourceOutTimesee timing.mdTemporal placement.
playbackRatenumber1Speed multiplier for the clip's local time.
volumenumber0Decibels: 0 = unity, negative attenuates (-6 โ‰ˆ half as loud), -Infinity = silence. Not linear.
mutedbooleanfalseExcludes the node's audio from the mix; independent of volume.
syncTostringnoneid of another element carrying audio; derives start by audio alignment (see audio-sync.md). Mutually exclusive with start.

An audio clip has no picture, so it takes no transform beyond its canvas box and no paints. Its children are <keyframeTrack> (a volume track) and <animation>, of which only "gain" is audible:

<audio src="music/bed.mp3" start={0} end={12} volume={-16}>
  <animation type="gain" duration={1} />
  <animation type="gain" phase="out" duration={2} />
</audio>