Struct VideoEncoderBuilder 

pub struct VideoEncoderBuilder { /* private fields */ }

Builder for constructing a VideoEncoder.

Created by calling VideoEncoder::create(). Call build() to open the output file and prepare for encoding.

Examples

use ff_encode::{VideoEncoder, VideoCodec, Preset};

let mut encoder = VideoEncoder::create("output.mp4")
    .video(1920, 1080, 30.0)
    .video_codec(VideoCodec::H264)
    .preset(Preset::Medium)
    .build()?;

Implementations

impl VideoEncoderBuilder

pub fn video(self, width: u32, height: u32, fps: f64) -> Self

Configure video stream settings.

pub fn video_codec(self, codec: VideoCodec) -> Self

Set video codec.

pub fn bitrate_mode(self, mode: BitrateMode) -> Self

Set the bitrate control mode for video encoding.

pub fn preset(self, preset: Preset) -> Self

Set encoding preset (speed vs quality tradeoff).

pub fn hardware_encoder(self, hw: HardwareEncoder) -> Self

Set hardware encoder.

pub fn audio(self, sample_rate: u32, channels: u32) -> Self

Configure audio stream settings.

pub fn audio_codec(self, codec: AudioCodec) -> Self

Set audio codec.

pub fn audio_bitrate(self, bitrate: u64) -> Self

Set audio bitrate in bits per second.

pub fn container(self, container: Container) -> Self

Set container format explicitly (usually auto-detected from file extension).

pub fn on_progress<F>(self, callback: F) -> Self

where F: FnMut(&Progress) + Send + 'static,

Set a closure as the progress callback.

pub fn progress_callback<C: ProgressCallback + 'static>( self, callback: C, ) -> Self

Set a ProgressCallback trait object (supports cancellation).

pub fn two_pass(self) -> Self

Enable two-pass encoding for more accurate bitrate distribution.

Two-pass encoding is video-only and is incompatible with audio streams.

pub fn metadata(self, key: &str, value: &str) -> Self

Embed a metadata tag in the output container.

Calls av_dict_set on AVFormatContext->metadata before the header is written. Multiple calls accumulate entries; duplicate keys use the last value.

pub fn chapter(self, chapter: ChapterInfo) -> Self

Add a chapter to the output container.

Allocates an AVChapter entry on AVFormatContext before the header is written. Multiple calls accumulate chapters in the order added.

pub fn subtitle_passthrough( self, source_path: &str, stream_index: usize, ) -> Self

Copy a subtitle stream from an existing file into the output container.

Opens source_path, locates the stream at stream_index, and registers it as a passthrough stream in the output. Packets are copied verbatim using av_interleaved_write_frame without re-encoding.

stream_index is the zero-based index of the subtitle stream inside source_path. For files with a single subtitle track this is typically 0 (or whichever index ffprobe reports).

If the source cannot be opened or the stream index is invalid, a warning is logged and encoding continues without subtitles.

pub fn build(self) -> Result<VideoEncoder, EncodeError>

Validate builder state and open the output file.

Errors

Returns EncodeError if configuration is invalid, the output path cannot be created, or no suitable encoder is found.

Trait Implementations

impl Debug for VideoEncoderBuilder

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

Formats the value using the given formatter.