Skip to main content

VideoEncoderInfo

Electron APIs / Recorder / VideoEncoderInfo

Information for a supported video encoder.

This interface extends EncoderInfoBase and adds specific information about the video encoder type and any configurable encoder properties.

Example

const encoderInfo: VideoEncoderInfo = {
codec: "h264",
name: "NVIDIA NVENC H.264",
type: "obs_nvenc_h264_tex",
properties: {
bitrate: {
default: 6000,
description: "Target video bitrate in kbps.",
values: {
4000: "Low quality",
6000: "Medium quality",
8000: "High quality",
},
},
},
};

Extends

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. Each property defines a setting that can be adjusted, such as bitrate, profile, or keyframe interval. See EncoderProperty
typereadonlykSupportedEncodersTypesThe identifier for the specific video encoder type. See kSupportedEncodersTypes