Class StartScreencastCommandSettings

Namespace

OpenQA.Selenium.DevTools.V154.Page

Assembly

Selenium.WebDriver.dll

Starts sending each frame using the screencastFrame event.

public sealed class StartScreencastCommandSettings : ICommand

Inheritance

object

StartScreencastCommandSettings

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

EveryNthFrame

Send every n-th frame. Must be a positive integer.

[JsonPropertyName("everyNthFrame")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? EveryNthFrame { get; set; }

Property Value

long?

Format

Image compression format.

[JsonPropertyName("format")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Format { get; set; }

Property Value

string

MaxFramesInFlight

Maximum number of frames sent until screencastFrameAck is required. Defaults to 3. Must be a positive integer.

[JsonPropertyName("maxFramesInFlight")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? MaxFramesInFlight { get; set; }

Property Value

long?

MaxHeight

Maximum screenshot height.

[JsonPropertyName("maxHeight")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? MaxHeight { get; set; }

Property Value

long?

MaxWidth

Maximum screenshot width.

[JsonPropertyName("maxWidth")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? MaxWidth { get; set; }

Property Value

long?

Quality

Compression quality from range [0..100].

[JsonPropertyName("quality")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? Quality { get; set; }

Property Value

long?

SendLastFrame

By default, after screencastFrameAck arrives, the next produced frame is sent. Passing this flag enables storing the last produced frame in memory, which is immediately sent upon screencastFrameAck. This way, overall performance is traded for a better latency.

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

Property Value

bool?