Skip to main content

AudioBlock

Struct AudioBlock 

Source
pub struct AudioBlock {
    pub start_sample: i64,
    pub sample_rate: u32,
    pub speakers: SpeakerLayout,
    pub channels: Vec<Vec<f32>>,
}
Expand description

Planar floating-point audio at the project sample rate.

Positions are sample indices at sample_rate, never ticks: a tick is not a whole number of samples at 44.1 kHz, so a start in ticks cannot say which sample a block begins with, and every conversion between the two would need a rounding rule both sides agree on. Sample n is at n / sample_rate seconds on the block’s timeline, the source’s for a decoder and the project’s for a mixer.

A block from a decoder or an AudioBlockProvider keeps its source’s channels, 1 to MAX_AUDIO_CHANNELS planes, and says which speaker each feeds; the mixer folds them into the project’s layout by those speakers. A mixer’s own blocks have the project’s channels.

Fields§

§start_sample: i64

Index of the first sample, at sample_rate.

§sample_rate: u32

Project sample rate used by every returned block.

§speakers: SpeakerLayout

The speaker each of channels feeds, one per plane.

§channels: Vec<Vec<f32>>

One vector per channel, all with equal lengths, in speakers’ order.

Implementations§

Source§

impl AudioBlock

Source

pub fn frames(&self) -> usize

Samples per channel.

Source

pub fn end_sample(&self) -> i64

Index one past the last sample.

Source

pub fn start_time(&self) -> MediaTime

The first sample’s time, at or before it on the tick grid.

For display and for APIs that take a MediaTime; positions within audio stay in samples.

Trait Implementations§

Source§

impl Clone for AudioBlock

Source§

fn clone(&self) -> Self

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 Debug for AudioBlock

Source§

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

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

impl PartialEq for AudioBlock

Source§

fn eq(&self, other: &Self) -> 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 AudioBlock

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> 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, !>

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.