Skip to main content

ChannelLayout

Struct ChannelLayout 

Source
pub struct ChannelLayout(/* private fields */);
Expand description

A set of speaker positions; ascending bit order is the interleave order.

Implementations§

Source§

impl ChannelLayout

Source

pub const MONO: ChannelLayout

Mono: front center only.

Source

pub const STEREO: ChannelLayout

Stereo: front left + right.

Source

pub const SURROUND_5_1: ChannelLayout

5.1 (back): FL FR FC LFE BL BR.

Source

pub const SURROUND_7_1: ChannelLayout

7.1: FL FR FC LFE BL BR SL SR.

Source

pub const fn of(positions: &[ChannelPosition]) -> Self

Layout from a set of positions.

Source

pub const fn default_for(channels: u8) -> Option<Self>

The conventional layout for a channel count (the ffmpeg default-layout table, which the decode path emits): mono, stereo, 2.1, 4.0, 5.0, 5.1, 6.1, 7.1. None for 0 or > 8 channels.

Source

pub const fn channels(self) -> u8

Number of channels in the layout.

Source

pub const fn contains(self, position: ChannelPosition) -> bool

Source

pub const fn index_of(self, position: ChannelPosition) -> Option<usize>

The interleaved channel index of position (its rank among the set bits), or None if the layout lacks it.

Source

pub fn positions(self) -> impl Iterator<Item = ChannelPosition>

The positions in interleave order.

Trait Implementations§

Source§

impl Clone for ChannelLayout

Source§

fn clone(&self) -> ChannelLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ChannelLayout

Source§

impl Debug for ChannelLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ChannelLayout

Source§

impl PartialEq for ChannelLayout

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ChannelLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ElementBound for T
where T: Send,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.