Module libpulse_binding::channelmap

Constants and routines for handing channel mapping

Overview

Channel maps provide a way to associate channels in a stream with a specific speaker position. This relieves applications of having to make sure their channel order is identical to the final output.

Initialisation

A channel map consists of an array of Position values, one for each channel. This array is stored together with a channel count in a Map structure.

Before filling the structure, the application must initialise it using Map::init. There are also a number of convenience functions for standard channel mappings:

• Map::init_mono: Create a channel map with only mono audio.
• Map::init_stereo: Create a standard stereo mapping.
• Map::init_auto: Create a standard channel map for a specific number of channels.
• Map::init_extend: Similar to Map::init_auto but synthesize a channel map if no predefined one is known for the specified number of channels.

Structs

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.

Enums

MapDef
Position	A list of channel labels

Constants

POSITION_MASK_ALL

Position mask covering all positions

Type Definitions

PositionMask

A mask of channel positions.