pa_sink_info Struct Reference

Stores information about sinks. More...


Data Fields

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


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

const char* pa_sink_info::name

Name of the sink.

Index of the sink.

Description of this sink.

Sample spec of this sink.

Channel map.

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

Volume of the sink.

Mute switch of the sink.

Index of the monitor source connected to this sink.

The name of the monitor source.

Length of queued audio in the output buffer.

const char* pa_sink_info::driver

Driver name.

Flags.

Property list.

Since:
0.9.11

The latency this device has been configured to.

Since:
0.9.11

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

Since:
0.9.15

State.

Since:
0.9.15

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

Since:
0.9.15

Card index, or PA_INVALID_INDEX.

Since:
0.9.15


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

Generated on Mon Jun 14 16:31:37 2010 for PulseAudio by  doxygen 1.5.6