mcut SDK

mcut SDK / timeline/src / parseProject

Function: parseProject()

function parseProject(data): object;

Defined in: packages/timeline/src/model.ts:723

Parse and validate an untrusted project payload (e.g. persisted JSON), migrating documents written by older releases up to the current format. Throws ProjectFormatError for documents from a newer mcut.

Parameters

data

unknown

Returns

assets

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

fps: number;

height

height: number;

id

id: string;

layouts

layouts: object[];

Multicam layout templates this project references. See layouts.ts.

markers

markers: object[];

Timeline markers, sorted by timeMs (the commands keep them sorted).

name

name: string;

presets

presets: object[];

Named inspector value bundles (style presets). See presets.ts.

tracks

tracks: object[];

Render order: index 0 is painted first (bottom); last is topmost.

version

version: 1;

Project format version (see migrations.ts). parseProject migrates older documents before validating; the default covers in-memory creation.

width

width: number;