Skip to main content

Function: defineParametrizedScene()

defineParametrizedScene<P, D>(definition): ParametrizedSceneDefinition<P, D>

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

Define a parametrized scene. This is a typed identity helper: it infers the props and data generics from the definition and returns it unchanged.

Type Parameters​

P​

P extends object

D​

D = unknown

Parameters​

definition​

ParametrizedSceneDefinition<P, D>

The scene definition (defaults, optional schema, optional metadata hook, build function).

Returns​

ParametrizedSceneDefinition<P, D>

The same definition, typed.

Example​

const bar = defineParametrizedScene({
  defaultProps: { label: 'A', value: 1, color: '#58C4DD' },
  calculateMetadata: async ({ props, fetch }) => {
    const data = await fetch(`/api/series/${props.label}`);
    return { data, duration: 3, width: 1920, height: 1080, fps: 60 };
  },
  build: (scene, props, data) => {
    // ...assemble the scene from props + data
  },
});