@remotion/studio

You can install this package from NPM:

Remotion CLI

npx remotion add @remotion/studio

npm

npm i --save-exact @remotion/studio@4.0.417

This assumes you are currently using v4.0.417 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

bun

pnpm i @remotion/studio@4.0.417

This assumes you are currently using v4.0.417 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

pnpm

bun i @remotion/studio@4.0.417

This assumes you are currently using v4.0.417 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

yarn

yarn --exact add @remotion/studio@4.0.417

This assumes you are currently using v4.0.417 of Remotion.
Also update remotion and all `@remotion/*` packages to the same version.
Remove all ^ character in front of the version numbers of it as it can lead to a version conflict.

APIs

The following APIs are available:

getStaticFiles()

Get a list of files in the public folder

watchPublicFolder()

Listen to changes in the public folder

watchStaticFile()

Listen to changes of a static file

writeStaticFile()

Save content to a file in the public directory

saveDefaultProps()

Save default props to the root file

updateDefaultProps()

Update default props in the Props editor

deleteStaticFile()

Delete a file from the public directory

restartStudio()

Restart the Studio Server.

play()

Start playback in the timeline

pause()

Pause playback in the timeline

toggle()

Toggle playback in the timeline

seek()

Jump to a position in the timeline

goToComposition()

Select a composition in the composition selector

focusDefaultPropsPath()

Scrolls to a specific field in the default props editor

reevaluateComposition()

Re-runs calculateMetadata() on the current composition

visualControl()

Create a control in the right sidebar of the Studio