Skip to main content

StreamSpec

Struct StreamSpec 

Source
pub struct StreamSpec { /* private fields */ }
Expand description

A declarative description of one stream on a device.

The framework turns a StreamSpec into an kAudioStreamClassID audio object, answers the HAL’s property queries about it (direction, starting channel, virtual format), and routes the stream’s samples into Driver::process_io. Build one with StreamSpec::input / StreamSpec::output and the builder-style setters.

Implementations§

Source§

impl StreamSpec

Source

pub const fn input(format: StreamFormat) -> Self

An input stream carrying format, starting at channel 1.

Source

pub const fn output(format: StreamFormat) -> Self

An output stream carrying format, starting at channel 1.

Source

pub const fn with_starting_channel(self, channel: u32) -> Self

Builder-style: set the 1-based channel this stream’s first channel maps to within the owning device.

Source

pub const fn with_format(self, format: StreamFormat) -> Self

Builder-style: replace the stream format.

Source

pub const fn direction(&self) -> StreamDirection

The direction this stream carries audio.

Source

pub const fn starting_channel(&self) -> u32

The 1-based starting channel (kAudioStreamPropertyStartingChannel).

Source

pub const fn format(&self) -> StreamFormat

The stream’s StreamFormat (kAudioStreamPropertyVirtualFormat).

Source

pub const fn channels(&self) -> u32

The stream’s channel count, taken from its format.

Trait Implementations§

Source§

impl Clone for StreamSpec

Source§

fn clone(&self) -> StreamSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for StreamSpec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for StreamSpec

Source§

impl StructuralPartialEq for StreamSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.