Class BeginFrameCommandSettings

Namespace

OpenQA.Selenium.DevTools.V148.HeadlessExperimental

Assembly

Selenium.WebDriver.dll

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.

public sealed class BeginFrameCommandSettings : ICommand

Inheritance

object

BeginFrameCommandSettings

Implements

ICommand

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

CommandName

Gets the name of the command.

[JsonIgnore]
public string CommandName { get; }

Property Value

string

FrameTimeTicks

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

[JsonPropertyName("frameTimeTicks")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? FrameTimeTicks { get; set; }

Property Value

double?

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.

[JsonPropertyName("interval")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public double? Interval { get; set; }

Property Value

double?

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.

[JsonPropertyName("noDisplayUpdates")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? NoDisplayUpdates { get; set; }

Property Value

bool?

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.

[JsonPropertyName("screenshot")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ScreenshotParams? Screenshot { get; set; }

Property Value

ScreenshotParams