EncoderProperty

Electron APIs / recorder / EncoderProperty

Configurable property of an encoder.

Used to describe encoder settings such as bitrates, presets, or modes. Provides metadata to help display options in a UI or validate configuration.

Example

const bitrateProperty: EncoderProperty = {
  default: 4500,
  description: "Target video bitrate in kbps.",
  values: {
    3000: "Low quality",
    4500: "Medium quality (default)",
    6000: "High quality",
  },
};

Properties

Property	Modifier	Type	Description
default?	readonly	any	The default value for this encoder property.
description	readonly	string	A human-readable explanation of the property's purpose.
values?	readonly	(string | number)[]	Optional array of possible values for this property. Useful for dropdowns or presets.
valuesDesc?	readonly	string[]	Optional array of descriptions corresponding to the values array. Helps provide additional context for each option.