Chapter 141: getCompositions()

Core Idea

_Part of the @remotion/renderer package.

Key Concepts

• Arguments
• serveUrl
• inputProps
• puppeteerInstance?<AvailableFrom v="3.0.0" />
• browserExecutable?<AvailableFrom v="2.3.1" />
• onBrowserLog?<AvailableFrom v="3.0.0" />
• timeoutInMilliseconds?<AvailableFrom v="2.6.3" />
• port?

Code Examples

const bundled = await bundle({entryPoint: require.resolve('./src/index.ts')});

const compositions = await getCompositions({
  serveUrl: bundled,
  inputProps: {},
});

• What it demonstrates: Usage pattern for getCompositions() from the official docs.

Key Takeaways

1. Understand arguments when working with getCompositions().
2. Understand serveurl when working with getCompositions().
3. Understand inputprops when working with getCompositions().
4. Understand puppeteerinstance?<availablefrom v="3.0.0" /> when working with getCompositions().
5. Understand browserexecutable?<availablefrom v="2.3.1" /> when working with getCompositions().

Connects To

• Chromium Flags: related page in the Rendering & SSR section.
• Compare ssr: related page in the Rendering & SSR section.
• Dataset Render: related page in the Rendering & SSR section.