RecordOptions

RecordOptions = object

Defined in: types.ts:210

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:220

Aspect ratio used when capturing the screen.

Together with quality this determines the 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:238

Frames per second for video recording.

Default

60

---

quality?

optional quality?: Quality

Defined in: types.ts:231

Resolution quality preset used when capturing the screen.

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

Default

'1080p'