Skip to main content
Version: Next

RecordOptions interface

Signature

export interface RecordOptions

Properties

Property

Modifiers

Type

Description

Default

audio

optional

boolean

Whether to record audio.

false

fps

optional

number

Frame rate in frames per second (alias for frameRate).

frameRate

optional

number

Maximum frame rate in frames per second.

maxHeight

optional

number

Maximum frame height in pixels.

maxWidth

optional

number

Maximum frame width in pixels.

overwrite

optional

boolean

Specifies whether to overwrite output file, or exit immediately if it already exists.

true

path

optional

string

File path to save the recording to.