VideoEncoderInfo

Electron APIs / recorder / VideoEncoderInfo

Information for a supported video encoder.

This interface extends EncoderInfoBase and adds the specific video encoder type identifier. Configurable encoder settings are reported through the inherited properties map.

Example

const encoderInfo: VideoEncoderInfo = {
  codec: "h264",
  name: "NVIDIA NVENC H.264",
  type: "obs_nvenc_h264_tex",
  properties: {
    bitrate: { default: 10000, description: "Bitrate" },
    rate_control: {
      default: "CBR",
      description: "Rate Control",
      values: ["CBR", "CQP", "VBR", "CQVBR"],
    },
  },
};

Extends

• EncoderInfoBase

Properties

Property	Modifier	Type	Description
codec	readonly	string	The codec identifier (e.g., h264, aac, av1) supported by the encoder.
name	readonly	string	A human-readable name for the encoder (e.g., shown in UI).
properties?	readonly	Record<string, EncoderProperty>	Optional map of encoder-specific configuration properties, keyed by setting name (e.g. bitrate, rate_control). Each property describes a setting that can be adjusted for this encoder. Reported for both video and audio encoders. See EncoderProperty
type	readonly	kSupportedEncodersTypes	The identifier for the specific video encoder type. See kSupportedEncodersTypes