Struct libpulse_binding::channelmap::Map

#[repr(C)]
pub struct Map {
    pub channels: u8,
    pub map: [Position; 32],
}

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.

Fields

channels: u8

Deprecated since 2.10.0:

do not access directly, use methods from now on

Number of channels mapped.

map: [Position; 32]

Deprecated since 2.10.0:

do not access directly, use methods from now on

Channel labels.

Methods

impl Map

pub fn new_from_string(s: &str) -> Result<Self, ()>

Parses a channel position list or well-known mapping name into a channel map structure.

This turns the output of print and to_name back into a Map.

pub fn init(&mut self) -> &mut Self

Initializes the specified channel map and returns a pointer to it.

The map will have a defined state but is_valid will fail for it.

pub fn init_mono(&mut self) -> &mut Self

Initializes the specified channel map for monaural audio and returns a pointer to it.

pub fn init_stereo(&mut self) -> &mut Self

Initializes the specified channel map for stereophonic audio and returns a pointer to it.

pub fn init_auto(&mut self, channels: u32, def: MapDef) -> Option<&mut Self>

Initializes the specified channel map for the specified number of channels using default labels and returns a pointer to it.

This call will fail (return None) if there is no default channel map known for this specific number of channels and mapping.

pub fn init_extend(&mut self, channels: u32, def: MapDef) -> &mut Self

Similar to 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.

pub fn is_valid(&self) -> bool

Checks whether or not the map is considered valid.

pub fn len(&self) -> u8

Gets the number of active channels.

pub fn set_len(&mut self, channels: u8)

Sets the number of active channels.

Positions for up to sample::CHANNELS_MAX channels can be held. This sets the portion of the internal array considered “active” and thus available for reading/writing (i.e. when borrowing self as a slice).

Panics if the number of channels specified is greater than sample::CHANNELS_MAX.

pub fn get(&self) -> &[Position]

Gets an immutable slice of the set of “active” channels.

pub fn get_mut(&mut self) -> &mut [Position]

Gets a mutable slice of the set of “active” channels.

pub fn print(&self) -> String

Makes a human readable string from the map.

pub fn is_equal_to(&self, to: &Self) -> bool

Deprecated since 2.7.0:

use the PartialEq implementation instead

Compares whether or not two maps are equal.

pub fn is_compatible_with_sample_spec(&self, ss: &Spec) -> bool

Checks whether or not the specified map is compatible with the specified sample spec.

pub fn is_superset_of(&self, of: &Self) -> bool

Checks whether every channel defined in of is also defined in self.

pub fn can_balance(&self) -> bool

Checks whether or not it makes sense to apply a volume “balance” with this mapping, i.e. if there are left/right channels available.

pub fn can_fade(&self) -> bool

Checks whether or not 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.

pub fn can_lfe_balance(&self) -> bool

Checks whether or not 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.

Available since PA version 8.

pub fn to_name(&self) -> Option<Cow<'static, str>>

Tries to find a well-known channel mapping name for this channel mapping, i.e. “stereo”, “surround-71” and so on. This name can be parsed with new_from_string.

pub fn to_pretty_name(&self) -> Option<String>

Similar to to_name, but returning prettier, human readable text labels, i.e. “Stereo”, “Surround 7.1” and so on.

pub fn has_position(&self, p: Position) -> bool

Checks whether or not the specified channel position is available at least once in the map.

pub fn get_mask(&self) -> PositionMask

Generates a bit mask from a map.

Trait Implementations

impl AsRef<pa_channel_map> for Map

fn as_ref(&self) -> &pa_channel_map

Performs the conversion.

impl AsRef<Map> for pa_channel_map

fn as_ref(&self) -> &Map

Performs the conversion.

impl AsMut<pa_channel_map> for Map

fn as_mut(&mut self) -> &mut pa_channel_map

Performs the conversion.

impl From<pa_channel_map> for Map

fn from(m: pa_channel_map) -> Self

Performs the conversion.

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Map

impl Default for Map

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Map> for Map

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Map

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Borrow<[Position]> for Map

fn borrow(&self) -> &[Position]

Immutably borrows from an owned value.

impl BorrowMut<[Position]> for Map

fn borrow_mut(&mut self) -> &mut [Position]

Mutably borrows from an owned value.