Struct FileOutputBlock

pub struct FileOutputBlock<S>
where
    S: Sample,
{ /* private fields */ }

Writes audio from the DSP graph to a file.

This block uses a separate I/O thread to perform disk writes, avoiding blocking the audio thread. Samples are passed through a lock-free ring buffer.

Implementations

impl<S> FileOutputBlock<S>

where S: Sample + Send + 'static,

pub fn new(writer: Box<dyn Writer<S>>) -> FileOutputBlock<S>

Create a FileOutputBlock with the Writer implementation for a particular type of audio file.

The writer is moved to a background I/O thread. Samples are passed through a lock-free ring buffer to avoid blocking the audio thread.

pub fn start_recording(&mut self)

Tell the writer to begin storing audio sample data.

pub fn stop_recording(&mut self) -> Result<(), Box<dyn Error>>

Tell the writer to stop storing audio sample data.

This signals the I/O thread to flush remaining samples and finalize the file. The method blocks until the I/O thread completes.

pub fn is_recording(&self) -> bool

Check whether the writer is actively storing audio sample data.

pub fn error_occurred(&self) -> bool

Check whether any write errors have occurred.

This can be queried periodically to detect I/O failures without blocking the audio thread.

Trait Implementations

impl<S> Block<S> for FileOutputBlock<S>

where S: Sample + Send + 'static,

fn process( &mut self, inputs: &[&[S]], _outputs: &mut [&mut [S]], _modulation_values: &[S], _context: &DspContext, )

Process audio through this block.

fn input_count(&self) -> usize

Returns the number of input ports this block accepts.

fn output_count(&self) -> usize

Returns the number of output ports this block produces.

fn modulation_outputs(&self) -> &[ModulationOutput]

Returns the modulation outputs this block provides.

fn channel_config(&self) -> ChannelConfig

Returns how this block handles multi-channel audio.

fn set_smoothing(&mut self, _sample_rate: f64, _ramp_time_ms: f64)

Configure smoothing time for parameter changes.

impl<S> Drop for FileOutputBlock<S>

where S: Sample + Send + 'static,

fn drop(&mut self)

Executes the destructor for this type.

impl<S> From<FileOutputBlock<S>> for BlockType<S>

where S: Sample,

fn from(block: FileOutputBlock<S>) -> BlockType<S>

Converts to this type from the input type.