Skip to main content

HostStreamConfig

Struct HostStreamConfig 

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

Accepted stream configuration returned by a host backend.

Implementations§

Source§

impl HostStreamConfig

Source

pub fn from_request( request: HostStreamConfigRequest, latency: HostLatencyInfo, clock: HostClockInfo, ) -> Self

Builds an accepted configuration from a request plus the backend’s resolved latency and clock metadata.

Source

pub fn backend(&self) -> &Symbol

Returns the backend that accepted the stream.

Source

pub fn device(&self) -> &Symbol

Returns the opened device symbol.

Source

pub fn media(&self) -> StreamMedia

Returns the accepted stream media.

Source

pub fn direction(&self) -> HostDirection

Returns the accepted stream direction.

Source

pub fn buffer(&self) -> &BufferPolicy

Returns the accepted buffer policy.

Source

pub fn clock(&self) -> &HostClockInfo

Returns the resolved clock metadata.

Source

pub fn latency(&self) -> HostLatencyInfo

Returns the resolved latency estimate.

Source

pub fn reconnect(&self) -> &HostReconnectPolicy

Returns the accepted reconnect policy.

Source

pub fn metadata(&self) -> StreamMetadata

Builds the StreamMetadata describing the opened stream.

Source

pub fn validate_realtime_local_audio(&self) -> Result<()>

Checks that this configuration is a valid realtime local audio stream.

Requires PCM media, the sample clock domain, and a bounded buffer; returns an evaluation error otherwise.

Source

pub fn validate_lan_midi_control(&self) -> Result<()>

Checks that this configuration is a valid LAN MIDI/control stream.

Requires MIDI media, a MIDI-tick or control clock domain, and a bounded buffer; returns an evaluation error otherwise.

Source

pub fn validate_lan_buffered_audio_preview(&self) -> Result<()>

Checks that this configuration is a valid LAN buffered audio preview stream.

Requires PCM media and a bounded buffer; returns an evaluation error otherwise.

Trait Implementations§

Source§

impl Clone for HostStreamConfig

Source§

fn clone(&self) -> HostStreamConfig

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 HostStreamConfig

Source§

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

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

impl Eq for HostStreamConfig

Source§

impl PartialEq for HostStreamConfig

Source§

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

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.