github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
b6d1163f7f
puppeteer/docs/api/puppeteer.screencastoptions.md
Miki Lombardi 39e3d4bceb docs: Upgrading to Docusaurus V3 (#11434) 
Co-authored-by: Alex Rudenko <alexrudenko@chromium.org>
2023-11-29 13:08:08 +01:00

2.2 KiB
Raw Blame History

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