RecordOptions

RecordOptions = object

Defined in: types.ts:211

Configuration options for video recording.

Example:

const options: RecordOptions = {
  aspectRatio: '16:9',
  quality: '1080p',
  fps: 60,
}

Properties

aspectRatio?

optional aspectRatio?: AspectRatio

Defined in: types.ts:221

Aspect ratio used when capturing the screen.

Together with quality this determines the xvfb display size, browser viewport, and ffmpeg input dimensions. See AspectRatio for all supported ratios and their pixel sizes.

Default

'16:9'

---

fps?

optional fps?: FPS

Defined in: types.ts:239

Frames per second for video recording.

Default

30

---

quality?

optional quality?: Quality

Defined in: types.ts:232

Resolution quality preset used when capturing the screen.

Together with aspectRatio this determines the xvfb display size, browser viewport, and ffmpeg input dimensions. See Quality for the full dimension table.

Default

'1080p'