Skip to main content

openBrowser()

自 v3.0 起可用 - @remotion/renderer 包的一部分。

打开一个 Chrome 或 Chromium 浏览器实例。通过在 renderFrames()、renderStill()、renderMedia() 和 getCompositions() 调用中重复使用一个实例，您可以节省时间，而不必为每个调用打开和关闭浏览器。

ts
const openBrowser: (
  browser: Browser,
  options: {
    shouldDumpIo?: boolean;
    browserExecutable?: string | null;
    chromiumOptions?: ChromiumOptions;
  },
) => Promise<puppeteer.Browser>;
ts
const openBrowser: (
  browser: Browser,
  options: {
    shouldDumpIo?: boolean;
    browserExecutable?: string | null;
    chromiumOptions?: ChromiumOptions;
  },
) => Promise<puppeteer.Browser>;

参数​

browser​

目前唯一有效的选项是 "chrome"。此字段保留用于与其他浏览器的未来兼容性。

options?​

可选

包含以下一个或多个选项的对象：

shouldDumpIo?​

可选，自 v4.0.189 弃用，计划在 v5.0 中移除

如果设置为 true，日志和其他浏览器诊断将打印到标准输出。此设置对调试很有用。
**将在 5.0 中移除：**改用 logLevel。

logLevel?v4.0.189​

可选

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.

browserExecutable?​

可选

定义应使用的浏览器可执行文件在磁盘上的绝对路径的字符串。默认情况下，Remotion 将尝试自动检测并下载一个。如果定义了 puppeteerInstance，它将优先于 browserExecutable。

chromiumOptions?​

可选

允许您设置某些 Chromium / Google Chrome 标志。参见：Chromium 标志。

note

Chromium 标志需要在浏览器启动时设置。如果将实例传递给像 renderMedia() 这样的 SSR API，那么该 API 的 chromiumOptions 选项将不适用，而是应用传递给 openBrowser() 的标志。

forceDeviceScaleFactor?​

设置一个 比例。如果您计划使用缩放，您在打开浏览器时已经需要设置它。

onBrowserDownload?v4.0.137​

Gets called when no compatible local browser is detected on the system and this API needs to download a browser. Return a callback to observe progress. See here for how to use this option.

另请参阅​