Skip to main content

CollectedAudio

Struct CollectedAudio 

Source
pub struct CollectedAudio { /* private fields */ }
Expand description

One whole audio extraction, collected: owned, interleaved 32-bit float samples plus the sample rate, channel count, and channel layout that describe them.

Returned by collect_audio. The buffer is exactly what collect_samples returns for the same run — packed native-endian f32, channels interleaved ([L0, R0, L1, R1, …] for stereo) — with the shape attached, so a WAV writer, resampler, or model can consume the buffer without out-of-band knowledge of the source.

Implementations§

Source§

impl CollectedAudio

Source

pub fn sample_rate(&self) -> u32

Samples per second. 0 only when the run delivered no samples at all.

Source

pub fn channels(&self) -> u16

Number of interleaved channels (1 for mono, 2 for stereo). 0 only when the run delivered no samples at all.

Source

pub fn channel_layout(&self) -> &str

FFmpeg’s textual channel-layout description (e.g. "mono", "stereo", "5.1") — the same vocabulary as AudioChunk::channel_layout. Above two channels this distinguishes layouts a bare count cannot (6 channels may be "5.1" or "6.0"). Empty when the run delivered no samples, or when FFmpeg cannot describe the layout.

Source

pub fn as_slice(&self) -> &[f32]

The interleaved f32 samples. Length is frames * channels.

Source

pub fn into_vec(self) -> Vec<f32>

Consumes the collected audio and returns the owned interleaved buffer (no copy), discarding the metadata.

Trait Implementations§

Source§

impl Debug for CollectedAudio

Source§

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

Formats the value using the given formatter. Read more

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

Source§

fn downcast(&self) -> &T

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

fn vzip(self) -> V

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,