Struct SpeakerLayout 

pub struct SpeakerLayout { /* private fields */ }

The speakers an AudioBlock’s planes feed, in plane order: 1 to MAX_AUDIO_CHANNELS of them.

A provider reports the layout its source declares (a WAVE channel mask, a QuickTime chan box, a codec’s channel configuration), in the order its planes arrive; neither binding rematrixes a source into another layout. A source that declares none, or only channels no speaker names, has SpeakerLayout::default_for its channel count.

Implementations

impl SpeakerLayout

pub const MONO: Self

One front-center plane: a mono source, and a mono project’s mix.

pub const STEREO: Self

Front left and right: a stereo source, and a stereo project’s mix.

pub fn new(speakers: &[Speaker]) -> Option<Self>

The layout of these speakers in this plane order, or None for none or more than MAX_AUDIO_CHANNELS.

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

The layout a source of channels planes that declares none has: FFmpeg’s default for the count (av_channel_layout_default), in the WAVE order. Mono, stereo, 2.1, 4.0, 5.0, 5.1, 6.1 and 7.1 up to 8; 5.1.4, 7.1.4, 9.1.4, 9.1.6 and 22.2 for 10, 12, 14, 16 and 24. A count FFmpeg names no layout for is a 7.1 with its further channels unnamed. None for no channels or more than MAX_AUDIO_CHANNELS.

pub fn declared_or_default(speakers: &[Speaker]) -> Option<(Self, bool)>

The layout a source declares, or SpeakerLayout::default_for its channel count when it names no speaker at all. The flag says the default was assumed.

pub fn speakers(&self) -> &[Speaker]

The speakers, in plane order.

pub fn channels(&self) -> usize

How many planes the layout has.

pub fn describe(&self) -> String

The speakers’ FFmpeg names, joined by + (FL+FR+FC), as av_channel_layout_from_string reads them.

Trait Implementations

impl Clone for SpeakerLayout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SpeakerLayout

impl Debug for SpeakerLayout

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

Formats the value using the given formatter.

impl Eq for SpeakerLayout

impl Hash for SpeakerLayout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SpeakerLayout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SpeakerLayout