PulseAudio  10.0
pa_source_info Struct Reference

Stores information about sources. More...

Data Fields

const char * name
 Name of the source. More...
 
uint32_t index
 Index of the source. More...
 
const char * description
 Description of this source. More...
 
pa_sample_spec sample_spec
 Sample spec of this source. More...
 
pa_channel_map channel_map
 Channel map. More...
 
uint32_t owner_module
 Owning module index, or PA_INVALID_INDEX. More...
 
pa_cvolume volume
 Volume of the source. More...
 
int mute
 Mute switch of the sink. More...
 
uint32_t monitor_of_sink
 If this is a monitor source, the index of the owning sink, otherwise PA_INVALID_INDEX. More...
 
const char * monitor_of_sink_name
 Name of the owning sink, or NULL. More...
 
pa_usec_t latency
 Length of filled record buffer of this source. More...
 
const char * driver
 Driver name. More...
 
pa_source_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 input device. More...
 
pa_source_state_t state
 State. More...
 
uint32_t n_volume_steps
 Number of volume steps for sources 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_source_port_info ** ports
 Array of available ports, or NULL. More...
 
pa_source_port_infoactive_port
 Pointer to active port in the array, or NULL. More...
 
uint8_t n_formats
 Number of formats supported by the source. More...
 
pa_format_info ** formats
 Array of formats supported by the source. More...
 

Detailed Description

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.

Field Documentation

§ active_port

pa_source_port_info* pa_source_info::active_port

Pointer to active port in the array, or NULL.

Since
0.9.16

§ base_volume

pa_volume_t pa_source_info::base_volume

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

Since
0.9.15

§ card

uint32_t pa_source_info::card

Card index, or PA_INVALID_INDEX.

Since
0.9.15

§ channel_map

pa_channel_map pa_source_info::channel_map

Channel map.

§ configured_latency

pa_usec_t pa_source_info::configured_latency

The latency this device has been configured to.

Since
0.9.11

§ description

const char* pa_source_info::description

Description of this source.

§ driver

const char* pa_source_info::driver

Driver name.

§ flags

pa_source_flags_t pa_source_info::flags

Flags.

§ formats

pa_format_info** pa_source_info::formats

Array of formats supported by the source.

Since
1.0

§ index

uint32_t pa_source_info::index

Index of the source.

§ latency

pa_usec_t pa_source_info::latency

Length of filled record buffer of this source.

§ monitor_of_sink

uint32_t pa_source_info::monitor_of_sink

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

§ monitor_of_sink_name

const char* pa_source_info::monitor_of_sink_name

Name of the owning sink, or NULL.

§ mute

int pa_source_info::mute

Mute switch of the sink.

§ n_formats

uint8_t pa_source_info::n_formats

Number of formats supported by the source.

Since
1.0

§ n_ports

uint32_t pa_source_info::n_ports

Number of entries in port array.

Since
0.9.16

§ n_volume_steps

uint32_t pa_source_info::n_volume_steps

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

Since
0.9.15

§ name

const char* pa_source_info::name

Name of the source.

§ owner_module

uint32_t pa_source_info::owner_module

Owning module index, or PA_INVALID_INDEX.

§ ports

pa_source_port_info** pa_source_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

§ proplist

pa_proplist* pa_source_info::proplist

Property list.

Since
0.9.11

§ sample_spec

pa_sample_spec pa_source_info::sample_spec

Sample spec of this source.

§ state

pa_source_state_t pa_source_info::state

State.

Since
0.9.15

§ volume

pa_cvolume pa_source_info::volume

Volume of the source.


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