Skip to main content

Interface: CalculateMetadataResult<P, D>

Defined in: src/serialization/parametrized.ts:72

What CalculateMetadata returns: optional scene-config overrides, an optional patch of props (which wins over the input props), and the fetched data that reaches SceneBuilder.

Extends​

Type Parameters​

P​

P extends object

D​

D

Properties​

data?​

optional data: D

Defined in: src/serialization/parametrized.ts:76

Data to pass to the build step.

duration?​

optional duration: number

Defined in: src/serialization/parametrized.ts:50

Clip duration in seconds, for downstream export. Carried through as-is.

Inherited from​

SceneMetadata.duration

fps?​

optional fps: number

Defined in: src/serialization/parametrized.ts:56

Target frame rate in fps.

Inherited from​

SceneMetadata.fps

height?​

optional height: number

Defined in: src/serialization/parametrized.ts:54

Render height in pixels.

Inherited from​

SceneMetadata.height

props?​

optional props: Partial<P>

Defined in: src/serialization/parametrized.ts:74

Props to override after the fetch (e.g. values computed from the data).

width?​

optional width: number

Defined in: src/serialization/parametrized.ts:52

Render width in pixels.

Inherited from​

SceneMetadata.width