Skip to main content
Version: 22.11.0

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