Skip to main content

play()v4.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​

Start playing on button click
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>;
};
Start playing programmatically
tsx
import {play} from '@remotion/studio';
 
// Call without event parameter
play();

See also​