Skip to main content

scenes

import {...} from "@motion-canvas/core/lib/scenes";

Abstract scene representations and related utilities.

Enumerations​

Classes​

Interfaces​

Type Aliases​

DescriptionOf​

type DescriptionOfTScene = TScene extends Sceneinfer TConfig ? SceneDescriptionTConfig : never

Type Parameters

InspectedAttributes​

type InspectedAttributes = stack?: string

Represents attributes of an inspected element.

InspectedElement​

type InspectedElement = unknown

Represents an element to inspect.

The type is not important because the UI does not interact with it. It serves as a key that will be passed back to an Inspectable scene to receive more information about said element.

SceneMetadata​

type SceneMetadata = ReturnTypetypeof createSceneMetadata

A runtime representation of the scene metadata.

Functions​

createSceneMetadata​

public createSceneMetadata(): ObjectMetaFieldseed: MetaFieldanynumber = ...timeEvents: MetaFieldSerializedTimeEvent[]SerializedTimeEvent[] = ...version: MetaFieldanynumber = ...

Create a runtime representation of the scene metadata.

isInspectable​

public isInspectablevalue: any: value is Inspectable

Parameters

isThreadable​

public isThreadablevalue: any: value is Threadable

Parameters

sound​

public soundaudio: stringSoundBuilder: SoundBuilder

Begin configuring a sound to be played back.

Parameters