renderFrameWith
Generated TypeScript API reference for the public mcut SDK.
mcut SDK / compositor/src / renderFrameWith
Function: renderFrameWith()
function renderFrameWith(
backend,
project,
timeMs,
options?): void;Defined in: packages/compositor/src/render-frame.ts:44
Render one frame through an explicit RenderBackend. The track/element walk, transition pairing, and animation resolution here are backend-agnostic; only the draws differ.
Tracks render bottom-up (index 0 first), elements in start order. Clips joined by a transition render through the blend instead of the normal pass while the window (centered on their cut) is active.
Parameters
backend
project
assets
Record<string, {
durationMs?: number;
hash?: string;
height?: number;
id: `a-${string}`;
kind: "video" | "audio" | "image";
mimeType?: string;
name?: string;
nativePreview?: boolean;
src: string;
width?: number;
}> = ...
fps
number = ...
height
number = ...
id
string = ...
layouts
object[] = ...
Multicam layout templates this project references. See layouts.ts.
markers
object[] = ...
Timeline markers, sorted by timeMs (the commands keep them sorted).
name
string = ...
presets
object[] = ...
Named inspector value bundles (style presets). See presets.ts.
tracks
object[] = ...
Render order: index 0 is painted first (bottom); last is topmost.
version
1 = ...
Project format version (see migrations.ts). parseProject migrates
older documents before validating; the default covers in-memory creation.
width
number = ...
timeMs
number
options?
RenderFrameOptions = {}
Returns
void