EncodeOptions Struct Reference

User-configurable video encoder quality options. More...

#include <MXWrite/mxwrite.hpp>

Classes
struct	HdrInfo
	HDR output options. More...

Public Attributes
bool	block_when_full = false
	Block producer threads instead of dropping when the encoder queue is full.
std::string	codec = "auto"
	Encoder selection policy or concrete NVENC codec.
int	crf = 18
	Constant Rate Factor.
struct EncodeOptions::HdrInfo	hdr
std::string	preset = "medium"
	Encoder preset name.
bool	realtime = false
	Enable low-latency settings.
std::string	tune = ""
	Optional tuning mode.

Detailed Description

User-configurable video encoder quality options.

preset: x264 preset name — ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow. Mapped to NVENC p1..p7. tune: x264 tune — empty string (none), film, animation, grain, stillimage, psnr, ssim, fastdecode, zerolatency. crf: Constant Rate Factor, 0 (lossless) .. 51 (worst). 18 is visually near-lossless; 23 is default for x264; 28 is typical "small file". For NVENC this is forwarded as cq. codec: "auto" (NVENC if available, else software), "software" (force software), "nvenc" (force resolution-selected NVENC), "h264_nvenc", or "hevc_nvenc". NVENC requests fall back to the matching software codec. realtime: when true, applies low-latency settings (tune=zerolatency for x264, tune=ll + zerolatency=1 for NVENC). Overrides tune value. block_when_full: when true, producer threads block if the encoder queue is full instead of dropping frames.

Definition at line 56 of file mxwrite.hpp.

Member Data Documentation

block_when_full

bool EncodeOptions::block_when_full = false

Block producer threads instead of dropping when the encoder queue is full.

Definition at line 62 of file mxwrite.hpp.

codec

std::string EncodeOptions::codec = "auto"

Encoder selection policy or concrete NVENC codec.

Definition at line 60 of file mxwrite.hpp.

crf

int EncodeOptions::crf = 18

Constant Rate Factor.

Definition at line 59 of file mxwrite.hpp.

hdr

struct EncodeOptions::HdrInfo EncodeOptions::hdr

preset

std::string EncodeOptions::preset = "medium"

Encoder preset name.

Definition at line 57 of file mxwrite.hpp.

realtime

bool EncodeOptions::realtime = false

Enable low-latency settings.

Definition at line 61 of file mxwrite.hpp.

tune

std::string EncodeOptions::tune = ""

Optional tuning mode.

Definition at line 58 of file mxwrite.hpp.

---

The documentation for this struct was generated from the following file:

• MXWrite/mxwrite.hpp