Skip to main content

ProjectSettings

interface ProjectSettings

Properties​

audio​

audio?: string

An url for the audio track to play alongside the animation.

See also

https://motioncanvas.io/docs/media#audio

audioOffset​

audioOffset?: number

Deprecated

Configure the offset in the Video Settings tab of th editor.

experimentalFeatures​

experimentalFeatures?: boolean
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.

Enable experimental features.

See also

https://motioncanvas.io/docs/experimental

logger​

logger?: Logger

A custom logger instance to use.

name​

name?: string

The name of the project.

plugins​

plugins?: stringPlugin[]

A list of plugins to include in the project.

When a string is provided, the plugin will be imported dynamically using the string as the module specifier. This is the preferred way to include editor plugins because it makes sure that the plugin's source code gets excluded from the production build.

scenes​

scenes: FullSceneDescriptionunknown[]

A list of scene descriptions that make up the project.

A full scene description can be obtained by loading a scene module with a ?scene query parameter.

Examples

variables​

variables?: Recordstringunknown

Default values for project variables.

See also

https://motioncanvas.io/docs/project-variables