Struct ImageEncoder 

pub struct ImageEncoder { /* private fields */ }

Encodes a single VideoFrame to a still image file.

The output format is inferred from the file extension: .jpg/.jpeg, .png, .bmp, .tif/.tiff, or .webp.

Example

use ff_encode::ImageEncoder;
use ff_format::PixelFormat;

let encoder = ImageEncoder::create("thumbnail.jpg")
    .width(320)
    .height(240)
    .quality(85)
    .build()?;
encoder.encode(&frame)?;

Implementations

impl ImageEncoder

pub fn create(path: impl AsRef<Path>) -> ImageEncoderBuilder

Start building an image encoder that writes to path.

This is infallible; extension validation happens in ImageEncoderBuilder::build.

pub fn new(path: impl AsRef<Path>) -> ImageEncoderBuilder

Alias for create.

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

Encode frame and write it to the output file.

If width or height were set on the builder and differ from the source frame dimensions, swscale is used to resize. If pixel_format was set and differs from the frame format, swscale performs conversion.

Errors

Returns an error if the FFmpeg encoder is unavailable, the output file cannot be created, or encoding fails.

Trait Implementations

impl Debug for ImageEncoder

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

Formats the value using the given formatter.