Skip to main content

VideoEncoderConfig

Struct VideoEncoderConfig 

Source
pub struct VideoEncoderConfig {
    pub codec: CodecId,
    pub input: FrameInfo,
    pub frame_rate: Option<FrameRate>,
    pub frame_limit: Option<usize>,
    pub rate_control: VideoRateControl,
    pub reconstruction: ReconstructionMode,
    pub settings: Vec<VideoEncoderSetting>,
}
Expand description

Codec-neutral configuration for constructing or driving a video encoder.

Fields§

§codec: CodecId

Selected codec id.

§input: FrameInfo

Input frame geometry and pixel format.

§frame_rate: Option<FrameRate>

Optional frame-rate metadata.

§frame_limit: Option<usize>

Optional caller/source frame limit.

§rate_control: VideoRateControl

Requested rate-control mode.

§reconstruction: ReconstructionMode

Requested reconstruction output mode.

§settings: Vec<VideoEncoderSetting>

Codec extension settings.

Implementations§

Source§

impl VideoEncoderConfig

Source

pub fn new(codec: CodecId, input: FrameInfo) -> Self

Create an encoder config using codec defaults for optional fields.

Source

pub fn for_codec(codec: impl AsRef<str>, input: FrameInfo) -> Result<Self>

Create an encoder config from a textual codec id.

Source

pub fn with_frame_rate(self, frame_rate: FrameRate) -> Self

Set optional frame-rate metadata.

Source

pub fn with_frame_limit(self, frame_limit: usize) -> Self

Set an optional source/caller frame limit.

Source

pub fn with_rate_control(self, rate_control: VideoRateControl) -> Self

Set the requested rate-control mode.

Source

pub fn with_reconstruction(self, reconstruction: ReconstructionMode) -> Self

Set the requested reconstruction mode.

Source

pub fn with_setting(self, setting: VideoEncoderSetting) -> Self

Append one codec extension setting.

Source

pub fn setting_specs(&self) -> Vec<String>

Return explicit CLI-compatible setting specs represented by this config.

This does not include manifest defaults. Use VideoEncoderManifest::effective_setting_specs when a frontend needs the full effective setting list that will be reported to users.

Trait Implementations§

Source§

impl Clone for VideoEncoderConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VideoEncoderConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for VideoEncoderConfig

Source§

impl PartialEq for VideoEncoderConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for VideoEncoderConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.