pulse.channelmap

Undocumented in source.

Members

Aliases

pa_channel_map_def_t
alias pa_channel_map_def_t = pa_channel_map_def
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
pa_channel_position_mask_t
alias pa_channel_position_mask_t = c_ulong

A mask of channel positions. \since 0.9.16

pa_channel_position_t
alias pa_channel_position_t = pa_channel_position
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

pa_channel_map_def
enum pa_channel_map_def

A list of channel mapping definitions for pa_channel_map_init_auto()

pa_channel_position
enum pa_channel_position

A list of channel labels

Functions

PA_CHANNEL_POSITION_MASK
auto PA_CHANNEL_POSITION_MASK(T f)

Makes a bit mask from a channel position. \since 0.9.16

pa_channel_map_can_balance
int pa_channel_map_can_balance(const(pa_channel_map)* map)

Returns non-zero if it makes sense to apply a volume 'balance' * with this mapping, i.e.\ if there are left/right channels * available. \since 0.9.15

pa_channel_map_can_fade
int pa_channel_map_can_fade(const(pa_channel_map)* map)

Returns non-zero if it makes sense to apply a volume 'fade' * (i.e.\ 'balance' between front and rear) with this mapping, i.e.\ if * there are front/rear channels available. \since 0.9.15

pa_channel_map_can_lfe_balance
int pa_channel_map_can_lfe_balance(const(pa_channel_map)* map)

Returns non-zero if it makes sense to apply a volume 'lfe balance' * (i.e.\ 'balance' between LFE and non-LFE channels) with this mapping, * i.e.\ if there are LFE and non-LFE channels available. \since 8.0

pa_channel_map_compatible
int pa_channel_map_compatible(const(pa_channel_map)* map, const(pa_sample_spec)* ss)

Return non-zero if the specified channel map is compatible with * the specified sample spec. \since 0.9.12

pa_channel_map_equal
int pa_channel_map_equal(const(pa_channel_map)* a, const(pa_channel_map)* b)

Compare two channel maps. Return 1 if both match.

pa_channel_map_has_position
int pa_channel_map_has_position(const(pa_channel_map)* map, pa_channel_position_t p)

Returns non-zero if the specified channel position is available at * least once in the channel map. \since 0.9.16

pa_channel_map_init
pa_channel_map* pa_channel_map_init(pa_channel_map* m)

Initialize the specified channel map and return a pointer to * it. The channel map will have a defined state but * pa_channel_map_valid() will fail for it.

pa_channel_map_init_auto
pa_channel_map* pa_channel_map_init_auto(pa_channel_map* m, uint channels, pa_channel_map_def_t def)

Initialize the specified channel map for the specified number of * channels using default labels and return a pointer to it. This call * will fail (return NULL) if there is no default channel map known for this * specific number of channels and mapping.

pa_channel_map_init_extend
pa_channel_map* pa_channel_map_init_extend(pa_channel_map* m, uint channels, pa_channel_map_def_t def)

Similar to pa_channel_map_init_auto() but instead of failing if no * default mapping is known with the specified parameters it will * synthesize a mapping based on a known mapping with fewer channels * and fill up the rest with AUX0...AUX31 channels \since 0.9.11

pa_channel_map_init_mono
pa_channel_map* pa_channel_map_init_mono(pa_channel_map* m)

Initialize the specified channel map for monaural audio and return a pointer to it

pa_channel_map_init_stereo
pa_channel_map* pa_channel_map_init_stereo(pa_channel_map* m)

Initialize the specified channel map for stereophonic audio and return a pointer to it

pa_channel_map_mask
pa_channel_position_mask_t pa_channel_map_mask(const(pa_channel_map)* map)

Generates a bit mask from a channel map. \since 0.9.16

pa_channel_map_parse
pa_channel_map* pa_channel_map_parse(pa_channel_map* map, const(char)* s)

Parse a channel position list or well-known mapping name into a * channel map structure. This turns the output of * pa_channel_map_snprint() and pa_channel_map_to_name() back into a * pa_channel_map

pa_channel_map_snprint
char* pa_channel_map_snprint(char* s, size_t l, const(pa_channel_map)* map)

Make a human readable string from the specified channel map. Returns \a s.

pa_channel_map_superset
int pa_channel_map_superset(const(pa_channel_map)* a, const(pa_channel_map)* b)

Returns non-zero if every channel defined in b is also defined in a. \since 0.9.15

pa_channel_map_to_name
const(char)* pa_channel_map_to_name(const(pa_channel_map)* map)

Tries to find a well-known channel mapping name for this channel * mapping, i.e.\ "stereo", "surround-71" and so on. If the channel * mapping is unknown NULL will be returned. This name can be parsed * with pa_channel_map_parse() \since 0.9.15

pa_channel_map_to_pretty_name
const(char)* pa_channel_map_to_pretty_name(const(pa_channel_map)* map)

Tries to find a human readable text label for this channel mapping, i.e.\ "Stereo", "Surround 7.1" and so on. If the channel mapping is unknown NULL will be returned. \since 0.9.15

pa_channel_map_valid
int pa_channel_map_valid(const(pa_channel_map)* map)

Return non-zero if the specified channel map is considered valid

pa_channel_position_from_string
pa_channel_position_t pa_channel_position_from_string(const(char)* s)

The inverse of pa_channel_position_to_string(). \since 0.9.16

pa_channel_position_to_pretty_string
const(char)* pa_channel_position_to_pretty_string(pa_channel_position_t pos)

Return a human readable text label for the specified channel position. \since 0.9.7

pa_channel_position_to_string
const(char)* pa_channel_position_to_string(pa_channel_position_t pos)

Return a text label for the specified channel position

Manifest constants

PA_CHANNEL_MAP_AIFF
enum PA_CHANNEL_MAP_AIFF;

\cond fulldocs

PA_CHANNEL_MAP_ALSA
enum PA_CHANNEL_MAP_ALSA;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_MAP_AUX
enum PA_CHANNEL_MAP_AUX;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_MAP_DEFAULT
enum PA_CHANNEL_MAP_DEFAULT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_MAP_DEF_MAX
enum PA_CHANNEL_MAP_DEF_MAX;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_MAP_OSS
enum PA_CHANNEL_MAP_OSS;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_MAP_SNPRINT_MAX
enum PA_CHANNEL_MAP_SNPRINT_MAX;

The maximum length of strings returned by * pa_channel_map_snprint(). Please note that this value can change * with any release without warning and without being considered API * or ABI breakage. You should not use this definition anywhere where * it might become part of an ABI.

PA_CHANNEL_MAP_WAVEEX
enum PA_CHANNEL_MAP_WAVEEX;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX0
enum PA_CHANNEL_POSITION_AUX0;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX1
enum PA_CHANNEL_POSITION_AUX1;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX10
enum PA_CHANNEL_POSITION_AUX10;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX11
enum PA_CHANNEL_POSITION_AUX11;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX12
enum PA_CHANNEL_POSITION_AUX12;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX13
enum PA_CHANNEL_POSITION_AUX13;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX14
enum PA_CHANNEL_POSITION_AUX14;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX15
enum PA_CHANNEL_POSITION_AUX15;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX16
enum PA_CHANNEL_POSITION_AUX16;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX17
enum PA_CHANNEL_POSITION_AUX17;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX18
enum PA_CHANNEL_POSITION_AUX18;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX19
enum PA_CHANNEL_POSITION_AUX19;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX2
enum PA_CHANNEL_POSITION_AUX2;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX20
enum PA_CHANNEL_POSITION_AUX20;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX21
enum PA_CHANNEL_POSITION_AUX21;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX22
enum PA_CHANNEL_POSITION_AUX22;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX23
enum PA_CHANNEL_POSITION_AUX23;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX24
enum PA_CHANNEL_POSITION_AUX24;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX25
enum PA_CHANNEL_POSITION_AUX25;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX26
enum PA_CHANNEL_POSITION_AUX26;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX27
enum PA_CHANNEL_POSITION_AUX27;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX28
enum PA_CHANNEL_POSITION_AUX28;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX29
enum PA_CHANNEL_POSITION_AUX29;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX3
enum PA_CHANNEL_POSITION_AUX3;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX30
enum PA_CHANNEL_POSITION_AUX30;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX31
enum PA_CHANNEL_POSITION_AUX31;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX4
enum PA_CHANNEL_POSITION_AUX4;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX5
enum PA_CHANNEL_POSITION_AUX5;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX6
enum PA_CHANNEL_POSITION_AUX6;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX7
enum PA_CHANNEL_POSITION_AUX7;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX8
enum PA_CHANNEL_POSITION_AUX8;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_AUX9
enum PA_CHANNEL_POSITION_AUX9;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_CENTER
enum PA_CHANNEL_POSITION_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_FRONT_CENTER
enum PA_CHANNEL_POSITION_FRONT_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_FRONT_LEFT
enum PA_CHANNEL_POSITION_FRONT_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER
enum PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_FRONT_RIGHT
enum PA_CHANNEL_POSITION_FRONT_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER
enum PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_INVALID
enum PA_CHANNEL_POSITION_INVALID;

\cond fulldocs

PA_CHANNEL_POSITION_LEFT
enum PA_CHANNEL_POSITION_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_LFE
enum PA_CHANNEL_POSITION_LFE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_MAX
enum PA_CHANNEL_POSITION_MAX;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_MONO
enum PA_CHANNEL_POSITION_MONO;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_REAR_CENTER
enum PA_CHANNEL_POSITION_REAR_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_REAR_LEFT
enum PA_CHANNEL_POSITION_REAR_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_REAR_RIGHT
enum PA_CHANNEL_POSITION_REAR_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_RIGHT
enum PA_CHANNEL_POSITION_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_SIDE_LEFT
enum PA_CHANNEL_POSITION_SIDE_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_SIDE_RIGHT
enum PA_CHANNEL_POSITION_SIDE_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_SUBWOOFER
enum PA_CHANNEL_POSITION_SUBWOOFER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_CENTER
enum PA_CHANNEL_POSITION_TOP_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_FRONT_CENTER
enum PA_CHANNEL_POSITION_TOP_FRONT_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_FRONT_LEFT
enum PA_CHANNEL_POSITION_TOP_FRONT_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_FRONT_RIGHT
enum PA_CHANNEL_POSITION_TOP_FRONT_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_REAR_CENTER
enum PA_CHANNEL_POSITION_TOP_REAR_CENTER;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_REAR_LEFT
enum PA_CHANNEL_POSITION_TOP_REAR_LEFT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_CHANNEL_POSITION_TOP_REAR_RIGHT
enum PA_CHANNEL_POSITION_TOP_REAR_RIGHT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

pa_channel_map
struct pa_channel_map

A channel map which can be used to attach labels to specific * channels of a stream. These values are relevant for conversion and * mixing of streams

Meta