Skip to main content

getInputProps()

Available from v2.0.

Using this method, you can retrieve inputs that you pass in from the command line using --props, or the inputProps parameter if you are using the Node.JS API.

You should whenever possible prefer to retrieve props directly in your composition, like you would read props from a component if you were to code a React application, but this method is useful if you want to retrieve the input props outside of a composition.

info

This method is not available when inside a Remotion Player. Instead, get the props as React props from the component you passed as the component prop to the player.

API​

Pass in a parseable JSON representation using the --props flag to either remotion studio or remotion render:

bash
npx remotion render --props='{"hello": "world"}'
bash
npx remotion render --props='{"hello": "world"}'

To simulate how it behaves, you can also pass props when using the Remotion Studio:

bash
npx remotion studio --props='{"hello": "world"}'
bash
npx remotion studio --props='{"hello": "world"}'

You may also specify a file containing JSON and Remotion will parse the file for you:

bash
npx remotion render --props=./path/to/props.json
bash
npx remotion render --props=./path/to/props.json

You can then access the props in JavaScript:

tsx
const { hello } = getInputProps(); // "world"
tsx
const { hello } = getInputProps(); // "world"

In this example, the props also get passed to the component of the composition with the id my-composition.

See also​