Skip to main content
Version: 21.11.0

ScreencastOptions interface

Signature:

export interface ScreencastOptions

Properties

PropertyModifiersTypeDescriptionDefault
cropoptionalBoundingBoxSpecifies the region of the viewport to crop.
ffmpegPathoptionalstring

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

Required if ffmpeg is not in your PATH.

pathoptional`${string}.webm`File path to save the screencast to.
scaleoptionalnumber

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
speedoptionalnumber

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