Struct AsyncAudioEncoder 

pub struct AsyncAudioEncoder { /* private fields */ }

Async wrapper around AudioEncoder.

Frames are queued into a bounded channel (capacity 8) and encoded by a dedicated worker thread. When the channel is full, push suspends the caller, providing natural back-pressure.

Construction

Use AudioEncoder::create to configure the encoder, then call AsyncAudioEncoder::from_builder:

use ff_encode::{AsyncAudioEncoder, AudioEncoder, AudioCodec};

let mut encoder = AsyncAudioEncoder::from_builder(
    AudioEncoder::create("output.m4a")
        .audio(48000, 2)
        .audio_codec(AudioCodec::Aac),
)?;

encoder.push(frame).await?;
encoder.finish().await?;

Back-pressure

The internal channel holds at most 8 frames. Once that buffer is full, push yields until the worker drains a slot. This prevents unbounded memory growth when the encoder cannot keep up with the incoming frame rate.

Implementations

impl AsyncAudioEncoder

pub fn from_builder(builder: AudioEncoderBuilder) -> Result<Self, EncodeError>

Builds an async encoder from a configured builder.

Consumes the builder, validates the configuration, opens the output file, and starts the worker thread. The worker runs the synchronous FFmpeg encode loop in the background.

Errors

Returns EncodeError if the builder configuration is invalid or the output file cannot be created.

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

Queues an audio frame for encoding.

If the internal channel (capacity 8) is full, this method suspends the caller until the worker drains a slot.

Errors

Returns EncodeError::WorkerPanicked if the worker thread has exited unexpectedly.

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

Signals end-of-stream, flushes remaining frames, and writes the file trailer.

Drops the channel sender (signalling EOF to the worker), then waits for the worker thread to finish without blocking the async executor. Any error from the worker is propagated back to the caller.

Errors

Returns EncodeError if encoding fails during flush or if the worker thread panicked.

Trait Implementations

impl Debug for AsyncAudioEncoder

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

Formats the value using the given formatter.