Struct NativeWavEncodeSink 

pub struct NativeWavEncodeSink { /* private fields */ }

Transactional IEEE-f32 WAV encoder used by native offline audio export.

Implementations

impl NativeWavEncodeSink

pub fn create( path: impl AsRef<Path>, sample_rate: u32, channels: u16, ) -> Result<Self, EncodeError>

Creates a non-overwriting sibling-partial WAV output of channels in the count’s default layout.

Errors

Returns an error for invalid PCM format, existing paths, or filesystem failures.

pub fn create_with_speakers( path: impl AsRef<Path>, sample_rate: u32, speakers: SpeakerLayout, ) -> Result<Self, EncodeError>

Creates a WAV output whose blocks feed speakers.

The count’s default layout gets a plain header, which every reader takes as that layout. Any other is written as WAVE_FORMAT_EXTENSIBLE with its channel mask, the planes in the mask’s bit order, which WAVE requires.

Errors

Returns an error for invalid PCM format, a layout a WAVE channel mask cannot say (an unnamed or repeated speaker, or one past the 18 WAVE positions), existing paths, or filesystem failures.

Trait Implementations

impl AudioBlockSink for NativeWavEncodeSink

fn write_audio( &mut self, block: &AudioBlock, cancel: &CancelToken, ) -> Result<(), EncodeError>

Writes one monotonic audio block.

fn finish_audio(&mut self, cancel: &CancelToken) -> Result<(), EncodeError>

Drains and commits the sink.

fn abort_audio(&mut self) -> Result<(), EncodeError>

Discards partial output.

impl Drop for NativeWavEncodeSink

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl EncodeSink for NativeWavEncodeSink

fn write( &mut self, event: EncodeEvent, cancel: &CancelToken, ) -> Result<(), EncodeError>

Queues one timestamped media item.

fn finish(&mut self, cancel: &CancelToken) -> Result<(), EncodeError>

Drains encoder delay, interleaves remaining packets, and writes the trailer.

fn abort(&mut self) -> Result<(), EncodeError>

Aborts and applies the adapter’s partial-output cleanup policy.