Puppeteer 中文文档v25.8.0

ScreencastOptions 接口

签名

export interface ScreencastOptions

属性

属性

修饰符

类型

说明

默认值

colors

optional

number

指定要量化的调色板颜色的最大数量,其中 GIF 限制为 256。将调色板限制为仅必要的颜色,以减小输出文件大小。

256

crop

optional

BoundingBox

指定要裁剪的视口区域。

delay

optional

number

指定循环各次迭代之间的延迟,单位为毫秒。-1 是复用上一次延迟的特殊值。

-1

ffmpegPath

optional

string

ffmpeg 的路径。

如果 ffmpeg 不在你的 PATH 中,则为必填。

'ffmpeg'

format

optional

VideoFormat

指定输出文件格式。

'webm'

fps

optional

number

指定帧率,单位为每秒帧数。

30 (20 for GIF)

loop

optional

number

指定循环播放的次数,范围为 0Infinity。值为 0undefined 时将禁用循环播放。

undefined

overwrite

optional

boolean

指定是覆盖输出文件,还是在文件已存在时立即退出。

true

path

optional

`${string}.${VideoFormat}`

用于保存屏幕录制的文件路径。

quality

optional

number

指定录制的质量恒定速率因子(Constant Rate Factor),范围为 063。值越低,质量越好。

30

scale

optional

number

缩放输出视频。

例如,0.5 会将输出视频的宽度和高度缩小一半,2 会将输出视频的宽度和高度放大一倍。

1

speed

optional

number

指定录制时的速度。

例如,0.5 会将输出视频放慢 50%,2 会将输出视频的速度提高一倍。

1