Skip to main content

getRemotionEnvironment()v4.0.25

使用 getRemotionEnvironment() 函数,您可以获取有关当前 Remotion 环境的信息。 它返回一个具有以下属性的对象:

  • isStudio:该函数是否在 Remotion Studio 中调用。
  • isRendering:该函数是否在渲染中调用。
  • isPlayer:当前页面上是否挂载了 <Player>

如果您希望组件或函数根据环境的不同而表现不同,这可能会很有用。

示例

tsx
import React from "react";
import { getRemotionEnvironment } from "remotion";
 
export const MyComp: React.FC = () => {
const { isStudio, isPlayer, isRendering } = getRemotionEnvironment();
 
if (isStudio) {
return <div>I'm in the Studio!</div>;
}
 
if (isPlayer) {
return <div>I'm in the Player!</div>;
}
 
if (isRendering) {
return <div>I'm Rendering</div>;
}
 
return <div>Hello World!</div>;
};
tsx
import React from "react";
import { getRemotionEnvironment } from "remotion";
 
export const MyComp: React.FC = () => {
const { isStudio, isPlayer, isRendering } = getRemotionEnvironment();
 
if (isStudio) {
return <div>I'm in the Studio!</div>;
}
 
if (isPlayer) {
return <div>I'm in the Player!</div>;
}
 
if (isRendering) {
return <div>I'm Rendering</div>;
}
 
return <div>Hello World!</div>;
};

一个更现实的用例:您可能希望在 Remotion Studio 中进行编辑时防抖请求,但在渲染时不进行。请参见:防抖请求

另请参阅