Struct StreamWriterState 

pub struct StreamWriterState { /* private fields */ }

Implementations

impl StreamWriterState

pub fn is_active(&self) -> bool

Returns true if there is there is currently an active stream on this node.

pub fn underflow_occurred(&self) -> bool

Returns true if an underflow occured (due to the output stream running faster than the input stream).

If this happens excessively in Release mode, you may want to consider increasing ResamplingChannelConfig::latency_seconds.

(Calling this will also reset the flag indicating whether an underflow occurred.)

pub fn overflow_occurred(&self) -> bool

Returns true if an overflow occured (due to the input stream running faster than the output stream).

If this happens excessively in Release mode, you may want to consider increasing ResamplingChannelConfig::capacity_seconds. For example, if you are streaming data from a network, you may want to increase the capacity to several seconds.

(Calling this will also reset the flag indicating whether an overflow occurred.)

pub fn available_frames(&self) -> usize

The total number of frames (not samples) that can currently be pushed to the stream.

If there is no active stream, the stream is paused, or the processor end is not ready to receive samples, then this will return 0.

pub fn occupied_seconds(&self) -> Option<f64>

The amount of data in seconds that is currently occupied in the channel.

This value will be in the range [0.0, ResamplingChannelConfig::capacity_seconds].

If there is no active stream, then this will return None.

pub fn num_channels(&self) -> NonZeroChannelCount

The number of channels in this node.

pub fn sample_rate(&self) -> Option<NonZeroU32>

The sample rate of the active stream.

Returns None if there is no active stream.

pub fn start_stream( &mut self, sample_rate: NonZeroU32, output_stream_sample_rate: NonZeroU32, channel_config: ResamplingChannelConfig, ) -> Result<NewInputStreamEvent, ()>

Begin the input audio stream on this node.

The returned event must be sent to the node’s processor for this to take effect.

• sample_rate - The sample rate of this node.
• output_stream_sample_rate - The sample rate of the active output audio stream.
• channel_config - The configuration of the input to output channel.

If there is already an active stream running on this node, then this will return an error.

pub fn push_interleaved(&mut self, data: &[f32]) -> PushStatus

Push the given data in interleaved format.

Returns the number of frames (not samples) that were successfully pushed. If this number is less than the number of frames in data, then it means an overflow has occured.

If there is no active stream, the stream is paused, or the processor end is not ready to receive samples, then no data will be sent and this will return 0.

pub fn push<Vin: AsRef<[f32]>>( &mut self, data: &[Vin], range: Range<usize>, ) -> PushStatus

Push the given data in de-interleaved format.

• data - The channels of data to push to the channel.
• range - The range in each slice in input to read data from.

Returns the number of frames (not samples) that were successfully pushed. If this number is less than the number of frames in data, then it means an overflow has occured. b If there is no active stream, the stream is paused, or the processor end is not ready to receive samples, then no data will be sent and this will return 0.

pub fn is_ready(&self) -> bool

Returns true if the processor end of the stream is ready to start receiving data.

pub fn pause_stream(&mut self)

Pause any active audio streams.

pub fn autocorrect_underflows(&mut self) -> Option<usize>

Correct for any underflows.

This returns the number of extra zero frames (samples in a single channel of audio) that were added due to an underflow occurring. If no underflow occured, then None is returned.

Note, this method is already automatically called in StreamWriterState::push and StreamWriterState::push_interleaved.

This will have no effect if ResamplingChannelConfig::underflow_autocorrect_percent_threshold was set to None.

This method is realtime-safe.

pub fn resume(&mut self)

Resume any active audio streams after pausing.

pub fn stop_stream(&mut self)

pub fn handle(&self) -> Mutex<Self>

Trait Implementations

impl Clone for StreamWriterState

fn clone(&self) -> StreamWriterState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for StreamWriterState

fn drop(&mut self)

Executes the destructor for this type.