Struct pulseaudio::protocol::command::SinkInfo

pub struct SinkInfo {

    pub index: u32,
    pub name: CString,
    pub description: Option<CString>,
    pub props: Props,
    pub state: SinkState,
    pub sample_spec: SampleSpec,
    pub channel_map: ChannelMap,
    pub owner_module_index: Option<u32>,
    pub cvolume: ChannelVolume,
    pub muted: bool,
    pub monitor_source_index: Option<u32>,
    pub monitor_source_name: Option<CString>,
    pub flags: SinkFlags,
    pub actual_latency: u64,
    pub configured_latency: u64,
    pub driver: Option<CString>,
    pub base_volume: Volume,
    pub volume_steps: Option<u32>,
    pub card_index: Option<u32>,
    pub ports: Vec<PortInfo>,
    pub active_port: usize,
    pub formats: Vec<FormatInfo>,
}

A sink connected to a PulseAudio server. if necessary).

Fields

index: u32

Server-internal sink ID.

name: CString

The human readable name of the sink.

description: Option<CString>

A description of the sink.

props: Props

A list of properties.

state: SinkState

The current state of the sink.

sample_spec: SampleSpec

The format of samples that the sink expects.

channel_map: ChannelMap

The mapping of channels to positions that the sink expects.

owner_module_index: Option<u32>

The ID of the module that owns this sink.

cvolume: ChannelVolume

The volume of the sink.

muted: bool

Whether the sink is muted.

monitor_source_index: Option<u32>

The ID of the monitor source for the sink.

monitor_source_name: Option<CString>

Name of the monitor source for the sink.

flags: SinkFlags

Flags the sink is configured with.

actual_latency: u64

The length of queued audio in the output, in microseconds.

configured_latency: u64

The configured latency of the sink, in microseconds.

driver: Option<CString>

The name of the driver used for this sink.

base_volume: Volume

The base volume of the sink.

volume_steps: Option<u32>

The number of individual steps in volume, for sinks which do not support arbitrary volumes.

card_index: Option<u32>

The index of the card this sink belongs to.

ports: Vec<PortInfo>

A sink has at least one port a plug can be plugged into, and only one port can be active at any given time.

active_port: usize

The index of the currently active port.

formats: Vec<FormatInfo>

The list of supported sample formats.

Implementations

impl SinkInfo

pub fn new_dummy(index: u32) -> Self

Creates a “dummy” sink, which the PulseAudio server returns when there are no sinks.

Trait Implementations

impl Clone for SinkInfo

fn clone(&self) -> SinkInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SinkInfo

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

Formats the value using the given formatter.

impl Default for SinkInfo

fn default() -> SinkInfo

Returns the “default value” for a type.

impl PartialEq for SinkInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TagStructRead for SinkInfo

fn read( ts: &mut TagStructReader<'_>, protocol_version: u16 ) -> Result<SinkInfo, ProtocolError>

Read an instance of Self from a tagstruct.

impl TagStructWrite for SinkInfo

fn write( &self, w: &mut TagStructWriter<'_>, protocol_version: u16 ) -> Result<(), ProtocolError>

Write self into a tagstruct.

impl CommandReply for SinkInfo

impl Eq for SinkInfo

impl StructuralPartialEq for SinkInfo