Struct StreamReaderState 

pub struct StreamReaderState { /* private fields */ }

Implementations

impl StreamReaderState

pub fn new(channels: NonZeroChannelCount) -> Self

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.)out

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 start_stream( &mut self, sample_rate: NonZeroU32, output_stream_sample_rate: NonZeroU32, channel_config: ResamplingChannelConfig, ) -> Result<NewOutputStreamEvent, ()>

Begin the output 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 available_frames(&self) -> usize

The total number of frames (not samples) that can currently be read from 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].

This can also be used to detect when an extra packet of data should be read or discarded to correct for jitter.

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 read_interleaved(&mut self, output: &mut [f32]) -> Option<ReadStatus>

Read from the channel and write the results into the given output buffer in interleaved format.

If there is no active stream, the stream is paused, or the processor end is not ready to send samples, then the output will be filled with zeros and None will be returned.

pub fn read<Vin: AsMut<[f32]>>( &mut self, output: &mut [Vin], range: Range<usize>, ) -> Option<ReadStatus>

Read from the channel and write the results into the given output buffer in de-interleaved format.

• output - The channels to write data to.
• range - The range in each slice in output to write to.

If there is no active stream, the stream is paused, or the processor end is not ready to send samples, then the output will be filled with zeros and None will be returned.

pub fn discard_frames(&mut self) -> usize

Discard a certian number of output frames from the buffer. This can be used to correct for jitter and avoid excessive overflows and reduce the percieved audible glitchiness.

This will discard frames.min(self.available_frames()) frames.

Returns the number of output frames that were discarded.

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

Correct for any overflows.

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

Note, this method is already automatically called in StreamReaderState::read and StreamReaderState::read_interleaved.

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

This method is realtime-safe.

pub fn is_ready(&self) -> bool

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

pub fn pause_stream(&mut self)

Pause any active audio streams.

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 StreamReaderState

fn clone(&self) -> StreamReaderState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for StreamReaderState

fn drop(&mut self)

Executes the destructor for this type.