Interface IHeadlessExperimental

Namespace

Selenium.WebDriver.BiDi.Cdp.HeadlessExperimental

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

This domain provides experimental commands only supported in headless mode.

[Experimental("BIDICDP001")]
public interface IHeadlessExperimental

Methods

BeginFrameAsync(double?, double?, bool?, ScreenshotParams?, string?, CancellationToken)

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.

Task<BeginFrameResult> BeginFrameAsync(double? frameTimeTicks = null, double? interval = null, bool? noDisplayUpdates = null, ScreenshotParams? screenshot = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

frameTimeTicks double?

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

interval 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 bool?

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

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<BeginFrameResult>

A task representing the asynchronous operation, containing a BeginFrameResult.

DisableAsync(string?, CancellationToken)

Disables headless events for the target.

[Obsolete]
Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, CancellationToken)

Enables headless events for the target.

[Obsolete]
Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.