Struct AvifEncoder 

pub struct AvifEncoder { /* private fields */ }

Frame-to-AVIF encoder: every video frame becomes one complete AVIF file packet. See the module docs for the input-format mapping and the option surface.

Implementations

impl AvifEncoder

pub fn new(codec_id: CodecId) -> Self

Build an encoder announcing codec_id in its output parameters.

pub fn with_params(params: CodecParameters) -> Self

Build an encoder from an explicit parameter set, reading the options leniently: unknown keys and malformed values are ignored (the historical behaviour of this constructor). Self::try_with_params — what make_encoder and the registry use — refuses them instead. Option parsing happens here (construction time), never on the frame path.

pub fn try_with_params(params: CodecParameters) -> Result<Self>

Build an encoder from a parameter set whose options are parsed strictly against AvifEncoderOptions’s schema: an unknown key, a malformed value or one outside its range is InvalidData.

pub fn from_options(params: CodecParameters, opts: AvifEncoderOptions) -> Self

Build an encoder from a parameter set and already-parsed options (the option bag on params is not read again).

pub fn encode_options(&self) -> EncodeOptions

The still-encoder tuning this encoder codes with (q, alpha_q, the quality mapping, chroma, premultiplied, speed, and the worker threads the next frame runs on: the explicit threads option, else the execution context’s budget).

Trait Implementations

impl Encoder for AvifEncoder

fn set_execution_context(&mut self, ctx: &ExecutionContext)

The worker budget for the AV1 tile search of every coded item; an explicit threads option wins over it. The bytes never depend on the budget (the tile layout follows the picture size).

fn codec_id(&self) -> &CodecId

Identifier of the codec this encoder produces.

fn output_params(&self) -> &CodecParameters

Parameters describing this encoder’s output stream (to feed into a muxer).

fn send_frame(&mut self, frame: &Frame) -> Result<()>

Feed one uncompressed frame. May or may not produce a packet immediately — call receive_packet in a loop afterwards.

fn receive_packet(&mut self) -> Result<Packet>

Pull the next encoded packet, if any. Returns Error::NeedMore when the encoder needs another frame (or a flush).

fn flush(&mut self) -> Result<()>

Signal end of input: drain internal lookahead so the remaining packets become available via receive_packet.