Struct SpriteSheet 

pub struct SpriteSheet { /* private fields */ }

Generates a thumbnail sprite sheet from a video file.

Frames are sampled at evenly-spaced intervals across the full video duration and tiled into a single PNG image of size cols × frame_width × rows × frame_height.

Examples

use ff_encode::SpriteSheet;

SpriteSheet::new("video.mp4")
    .cols(5)
    .rows(4)
    .frame_width(160)
    .frame_height(90)
    .output("sprites.png")
    .run()?;

Implementations

impl SpriteSheet

pub fn new(input: impl AsRef<Path>) -> Self

Creates a new SpriteSheet for the given input file.

Defaults: cols=10, rows=10, frame_width=160, frame_height=90, no output path set.

pub fn cols(self, n: u32) -> Self

Sets the number of columns in the sprite grid (default: 10).

pub fn rows(self, n: u32) -> Self

Sets the number of rows in the sprite grid (default: 10).

pub fn frame_width(self, w: u32) -> Self

Sets the width of each individual thumbnail frame in pixels (default: 160).

pub fn frame_height(self, h: u32) -> Self

Sets the height of each individual thumbnail frame in pixels (default: 90).

pub fn output(self, path: impl AsRef<Path>) -> Self

Sets the output path for the generated PNG file.

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

Runs the sprite sheet generation.

Output image dimensions: cols × frame_width × rows × frame_height.

Errors

• EncodeError::MediaOperationFailed — cols or rows is zero, frame_width or frame_height is zero, or output path is not set.
• EncodeError::Ffmpeg — any FFmpeg filter graph or encoding call fails.