mcut
@mcut/timeline

summarizeProject

Generated TypeScript API reference for the public mcut SDK.

mcut SDK


mcut SDK / timeline/src / summarizeProject

Function: summarizeProject()

function summarizeProject(project): string;

Defined in: packages/timeline/src/summarize.ts:46

A compact, deterministic textual rendering of the project in editor vocabulary — what an agent reads before dispatching commands. Tracks are listed top-most first (render order reversed), like a timeline reads.

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 = ...

Returns

string

On this page