Skip to main content

AudioFrame

Struct AudioFrame 

Source
pub struct AudioFrame {
    pub format: SampleFormat,
    pub sample_rate: u32,
    pub channels: u16,
    pub data: Vec<f32>,
}
Expand description

A block of interleaved PCM audio — std/media/v1/AudioFrame[sample=…].

Samples are interleaved across channels (frame 0 ch 0, frame 0 ch 1, …), which is the layout a capture ring buffer already holds.

Fields§

§format: SampleFormat

The sample format, which selects the sample column’s type.

§sample_rate: u32

Frames per second.

§channels: u16

How many channels are interleaved.

§data: Vec<f32>

The interleaved samples, as 32-bit floats regardless of the wire format — the one shape every audio pipeline can consume, converted on encode.

Implementations§

Source§

impl AudioFrame

Source

pub fn new( format: SampleFormat, sample_rate: u32, channels: u16, data: Vec<f32>, ) -> Result<Self>

A frame of interleaved f32 samples.

§Errors

DataError::ChildLengthMismatch when the sample count is not a whole number of interleaved frames.

Source

pub fn frame_count(&self) -> usize

How many interleaved frames the block holds.

Source

pub fn urn(&self) -> String

The parameterised URN a port carrying this frame declares.

Source

pub fn layout(&self) -> DataType

The columnar layout this frame produces.

Source

pub fn check(&self) -> Result<()>

Checks that the sample count is a whole number of frames.

§Errors

DataError::ChildLengthMismatch.

Source

pub fn to_record_batch(&self) -> Result<RecordBatch>

Encodes the frame as a one-row payload batch, converting the samples into the format’s own column type.

§Errors

As AudioFrame::check, plus DataError when the columns cannot be assembled.

Source

pub fn from_record_batch(batch: &RecordBatch) -> Result<Self>

Decodes a frame from a one-row payload batch, converting the samples back into f32.

§Errors

DataError when the batch is not an AudioFrame layout.

Trait Implementations§

Source§

impl Clone for AudioFrame

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 AudioFrame

Source§

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

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

impl FromPayload for AudioFrame

Source§

fn from_batch(batch: &RecordBatch) -> Result<Self>

Reads the value from a decoded payload batch. Read more
Source§

impl PartialEq for AudioFrame

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 AudioFrame

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more