Struct EncoderConfig 

pub struct EncoderConfig { /* private fields */ }

Configuration for the Encoder.

Setting missing? Please file a PR!

Implementations

impl EncoderConfig

pub const fn new() -> Self

Creates a new default encoder config.

pub const fn bitrate(self, bps: BitRate) -> Self

Sets the requested bit rate in bits per second.

pub const fn debug(self, value: bool) -> Self

Enables detailed console logging inside OpenH264.

pub const fn skip_frames(self, value: bool) -> Self

Set whether frames can be skipped to meet desired rate control target.

pub const fn max_frame_rate(self, value: FrameRate) -> Self

Sets the requested maximum frame rate in Hz.

pub const fn usage_type(self, value: UsageType) -> Self

Sets the usage type (e.g, screen vs. camera recording).

pub const fn rate_control_mode(self, value: RateControlMode) -> Self

Sets the requested rate control mode.

pub const fn sps_pps_strategy(self, value: SpsPpsStrategy) -> Self

Set the SPS/PPS behavior.

pub const fn max_slice_len(self, max_slice_len: u32) -> Self

Set the maximum slice length

pub const fn profile(self, profile: Profile) -> Self

Set the encoding profile

pub const fn level(self, level: Level) -> Self

Set the encoding profile level

pub const fn complexity(self, complexity: Complexity) -> Self

Set the complexity

pub const fn qp(self, value: QpRange) -> Self

Set the balance between compression and size

pub const fn scene_change_detect(self, value: bool) -> Self

Set scene change detect (on by default)

pub const fn adaptive_quantization(self, value: bool) -> Self

Set adaptive quantization control (on by default)

pub const fn background_detection(self, value: bool) -> Self

Set background detection (on by default)

pub const fn long_term_reference(self, value: bool) -> Self

Set use of long term reference (off by default)

pub const fn intra_frame_period(self, value: IntraFramePeriod) -> Self

Set the interval of intra frames (0 by default, disabling periodic intra frames)

pub const fn num_threads(self, threads: u16) -> Self

Sets the number of internal encoder threads.

• 0 - auto mode
• 1 - single threaded operation
• >1 - fixed number of threads

Defaults to 0 (auto mode).

pub const fn vui(self, config: VuiConfig) -> Self

Sets the VUI (Video Usability Information) parameters.

VUI parameters are written into the H.264 SPS NAL unit and tell decoders how to interpret the color space of the video data. This is essential for correct color reproduction.

Example

use openh264::encoder::{EncoderConfig, VuiConfig};

let config = EncoderConfig::new()
    .vui(VuiConfig::bt709());  // HD content with BT.709 color space

See VuiConfig for common presets like bt709(), srgb(), and bt601().

Trait Implementations

impl Clone for EncoderConfig

fn clone(&self) -> EncoderConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncoderConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncoderConfig

fn default() -> EncoderConfig

Returns the “default value” for a type.

impl Copy for EncoderConfig