puppeteer/website/versioned_docs/version-22.0.0/api/puppeteer.screencastoptions.md
release-please[bot] 9fbb9f9653
chore: release main (#11821)
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
2024-02-05 10:22:00 +00:00

2.2 KiB

sidebar_label
ScreencastOptions

ScreencastOptions interface

Signature:

export interface ScreencastOptions

Properties

Property Modifiers Type Description Default
crop optional BoundingBox Specifies the region of the viewport to crop.
ffmpegPath optional string

Path to the [ffmpeg](https://ffmpeg.org/).

Required if ffmpeg is not in your PATH.

path optional `${string}.webm` File path to save the screencast to.
scale optional number

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.

1
speed optional number

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.

1