Trait Encoder

Source

pub trait Encoder: Send {
    // Required methods
    fn init(&mut self, width: u32, height: u32) -> Result<()>;
    fn encode_frame(&mut self, rgb_data: &[u8], timestamp_ms: u64) -> Result<()>;
    fn finalize(self: Box<Self>) -> Result<()>;
    fn extensions(&self) -> &[&str];

    // Provided method
    fn supports_extension(&self, ext: &str) -> bool { ... }
}

Expand description

Trait for video/animation encoders

Implementors of this trait can encode frames into video files. The encoding process has three phases:

Initialization (init): Set up the encoder with frame dimensions
Encoding (encode_frame): Add frames one at a time
Finalization (finalize): Flush buffers and close the file

§Example Implementation

struct MyEncoder { /* ... */ }

impl Encoder for MyEncoder {
    fn init(&mut self, width: u32, height: u32) -> Result<()> {
        // Set up encoder for given dimensions
        Ok(())
    }

    fn encode_frame(&mut self, rgb_data: &[u8], timestamp_ms: u64) -> Result<()> {
        // Encode one frame
        Ok(())
    }

    fn finalize(self: Box<Self>) -> Result<()> {
        // Finish encoding and write file
        Ok(())
    }

    fn extensions(&self) -> &[&str] {
        &["mp4", "webm"]
    }
}