Struct cpal::SupportedStreamConfigRange

pub struct SupportedStreamConfigRange { /* private fields */ }

Describes a range of supported stream configurations, retrieved via the Device::supported_input/output_configs method.

Implementations

impl SupportedStreamConfigRange

pub fn new( channels: ChannelCount, min_sample_rate: SampleRate, max_sample_rate: SampleRate, buffer_size: SupportedBufferSize, sample_format: SampleFormat, ) -> Self

pub fn channels(&self) -> ChannelCount

pub fn min_sample_rate(&self) -> SampleRate

pub fn max_sample_rate(&self) -> SampleRate

pub fn buffer_size(&self) -> &SupportedBufferSize

pub fn sample_format(&self) -> SampleFormat

pub fn with_sample_rate(self, sample_rate: SampleRate) -> SupportedStreamConfig

Retrieve a SupportedStreamConfig with the given sample rate and buffer size.

Panics

Panics if the given sample_rate is outside the range specified within this SupportedStreamConfigRange instance. For a non-panicking variant, use try_with_sample_rate.

pub fn try_with_sample_rate( self, sample_rate: SampleRate, ) -> Option<SupportedStreamConfig>

Retrieve a SupportedStreamConfig with the given sample rate and buffer size.

Returns None if the given sample rate is outside the range specified within this SupportedStreamConfigRange instance.

pub fn with_max_sample_rate(self) -> SupportedStreamConfig

Turns this SupportedStreamConfigRange into a SupportedStreamConfig corresponding to the maximum samples rate.

pub fn cmp_default_heuristics(&self, other: &Self) -> Ordering

A comparison function which compares two SupportedStreamConfigRanges in terms of their priority of use as a default stream format.

Some backends do not provide a default stream format for their audio devices. In these cases, CPAL attempts to decide on a reasonable default format for the user. To do this we use the “greatest” of all supported stream formats when compared with this method.

SupportedStreamConfigs are prioritised by the following heuristics:

Channels:

• Stereo
• Mono
• Max available channels

Sample format:

• f32
• i16
• u16

Sample rate:

• 44100 (cd quality)
• Max sample rate

Trait Implementations

impl Clone for SupportedStreamConfigRange

fn clone(&self) -> SupportedStreamConfigRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SupportedStreamConfigRange

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

Formats the value using the given formatter.

impl PartialEq for SupportedStreamConfigRange

fn eq(&self, other: &SupportedStreamConfigRange) -> 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 Copy for SupportedStreamConfigRange

impl Eq for SupportedStreamConfigRange

impl StructuralPartialEq for SupportedStreamConfigRange