Skip to main content

EncoderConfig

Struct EncoderConfig 

Source
#[non_exhaustive]
pub struct EncoderConfig { pub video_codec: VideoCodec, pub audio_codec: AudioCodec, pub bitrate_mode: BitrateMode, pub resolution: Option<(u32, u32)>, pub framerate: Option<f64>, pub hardware: Option<HwAccel>, }
Expand description

Codec and quality configuration for the pipeline output.

Passed to PipelineBuilder::output alongside the output path.

Construct via EncoderConfig::builder.

Fields (Non-exhaustive)§

This struct is marked as 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.
§video_codec: VideoCodec

Video codec to use for the output stream.

§audio_codec: AudioCodec

Audio codec to use for the output stream.

§bitrate_mode: BitrateMode

Bitrate control mode (CBR, VBR, or CRF).

§resolution: Option<(u32, u32)>

Output resolution as (width, height) in pixels.

Resolution precedence in Pipeline::run:

  1. This field when Some — explicit value always wins.
  2. The output dimensions of a scale filter, inferred automatically.
  3. The source video’s native resolution.

When a scale filter is used via PipelineBuilder::filter you typically do not need to set this field; the pipeline infers the encoder dimensions from the filter. Set it explicitly only to override the filter’s output size or to resize without a filter.

§framerate: Option<f64>

Output frame rate in frames per second.

None preserves the source frame rate.

§hardware: Option<HwAccel>

Hardware acceleration device to use during encoding.

None uses software (CPU) encoding.

Implementations§

Source§

impl EncoderConfig

Source

pub fn builder() -> EncoderConfigBuilder

Returns an EncoderConfigBuilder with sensible defaults: H.264 video, AAC audio, CRF 23, no resolution/framerate override, software encoding.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.