Skip to main content

shutDownStudio()v4.0.521

Gracefully shuts down the Remotion Studio server. Start Studio again from your terminal to reconnect.

ShutDownButton.tsx
import { shutDownStudio } from "@remotion/studio";

export const ShutDownButton: React.FC = () => {
  return (
    <button
      type="button"
      onClick={async () => {
        try {
          await shutDownStudio();
          console.log("Studio is shutting down");
        } catch (err) {
          console.error(err);
        }
      }}
    >
      Shut down Studio
    </button>
  );
};

Requirements​

This function is only available in a writable Studio with a running server. It throws outside Studio, in Browser Studio, or in a read-only Studio.

Return value​

Returns a promise that resolves to an empty object when the server acknowledges the shutdown request. The connection closes as Studio shuts down. The promise rejects if the request fails.

Compatibility​

BrowsersEnvironments
Chrome
Firefox
Safari

See also​