Struct EncoderConfig 

#[non_exhaustive]
pub struct EncoderConfig {
    pub codec: VideoCodec,
    pub width: u32,
    pub height: u32,
    pub input_format: PixelFormat,
    pub frame_rate: f64,
    pub bitrate: Bitrate,
    pub gop: Option<u32>,
    pub repeat_headers: bool,
    pub profile: Option<H264Profile>,
    pub level: Option<H264Level>,
}

Configuration of a VideoEncoder.

Start from EncoderConfig::h264 and set the fields to change.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

codec: VideoCodec

Output codec.

width: u32

Width of the encoded picture in pixels.

height: u32

Height of the encoded picture in pixels.

input_format: PixelFormat

Pixel format of the source tensors.

frame_rate: f64

Nominal frame rate, for rate control.

bitrate: Bitrate

Target bitrate.

gop: Option<u32>

Frames from one key frame to the next. None keeps the device default.

repeat_headers: bool

Emit the SPS and PPS with every key frame, so a receiver can start decoding at any key frame.

profile: Option<H264Profile>

Profile. None selects High where the device offers it, and keeps the device default where it does not. See EncoderConfig::target_profile.

level: Option<H264Level>

Level. None selects the lowest level that covers the stream where the device offers it, and keeps the device default where it does not. See EncoderConfig::target_level.

Implementations

impl EncoderConfig

pub fn h264( width: u32, height: u32, input_format: PixelFormat, frame_rate: f64, ) -> Self

An H.264 configuration with an automatic bitrate, profile and level, the device’s default GOP, and headers repeated on every key frame.

pub fn target_bitrate(&self) -> u32

The target bitrate in bits per second: the Bitrate::Bps value, or for Bitrate::Auto one derived from the frame size and rate.

pub fn target_profile(&self) -> H264Profile

The profile to request: EncoderConfig::profile, or High.

pub fn target_level(&self) -> Option<H264Level>

The level to request: EncoderConfig::level, or the lowest that covers the size, frame rate and target bitrate in the target profile. None when no level covers them.

pub fn validate(&self) -> Result<()>

Checks the values that do not depend on a device.

Trait Implementations

impl Clone for EncoderConfig

fn clone(&self) -> Self

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 PartialEq for EncoderConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EncoderConfig