Struct SinkInputInfo

Source
pub struct SinkInputInfo<'a> {
Show 18 fields pub index: u32, pub name: Option<Cow<'a, str>>, pub owner_module: Option<u32>, pub client: Option<u32>, pub sink: u32, pub sample_spec: Spec, pub channel_map: Map, pub volume: ChannelVolumes, pub buffer_usec: MicroSeconds, pub sink_usec: MicroSeconds, pub resample_method: Option<Cow<'a, str>>, pub driver: Option<Cow<'a, str>>, pub mute: bool, pub proplist: Proplist, pub corked: bool, pub has_volume: bool, pub volume_writable: bool, pub format: Info,
}
Expand description

Stores information about sink inputs.

Please note that this structure can be extended as part of evolutionary API updates at any time in any new release.

Fields§

§index: u32

Index of the sink input.

§name: Option<Cow<'a, str>>

Name of the sink input.

§owner_module: Option<u32>

Index of the module this sink input belongs to, or None when it does not belong to any module.

§client: Option<u32>

Index of the client this sink input belongs to, or invalid when it does not belong to any client.

§sink: u32

Index of the connected sink.

§sample_spec: Spec

The sample specification of the sink input.

§channel_map: Map

Channel map.

§volume: ChannelVolumes

The volume of this sink input.

§buffer_usec: MicroSeconds

Latency due to buffering in sink input, see TimingInfo for details.

§sink_usec: MicroSeconds

Latency of the sink device, see TimingInfo for details.

§resample_method: Option<Cow<'a, str>>

The resampling method used by this sink input.

§driver: Option<Cow<'a, str>>

Driver name.

§mute: bool

Stream muted.

§proplist: Proplist

Property list.

§corked: bool

Stream corked.

§has_volume: bool

Stream has volume. If not set, then the meaning of this struct’s volume member is unspecified.

§volume_writable: bool

The volume can be set. If not set, the volume can still change even though clients can’t control the volume.

§format: Info

Stream format information.

Implementations§

Source§

impl SinkInputInfo<'_>

Source

pub fn to_owned(&self) -> SinkInputInfo<'static>

Creates a copy with owned data.

Trait Implementations§

Source§

impl<'a> Debug for SinkInputInfo<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SinkInputInfo<'a>

§

impl<'a> RefUnwindSafe for SinkInputInfo<'a>

§

impl<'a> Send for SinkInputInfo<'a>

§

impl<'a> Sync for SinkInputInfo<'a>

§

impl<'a> Unpin for SinkInputInfo<'a>

§

impl<'a> UnwindSafe for SinkInputInfo<'a>

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> 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, 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.