Class ScreencastOptions

Namespace

PuppeteerSharp

Assembly

PuppeteerSharp.dll

Options for ScreencastAsync(ScreencastOptions).

public class ScreencastOptions

Inheritance

object

ScreencastOptions

Properties

Colors

Specifies the maximum number of palette colors to quantize.

public int? Colors { get; set; }

Property Value

int?

Crop

Specifies the region of the viewport to crop.

public BoundingBox Crop { get; set; }

Property Value

BoundingBox

Delay

Specifies the delay between iterations of a loop, in ms.

public int? Delay { get; set; }

Property Value

int?

FfmpegPath

Path to the ffmpeg executable. Required if ffmpeg is not in your PATH.

public string FfmpegPath { get; set; }

Property Value

string

Format

Specifies the output video format.

public string Format { get; set; }

Property Value

string

Fps

Specifies the frame rate in frames per second.

public int? Fps { get; set; }

Property Value

int?

Loop

Specifies the number of times to loop playback.

public double? Loop { get; set; }

Property Value

double?

Overwrite

Specifies whether to overwrite the output file, or exit immediately if it already exists.

public bool? Overwrite { get; set; }

Property Value

bool?

Path

File path to save the screencast to.

public string Path { get; set; }

Property Value

string

Quality

Specifies the recording quality (Constant Rate Factor between 0-63).

public int? Quality { get; set; }

Property Value

int?

Scale

Scales the output video. For example, 0.5 will shrink the width and height of the output video by half. 2 will double the width and height of the output video.

public decimal? Scale { get; set; }

Property Value

decimal?

Speed

Specifies the speed to record at. For example, 0.5 will slowdown the output video by 50%. 2 will double the speed of the output video.

public decimal? Speed { get; set; }

Property Value

decimal?