PulseAudio  5.0
pa_sink_info Struct Reference

Stores information about sinks. More...

Data Fields

const char * name
 Name of the sink. More...
 
uint32_t index
 Index of the sink. More...
 
const char * description
 Description of this sink. More...
 
pa_sample_spec sample_spec
 Sample spec of this sink. More...
 
pa_channel_map channel_map
 Channel map. More...
 
uint32_t owner_module
 Index of the owning module of this sink, or PA_INVALID_INDEX. More...
 
pa_cvolume volume
 Volume of the sink. More...
 
int mute
 Mute switch of the sink. More...
 
uint32_t monitor_source
 Index of the monitor source connected to this sink. More...
 
const char * monitor_source_name
 The name of the monitor source. More...
 
pa_usec_t latency
 Length of queued audio in the output buffer. More...
 
const char * driver
 Driver name. More...
 
pa_sink_flags_t flags
 Flags. More...
 
pa_proplistproplist
 Property list. More...
 
pa_usec_t configured_latency
 The latency this device has been configured to. More...
 
pa_volume_t base_volume
 Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the output device. More...
 
pa_sink_state_t state
 State. More...
 
uint32_t n_volume_steps
 Number of volume steps for sinks which do not support arbitrary volumes. More...
 
uint32_t card
 Card index, or PA_INVALID_INDEX. More...
 
uint32_t n_ports
 Number of entries in port array. More...
 
pa_sink_port_info ** ports
 Array of available ports, or NULL. More...
 
pa_sink_port_infoactive_port
 Pointer to active port in the array, or NULL. More...
 
uint8_t n_formats
 Number of formats supported by the sink. More...
 
pa_format_info ** formats
 Array of formats supported by the sink. More...
 

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

Field Documentation

pa_sink_port_info* pa_sink_info::active_port

Pointer to active port in the array, or NULL.

Since
0.9.16
pa_volume_t pa_sink_info::base_volume

Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the output device.

Since
0.9.15
uint32_t pa_sink_info::card

Card index, or PA_INVALID_INDEX.

Since
0.9.15
pa_channel_map pa_sink_info::channel_map

Channel map.

pa_usec_t pa_sink_info::configured_latency

The latency this device has been configured to.

Since
0.9.11
const char* pa_sink_info::description

Description of this sink.

const char* pa_sink_info::driver

Driver name.

pa_sink_flags_t pa_sink_info::flags

Flags.

pa_format_info** pa_sink_info::formats

Array of formats supported by the sink.

Since
1.0
uint32_t pa_sink_info::index

Index of the sink.

pa_usec_t pa_sink_info::latency

Length of queued audio in the output buffer.

uint32_t pa_sink_info::monitor_source

Index of the monitor source connected to this sink.

const char* pa_sink_info::monitor_source_name

The name of the monitor source.

int pa_sink_info::mute

Mute switch of the sink.

uint8_t pa_sink_info::n_formats

Number of formats supported by the sink.

Since
1.0
uint32_t pa_sink_info::n_ports

Number of entries in port array.

Since
0.9.16
uint32_t pa_sink_info::n_volume_steps

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

Since
0.9.15
const char* pa_sink_info::name

Name of the sink.

uint32_t pa_sink_info::owner_module

Index of the owning module of this sink, or PA_INVALID_INDEX.

pa_sink_port_info** pa_sink_info::ports

Array of available ports, or NULL.

Array is terminated by an entry set to NULL. The number of entries is stored in n_ports.

Since
0.9.16
pa_proplist* pa_sink_info::proplist

Property list.

Since
0.9.11
pa_sample_spec pa_sink_info::sample_spec

Sample spec of this sink.

pa_sink_state_t pa_sink_info::state

State.

Since
0.9.15
pa_cvolume pa_sink_info::volume

Volume of the sink.


The documentation for this struct was generated from the following file: