Struct StreamInfo 

pub struct StreamInfo {
    pub sample_rate: NonZeroU32,
    pub sample_rate_recip: f64,
    pub prev_sample_rate: NonZeroU32,
    pub max_block_frames: NonZeroU32,
    pub num_stream_in_channels: u32,
    pub num_stream_out_channels: u32,
    pub input_to_output_latency_seconds: f64,
    pub declick_frames: NonZeroU32,
    pub output_device_id: String,
    pub input_device_id: Option<String>,
}

Information about a running audio stream.

Fields

sample_rate: NonZeroU32

The sample rate of the audio stream.

sample_rate_recip: f64

The reciprocal of the sample rate.

This is provided for convenience since dividing by the sample rate is such a common operation.

Note to users implementing a custom AudioBackend: The context will overwrite this value, so just set this to the default value.

prev_sample_rate: NonZeroU32

The sample rate of the previous stream. (If this is the first stream, then this will just be a copy of StreamInfo::sample_rate).

Note to users implementing a custom AudioBackend: The context will overwrite this value, so just set this to the default value.

max_block_frames: NonZeroU32

The maximum number of frames that can appear in a single process cyle.

num_stream_in_channels: u32

The number of input audio channels in the stream.

num_stream_out_channels: u32

The number of output audio channels in the stream.

input_to_output_latency_seconds: f64

The latency of the input to output stream in seconds.

declick_frames: NonZeroU32

The number of frames used in the shared declicker DSP.

Note to users implementing a custom AudioBackend: The context will overwrite this value, so just set this to the default value.

output_device_id: String

The identifier of the output audio device (converted to a string).

input_device_id: Option<String>

The identifier of the input audio device (converted to a string).

Trait Implementations

impl Clone for StreamInfo

fn clone(&self) -> StreamInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamInfo

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for StreamInfo

fn eq(&self, other: &StreamInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamInfo