Skip to main content

EncoderInfoBase

Electron APIs / recorder / EncoderInfoBase

The base `structure for an encoder, including codec and display name.

This interface provides essential metadata about an encoder, typically used to represent supported encoding options in a recording or streaming application.

Example

const encoder: EncoderInfoBase = {
codec: "h264",
name: "NVIDIA NVENC H.264",
};

Extended by

Properties

PropertyModifierTypeDescription
codecreadonlystringThe codec identifier (e.g., h264, aac, av1) supported by the encoder.
namereadonlystringA human-readable name for the encoder (e.g., shown in UI).
properties?readonlyRecord<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