Skip to main content

ensureBrowser()v4.0.137

确保本地安装了浏览器，以便执行 Remotion 渲染。

Simple usage
tsx
import { ensureBrowser } from "@remotion/renderer";
 
await ensureBrowser();
Simple usage
tsx
import { ensureBrowser } from "@remotion/renderer";
 
await ensureBrowser();
Setting a specific Chrome version and listening to progress
tsx
import { ensureBrowser } from "@remotion/renderer";
 
await ensureBrowser({
  onBrowserDownload: () => {
    console.log("Downloading browser");
 
    return {
      version: "123.0.6312.86",
      onProgress: ({ percent }) => {
        console.log(`${Math.round(percent * 100)}% downloaded`);
      },
    };
  },
});
Setting a specific Chrome version and listening to progress
tsx
import { ensureBrowser } from "@remotion/renderer";
 
await ensureBrowser({
  onBrowserDownload: () => {
    console.log("Downloading browser");
 
    return {
      version: "123.0.6312.86",
      onProgress: ({ percent }) => {
        console.log(`${Math.round(percent * 100)}% downloaded`);
      },
    };
  },
});

API​

一个具有以下属性的对象，所有属性都是可选的：

browserExecutable​

传递一个浏览器可执行文件的路径，您希望使用该文件而不是下载。
如果路径不存在，此函数将抛出异常。
将相同的路径传递给支持 browserExecutable 选项的任何其他 API。

logLevel​

One of verbose, info, warn, error.
Determines how much is being logged to the console.
verbose will also log console.log's from the browser.
Default info.

onBrowserDownload​

指定应使用的特定 Chrome 版本，并钩入下载进度。
请参见下面的示例以了解函数签名。

init.ts
tsx
import {
  ensureBrowser,
  OnBrowserDownload,
  DownloadBrowserProgressFn,
} from "@remotion/renderer";
 
const onProgress: DownloadBrowserProgressFn = ({
  percent,
  downloadedBytes,
  totalSizeInBytes,
}) => {
  console.log(`${Math.round(percent * 100)}% downloaded`);
};
 
const onBrowserDownload: OnBrowserDownload = () => {
  console.log("Downloading browser");
 
  return {
    // Pass `null` to use Remotion's recommendation.
    version: "123.0.6312.86",
    onProgress,
  };
};
 
await ensureBrowser({
  onBrowserDownload,
});
init.ts
tsx
import {
  ensureBrowser,
  OnBrowserDownload,
  DownloadBrowserProgressFn,
} from "@remotion/renderer";
 
const onProgress: DownloadBrowserProgressFn = ({
  percent,
  downloadedBytes,
  totalSizeInBytes,
}) => {
  console.log(`${Math.round(percent * 100)}% downloaded`);
};
 
const onBrowserDownload: OnBrowserDownload = () => {
  console.log("Downloading browser");
 
  return {
    // Pass `null` to use Remotion's recommendation.
    version: "123.0.6312.86",
    onProgress,
  };
};
 
await ensureBrowser({
  onBrowserDownload,
});

返回值​

一个没有值的 Promise。

参见​