Skip to main content
Module

x/puppeteer_plus/mod.ts>Protocol.HeadlessExperimental.BeginFrameRequest

Deno port of puppeteer base on latest TypeScript source.
ratson/puppeteer_plus
Go to Latest
interface Protocol.HeadlessExperimental.BeginFrameRequest
import { type Protocol } from "https://deno.land/x/puppeteer_plus@0.14.0/mod.ts";
const { BeginFrameRequest } = Protocol.HeadlessExperimental;

Properties

optional
frameTimeTicks: number

Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used.

optional
interval: number

The interval between BeginFrames that is reported to the compositor, in milliseconds. Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.

optional
noDisplayUpdates: boolean

Whether updates should not be committed and drawn onto the display. False by default. If true, only side effects of the BeginFrame will be run, such as layout and animations, but any visual updates may not be visible on the display or in screenshots.

optional
screenshot: ScreenshotParams

If set, a screenshot of the frame will be captured and returned in the response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can fail, for example, during renderer initialization. In such a case, no screenshot data will be returned.