logo
pub struct SinkInfo<'a> {
Show 22 fields 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_source: u32, pub monitor_source_name: Option<Cow<'a, str>>, pub latency: MicroSeconds, pub driver: Option<Cow<'a, str>>, pub flags: SinkFlagSet, pub proplist: Proplist, pub configured_latency: MicroSeconds, pub base_volume: Volume, pub state: SinkState, pub n_volume_steps: u32, pub card: Option<u32>, pub ports: Vec<SinkPortInfo<'a>>, pub active_port: Option<Box<SinkPortInfo<'a>>>, pub formats: Vec<Info>,
}
Expand description

Stores information about sinks.

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

index: u32

Index of the sink.

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

Description of this sink.

sample_spec: Spec

Sample spec of this sink.

channel_map: Map

Channel map.

owner_module: Option<u32>

Index of the owning module of this sink, or None if is invalid.

volume: ChannelVolumes

Volume of the sink.

mute: bool

Mute switch of the sink.

monitor_source: u32

Index of the monitor source connected to this sink.

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

The name of the monitor source.

latency: MicroSeconds

Length of queued audio in the output buffer.

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

Driver name.

flags: SinkFlagSet

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 output device.

state: SinkState

State.

n_volume_steps: u32

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

card: Option<u32>

Card index, or None if invalid.

ports: Vec<SinkPortInfo<'a>>

Set of available ports.

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

Pointer to active port in the set, or None.

formats: Vec<Info>

Set of formats supported by the sink.

Trait Implementations

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.