ScreencastOptions interface
Signature
export interface ScreencastOptions
Properties
|
Property
|
Modifiers
|
Type
|
Description
|
Default
|
|---|
|
colors
|
`optional`
|
number
|
Specifies the maximum number of [palette](https://ffmpeg.org/ffmpeg-filters.html#palettegen) colors to quantize, with GIF limited to `256`. Restrict the palette to only necessary colors to reduce output file size.
|
`256`
|
|
crop
|
`optional`
|
[BoundingBox](./puppeteer.boundingbox.md)
|
Specifies the region of the viewport to crop.
|
|
|
delay
|
`optional`
|
number
|
Specifies the delay between iterations of a loop, in ms. `-1` is a special value to re-use the previous delay.
|
`-1`
|
|
ffmpegPath
|
`optional`
|
string
|
Path to the [ffmpeg](https://ffmpeg.org/).
Required if `ffmpeg` is not in your PATH.
|
|
|
format
|
`optional`
|
[FileFormat](./puppeteer.fileformat.md)
|
Specifies the output file format.
|
`webm`
|
|
fps
|
`optional`
|
number
|
Specifies the frame rate in frames per second.
|
`30` (`20` for GIF)
|
|
loop
|
`optional`
|
number
|
Specifies the number of times to loop playback, from `0` to `Infinity`. A value of `0` or `undefined` will disable looping.
|
`undefined`
|
|
path
|
`optional`
|
\`${string}.${[FileFormat](./puppeteer.fileformat.md)}\`
|
File path to save the screencast to.
|
|
|
quality
|
`optional`
|
number
|
Specifies the recording [quality](https://trac.ffmpeg.org/wiki/Encode/VP9#constantq) Constant Rate Factor between `0`–`63`. Lower values mean better quality.
|
`30`
|
|
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`
|