@revideo/core / plugin / Plugin
Interface: Plugin
Defined in: plugin/Plugin.ts:7
Represents a runtime Motion Canvas plugin.
Properties
name
name:
string
Defined in: plugin/Plugin.ts:22
A unique name of the plugin.
Remarks
The name should be unique across the entire ecosystem of Motion Canvas. If a plugin with the same name has already been registered, this plugin will be ignored.
If you intend to publish your plugin to npm, it is recommended to prefix this name with the name of your npm package.
Other identifiers defined by the plugin, such as a tab id, will be automatically prefixed with this name and as such don’t have to be unique.
Methods
exporters()?
optionalexporters(project):ExporterClass[]
Defined in: plugin/Plugin.ts:57
Provide custom exporters for the project.
Parameters
project
The project instance.
Returns
player()?
optionalplayer(player):void
Defined in: plugin/Plugin.ts:43
Receive the player instance right after it is initialized.
Parameters
player
The player instance.
Returns
void
project()?
optionalproject(project):void
Defined in: plugin/Plugin.ts:36
Receive the project instance right after it is initialized.
Parameters
project
The project instance.
Returns
void
renderer()?
optionalrenderer(renderer):void
Defined in: plugin/Plugin.ts:50
Receive the renderer instance right after it is initialized.
Parameters
renderer
The renderer instance.
Returns
void
settings()?
optionalsettings(settings):void|UserProject
Defined in: plugin/Plugin.ts:29
Modify the project settings before the project is initialized.
Parameters
settings
The project settings.
Returns
void | UserProject