Struct VideoEncoder 

pub struct VideoEncoder { /* private fields */ }

Encodes video (and optionally audio) frames to a file using FFmpeg.

Construction

Use VideoEncoder::create() to get a VideoEncoderBuilder, then call VideoEncoderBuilder::build():

use ff_encode::{VideoEncoder, VideoCodec};

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

Implementations

impl VideoEncoder

pub fn create<P: AsRef<Path>>(path: P) -> VideoEncoderBuilder

Creates a builder for the specified output file path.

This method is infallible. Validation occurs when VideoEncoderBuilder::build() is called.

pub fn actual_video_codec(&self) -> &str

Returns the name of the FFmpeg encoder actually used (e.g. "h264_nvenc", "libx264").

pub fn actual_audio_codec(&self) -> &str

Returns the name of the FFmpeg audio encoder actually used.

pub fn hardware_encoder(&self) -> HardwareEncoder

Returns the hardware encoder actually in use.

pub fn is_hardware_encoding(&self) -> bool

Returns true if a hardware encoder is active.

pub fn is_lgpl_compliant(&self) -> bool

Returns true if the selected encoder is LGPL-compatible (safe for commercial use).

pub fn push_video(&mut self, frame: &VideoFrame) -> Result<(), EncodeError>

Pushes a video frame for encoding.

Errors

Returns EncodeError if encoding fails or the encoder is not initialised. Returns EncodeError::Cancelled if the progress callback requested cancellation.

pub fn push_audio(&mut self, frame: &AudioFrame) -> Result<(), EncodeError>

Pushes an audio frame for encoding.

Errors

Returns EncodeError if encoding fails or the encoder is not initialised.

pub fn finish(self) -> Result<(), EncodeError>

Flushes remaining frames and writes the file trailer.

Errors

Returns EncodeError if finalising fails.

Trait Implementations

impl Drop for VideoEncoder

fn drop(&mut self)

Executes the destructor for this type.