Back to Remotion

play()

packages/docs/docs/studio/play.mdx

4.0.467953 B
Original Source

play()<AvailableFrom v="4.0.287"/>

Starts playback in the Remotion Studio.

The function accepts an optional event parameter which can be a React.SyntheticEvent or a PointerEvent. This allows the function to be used directly as an event handler.

Examples

tsx
import {play} from '@remotion/studio';

const PlayButton = () => {
  // Call with the event parameter for better browser audio autoplay
  return <button onClick={(e) => play(e)}>Play</button>;
};
tsx
import {play} from '@remotion/studio';

// Call without event parameter
play();

See also