Skip to main content

remotion

A package containing the essential building blocks of expressing videos in Remotion.

Some pure functions such as interpolate() and interpolateColors() can also be used outside of Remotion.

Installation​

npm i remotion

API​

The following functions and components are exposed:

<AbsoluteFill>
Position content absolutely and in full size
<AnimatedImage>
Display a GIF, AVIF or animated WebP image
<Artifact>
Emit an extra file during rendering
calculateMetadata()
Transform the metadata of a composition
cancelRender()
Abort an error
<CanvasImage>
Render an image into a canvas and apply effects
<Composition>
Define a video
continueRender()
Unblock a render
createEffect()
Create custom effects for canvas components
createEffectImplementation()
Type the state of one backend implementation of an effect
delayRender()
Block a render from continuing
Easing
Customize animation curve of interpolate()
<Folder>
Organize compositions in the Studio sidebar
<Freeze>
Freeze some content in time
getInputProps()
Receive the user-defined input data
getRemotionEnvironment()
Determine if you are currently previewing or rendering
getStaticFiles()
Get all files in the public/ folder
<Html5Audio>
Synchronize <audio> with Remotion's time
<Html5Video>
Synchronize a <video> with Remotion's time
<HtmlInCanvas>
Draw DOM content into a canvas via HTML-in-canvas
<IFrame>
Render an <iframe> tag and wait for it to load
<Img>
Render an <img> tag and wait for it to load
Interactive.create()
Add timing and Studio controls to a component
InteractivitySchema
Define timeline controls for components and effects
interpolate()
Map a range of values to another
interpolateColors()
Map a range of values to colors
<Loop>
Play some content repeatedly
measureSpring()
Determine the duration of a spring
<OffthreadVideo>
Alternative to <Html5Video>
prefetch()
Fetch an asset and keep it in memory
random()
Get deterministic pseudorandom values
registerRoot()
Initialize a Remotion project
<Sequence>
Time-shifts it's children
<Series>
Display contents after another
<Solid>
Render a solid-color rectangle on a canvas
spring()
Physics-based animation primitive
staticFile()
Access file from public/ folder
<Still>
Define a still
<Track>
Group clips on one Studio timeline row
useBufferState()
Inform the Player that your component is loading data
useCurrentFrame()
Obtain the current time
useCurrentScale()
Get the scale factor of the canvas
useDelayRender()
Scoped delayRender(), continueRender() and cancelRender()
usePixelDensity()
Get the pixel density factor of the current render or preview
useRemotionEnvironment()
Get information about the current Remotion environment
useVideoConfig()
Get the duration, dimensions and FPS of a composition
VERSION
Get the current version of Remotion
watchStaticFile()
Get notified when a static file changes

License​

Remotion License