Click or drag to resize

HeadlessExperimentalClient.BeginFrameAsync Method

Version 113.3.50
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.

Namespace:  CefSharp.DevTools.HeadlessExperimental
Assembly:  CefSharp.Core (in CefSharp.Core.dll) Version: 113.3.50.0
Syntax
Copy
public Task<BeginFrameResponse> BeginFrameAsync(
	double? frameTimeTicks = null,
	double? interval = null,
	bool? noDisplayUpdates = null,
	ScreenshotParams screenshot = null
)

Parameters

frameTimeTicks (Optional)
Type: System.Nullable<Double>
Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,the current time will be used.
interval (Optional)
Type: System.Nullable<Double>
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 (Optional)
Type: System.Nullable<Boolean>
Whether updates should not be committed and drawn onto the display. False by default. Iftrue, only side effects of the BeginFrame will be run, such as layout and animations, butany visual updates may not be visible on the display or in screenshots.
screenshot (Optional)
Type: CefSharp.DevTools.HeadlessExperimental.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.

Return Value

Type: Task<BeginFrameResponse>
returns System.Threading.Tasks.Task<BeginFrameResponse>
See Also