beginFrame method

Future<BeginFrameResult> beginFrame({ num? frameTimeTicks, num? interval, bool? noDisplayUpdates, ScreenshotParams? screenshot, })

Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gle/chrome-headless-rendering for more background. frameTimeTicks Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set, the current time will be used. interval 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. noDisplayUpdates 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. screenshot 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.

Implementation

Future<BeginFrameResult> beginFrame({
  num? frameTimeTicks,
  num? interval,
  bool? noDisplayUpdates,
  ScreenshotParams? screenshot,
}) async {
  var result = await _client.send('HeadlessExperimental.beginFrame', {
    if (frameTimeTicks != null) 'frameTimeTicks': frameTimeTicks,
    if (interval != null) 'interval': interval,
    if (noDisplayUpdates != null) 'noDisplayUpdates': noDisplayUpdates,
    if (screenshot != null) 'screenshot': screenshot,
  });
  return BeginFrameResult.fromJson(result);
}