render
Encodes media or assembles a timeline into fixed delivery presets (web-1080p, vertical, square, audio-only), with optional alpha overlays, burned-in captions, and loudness normalization.
Instructions
Encode a file or assemble a timeline with a fixed delivery preset: web-1080p (16:9), vertical-9x16, square (H.264+AAC, fit-and-pad) or audio-only (AAC .m4a). Optional alpha overlay / HyperFrames layers on top (timed, stacked by zIndex, positioned and sized keeping their aspect; off-frame layers are clamped and reported in warnings). Optional captions (SRT/VTT/cues/transcript) burned in after composition with HyperFrames or the ffmpeg fallback. Timeline clips can be still images (png/jpg/webp, durationSec, contain/cover, Ken Burns). Optional two-pass loudness normalization of the final mix. Returns measured width/height/fps/codecs/bytes, the effective program duration (transition overlaps removed) and loudness before/after.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | No | Source media path (or pass timeline) | |
| layers | No | Several layers (exactly one of overlay/hyperframes each), composited bottom to top; combinable with the legacy overlay/hyperframes params (those become the first layer) | |
| output | Yes | Output file path (.mp4 for video presets, .m4a for audio-only) | |
| preset | Yes | Encode preset | |
| overlay | No | Alpha video (webm VP9 / mov ProRes 4444) composited over the program | |
| captions | No | Captions burned in after composition (times are program seconds). Exactly one of srt/vtt/cues/transcript. Video presets only. The SRT used is written next to the output and picked up by export.package | |
| loudness | No | Two-pass EBU R128 loudnorm of the final mix (pass 1 measures, pass 2 applies the measured values; linear gain when the peak ceiling allows). Off when omitted; pass {} for the defaults (-16 LUFS, -1 dBTP, LRA 11) | |
| timeline | No | Timeline: first video track is the program (clips trimmed by in/out, placed by startSec or back-to-back, joined by transitions); audio tracks are mixed under it | |
| overwrite | No | Replace the output file if it already exists (default false) | |
| hyperframes | No | HyperFrames composition HTML rendered with alpha and composited over the program (needs the optional peer) | |
| layerStartSec | No | Program time where the overlay/HyperFrames layer starts (default 0) | |
| layerDurationSec | No | How long the layer is shown (default: until the layer ends) |