Skip to main content

VideoSettings

Electron APIs / recorder / VideoSettings

Configuration options for video recording settings.

These settings define the input and output resolution, frame rate, and color encoding preferences used during video capture.

See

  • kVideoColorFormat
  • kVideoColorRange
  • kVideoColorSpec

Properties

PropertyTypeDescription
baseHeightnumberBase height resolution of the captured video in pixels. Used as the reference resolution for scaling output. Default Half HD (based on main monitor aspect ratio)
baseWidthnumberBase width resolution of the captured video in pixels. Used as the reference resolution for scaling output. Default Half HD (based on main monitor aspect ratio)
colorFormat?kVideoColorFormatColor format used for video encoding. Determines how pixel color data is structured. Default 'NV12'
colorRange?kVideoColorRangeDefines the color range for video encoding. Affects the range of brightness and color values. Default '709'
colorSpec?kVideoColorSpecDefines the color specification standard for the video. Affects tone mapping and interpretation of colors. Default 'Partial'
fps?numberVideo frame rate in frames per second (FPS). Default 30
hdrPeak?numberHDR peak brightness, defined in nits. Used for tone mapping and color accuracy in HDR content. Default 1000
outputHeight?numberOutput height resolution of the recorded video. If omitted, it defaults to the value of baseHeight.
outputWidth?numberOutput width resolution of the recorded video. If omitted, it defaults to the value of baseWidth.
sdrWhite?numberSDR white level, defined in nits. Affects tone mapping for SDR displays. Default 300