Struct StreamFormat 

pub struct StreamFormat {
    pub sample_rate: u32,
    pub buffer_size: Option<u32>,
    pub max_buffer_frames: u32,
    pub channels: u16,
    pub sample_rate_request: Requested,
    pub buffer_size_request: Requested,
}

The stream format the device agreed to, and what became of the request.

Fields

sample_rate: u32

The rate the stream actually runs at. Every oscillator increment, envelope time and transport advance must be derived from this number.

buffer_size: Option<u32>

The block size pinned on the stream, or None when the device was left to choose. Nominal even when it is Some: what the callback is actually handed varies from block to block and is scaled by any rate conversion in between. Use it for reporting latency, never for sizing a buffer.

max_buffer_frames: u32

The largest block the callback can be handed. Audio-thread buffers are sized from this so process() never has to grow one.

channels: u16

Output channel count.

sample_rate_request: Requested

What became of the sample rate on the command line.

buffer_size_request: Requested

What became of the block size on the command line.

Implementations

impl StreamFormat

pub fn divergence_notice(&self) -> Option<String>

What the player needs to be told, or None when there is nothing to tell them.

Following the device is the ordinary case and says nothing. Only a refusal is news: they asked for something and are not getting it, and a session that is silently a semitone and a half sharp is exactly the failure this whole path exists to prevent.

Trait Implementations

impl Clone for StreamFormat

fn clone(&self) -> StreamFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamFormat

impl Debug for StreamFormat

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

Formats the value using the given formatter.

impl Eq for StreamFormat

impl From<StreamFormat> for EngineConfig

fn from(format: StreamFormat) -> Self

The config the engine must be built from once a device has been opened.

buffer_size falls back to the largest block the device may deliver when the device was left to choose its own: nothing sizes a buffer from this field any more — the mixer takes max_buffer_frames directly — so the honest value for a block size we were never told is the worst case rather than a guess.

impl PartialEq for StreamFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamFormat