Class StartScreencastCommandParameters

Namespace

WebDriverBiDi.BrowsingContext

Assembly

WebDriverBiDi.dll

Provides parameters for the browsingContext.startScreencast command.

public class StartScreencastCommandParameters : CommandParameters<StartScreencastCommandResult>

Inheritance

object

CommandParameters

CommandParameters<StartScreencastCommandResult>

StartScreencastCommandParameters

Inherited Members

CommandParameters<StartScreencastCommandResult>.ResponseType

CommandParameters.AdditionalData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

StartScreencastCommandParameters(string)

Initializes a new instance of the StartScreencastCommandParameters class.

public StartScreencastCommandParameters(string browsingContextId)

Parameters

browsingContextId string

The ID of the browsing context for which to start the screencast.

Properties

Audio

Gets or sets a value indicating whether the screencast should include an audio track. If omitted, defaults to false.

[JsonPropertyName("audio")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Audio { get; set; }

Property Value

bool?

BrowsingContextId

Gets or sets the ID of the browsing context for which to create the screencast.

[JsonPropertyName("context")]
public string BrowsingContextId { get; set; }

Property Value

string

DestinationFolder

Gets or sets the destination directory to which the screencast file will be saved.

[JsonPropertyName("destinationFolder")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? DestinationFolder { get; set; }

Property Value

string

MethodName

Gets the method name of the command.

[JsonIgnore]
public override string MethodName { get; }

Property Value

string

MimeType

Gets or sets the MIME type of the screencast file.

[JsonPropertyName("mimeType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? MimeType { get; set; }

Property Value

string

Video

Gets or sets the video constraints for a screencast.

[JsonPropertyName("video")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public MediaTrackConstraints? Video { get; set; }

Property Value

MediaTrackConstraints