Struct AsyncAudioDecoderBuilder 

pub struct AsyncAudioDecoderBuilder { /* private fields */ }

Async builder for AsyncAudioDecoder that mirrors the options available on the synchronous AudioDecoderBuilder.

Obtain one with AsyncAudioDecoder::builder. Call build to open the file asynchronously on a spawn_blocking thread.

Examples

use ff_decode::AsyncAudioDecoder;
use ff_format::SampleFormat;

let decoder = AsyncAudioDecoder::builder("audio.mp3")
    .output_format(SampleFormat::F32)
    .output_sample_rate(48_000)
    .build()
    .await?;

Implementations

impl AsyncAudioDecoderBuilder

pub fn output_format(self, format: SampleFormat) -> Self

Sets the output sample format for decoded frames.

Equivalent to AudioDecoderBuilder::output_format.

pub fn output_sample_rate(self, sample_rate: u32) -> Self

Sets the output sample rate in Hz.

Equivalent to AudioDecoderBuilder::output_sample_rate.

pub fn output_channels(self, channels: u32) -> Self

Sets the output channel count.

Equivalent to AudioDecoderBuilder::output_channels.

pub async fn build(self) -> Result<AsyncAudioDecoder, DecodeError>

Opens the file and builds the async decoder.

File I/O and codec initialisation run on a spawn_blocking thread so the async executor is not blocked. All errors from AudioDecoderBuilder::build are propagated transparently.

Errors

Returns DecodeError if the file is missing, contains no audio stream, or uses an unsupported codec.