mcut
@mcut/timeline

getRenderableElements

Generated TypeScript API reference for the public mcut SDK.

mcut SDK


mcut SDK / timeline/src / getRenderableElements

Function: getRenderableElements()

function getRenderableElements(project, timeMs): RenderableElement[];

Defined in: packages/timeline/src/transitions.ts:129

Every element that needs pixels at timeMs — the active set plus transition partners outside their own ranges. Render paths (compositor, export prepare, preview pool) must all enumerate through this so they agree on what is on screen.

Parameters

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

Returns

RenderableElement[]

On this page