MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

pa_source_info Struct Reference

Stores information about sources. More...

Data Fields

const char *  name
  Name of the source.
uint32_t  index
  Index of the source.
const char *  description
  Description of this source.
pa_sample_spec  sample_spec
  Sample spec of this source.
pa_channel_map  channel_map
  Channel map.
uint32_t  owner_module
  Owning module index, or PA_INVALID_INDEX.
pa_cvolume  volume
  Volume of the source.
int  mute
  Mute switch of the sink.
uint32_t  monitor_of_sink
  If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX.
const char *  monitor_of_sink_name
  Name of the owning sink, or PA_INVALID_INDEX.
pa_usec_t  latency
  Length of filled record buffer of this source.
const char *  driver
  Driver name.
pa_source_flags_t  flags
  Flags.
pa_proplist *  proplist
  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 input device.
pa_source_state_t  state
  State.
uint32_t  n_volume_steps
  Number of volume steps for sources which do not support arbitrary volumes.
uint32_t  card
  Card index, or PA_INVALID_INDEX.
uint32_t  n_ports
  Number of entries in port array.
pa_source_port_info **  ports
  Array of available ports, or NULL.
pa_source_port_info active_port
  Pointer to active port in the array, or NULL.

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

Pointer to active port in the array, or NULL.

Since:
0.9.16

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

Since:
0.9.15

Card index, or PA_INVALID_INDEX.

Since:
0.9.15

The latency this device has been configured to.

Since:
0.9.11

Description of this source.

Driver name.

pa_source_flags_t pa_source_info::flags

Flags.

Index of the source.

Length of filled record buffer of this source.

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

Name of the owning sink, or PA_INVALID_INDEX.

Mute switch of the sink.

Number of entries in port array.

Since:
0.9.16

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

Since:
0.9.15
const char* pa_source_info::name

Name of the source.

Owning module index, or PA_INVALID_INDEX.

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

Property list.

Since:
0.9.11

Sample spec of this source.

pa_source_state_t pa_source_info::state

State.

Since:
0.9.15

Volume of the source.


Several copyright owners
GNU Lesser General Public License v2.1
MeeGo 1.2 Harmattan API