Struct SourceInfo

pub struct SourceInfo<'a> {

    pub name: Option<Cow<'a, str>>,
    pub index: u32,
    pub description: Option<Cow<'a, str>>,
    pub sample_spec: Spec,
    pub channel_map: Map,
    pub owner_module: Option<u32>,
    pub volume: ChannelVolumes,
    pub mute: bool,
    pub monitor_of_sink: Option<u32>,
    pub monitor_of_sink_name: Option<Cow<'a, str>>,
    pub latency: MicroSeconds,
    pub driver: Option<Cow<'a, str>>,
    pub flags: SourceFlagSet,
    pub proplist: Proplist,
    pub configured_latency: MicroSeconds,
    pub base_volume: Volume,
    pub state: SourceState,
    pub n_volume_steps: u32,
    pub card: Option<u32>,
    pub ports: Vec<SourcePortInfo<'a>>,
    pub active_port: Option<Box<SourcePortInfo<'a>>>,
    pub formats: Vec<Info>,
}

Stores information about sources.

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

Fields

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

Name of the source.

index: u32

Index of the source.

description: Option<Cow<'a, str>>

Description of this source.

sample_spec: Spec

Sample spec of this source.

channel_map: Map

Channel map.

owner_module: Option<u32>

Owning module index, or None.

volume: ChannelVolumes

Volume of the source.

mute: bool

Mute switch of the sink.

monitor_of_sink: Option<u32>

If this is a monitor source, the index of the owning sink, otherwise None.

monitor_of_sink_name: Option<Cow<'a, str>>

Name of the owning sink, or None.

latency: MicroSeconds

Length of filled record buffer of this source.

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

Driver name.

flags: SourceFlagSet

Flags.

proplist: Proplist

Property list.

configured_latency: MicroSeconds

The latency this device has been configured to.

base_volume: Volume

Some kind of “base” volume that refers to unamplified/unattenuated volume in the context of the input device.

state: SourceState

State.

n_volume_steps: u32

Number of volume steps for sources which do not support arbitrary volumes.

card: Option<u32>

Card index, or None.

ports: Vec<SourcePortInfo<'a>>

Set of available ports.

active_port: Option<Box<SourcePortInfo<'a>>>

Pointer to active port in the set, or None.

formats: Vec<Info>

Set of formats supported by the sink.

Implementations

impl SourceInfo<'_>

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

Creates a copy with owned data.

Trait Implementations

impl<'a> Debug for SourceInfo<'a>

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

Formats the value using the given formatter.