Skip to main content

Interface: ProjectJSON

Table of contents​

Properties​

Properties​

watermark​

• Optional watermark: WatermarkJSON

Defined in​

types.ts:92

backgroundColor​

• Optional backgroundColor: string

Defined in​

types.ts:93

metadata​

• Optional metadata: ProjectMetadata

Defined in​

types.ts:94

assets​

• Optional assets: Record<string, ProjectAssetJSON>

Optional portable asset manifest for this project.

  • Keys are assetIds referenced from element props (e.g. VideoProps.srcAssetId).
  • Values are lightweight asset descriptors that allow projects to be moved between environments while still rendering correctly, even if the host does not have a separate asset library backing store.

Renderers and editors SHOULD gracefully handle the case where this is undefined (legacy projects) or partially populated.

Defined in​

types.ts:106

tracks​

• tracks: TrackJSON[]

Defined in​

types.ts:107

version​

• version: number

Defined in​

types.ts:108