Trait audio_core::UniformBuf
source · pub trait UniformBuf: Buf {
type Frame<'this>: Frame<Sample = Self::Sample>
where Self: 'this;
type IterFrames<'this>: Iterator<Item = Self::Frame<'this>>
where Self: 'this;
// Required methods
fn get_frame(&self, frame: usize) -> Option<Self::Frame<'_>>;
fn iter_frames(&self) -> Self::IterFrames<'_>;
}
Expand description
A buffer which has a unifom channel size.
Required Associated Types§
sourcetype Frame<'this>: Frame<Sample = Self::Sample>
where
Self: 'this
type Frame<'this>: Frame<Sample = Self::Sample> where Self: 'this
The type the channel assumes when coerced into a reference.
sourcetype IterFrames<'this>: Iterator<Item = Self::Frame<'this>>
where
Self: 'this
type IterFrames<'this>: Iterator<Item = Self::Frame<'this>> where Self: 'this
A borrowing iterator over the channel.
Required Methods§
sourcefn get_frame(&self, frame: usize) -> Option<Self::Frame<'_>>
fn get_frame(&self, frame: usize) -> Option<Self::Frame<'_>>
Get a single frame at the given offset.
Examples
use audio::{Frame, UniformBuf};
fn test<B>(buf: B)
where
B: UniformBuf<Sample = u32>,
{
let frame = buf.get_frame(0).unwrap();
assert_eq!(frame.get(1), Some(5));
assert_eq!(frame.iter().collect::<Vec<_>>(), [1, 5]);
let frame = buf.get_frame(2).unwrap();
assert_eq!(frame.get(1), Some(7));
assert_eq!(frame.iter().collect::<Vec<_>>(), [3, 7]);
assert!(buf.get_frame(4).is_none());
}
test(audio::sequential![[1, 2, 3, 4], [5, 6, 7, 8]]);
test(audio::wrap::sequential([1, 2, 3, 4, 5, 6, 7, 8], 2));
test(audio::interleaved![[1, 2, 3, 4], [5, 6, 7, 8]]);
test(audio::wrap::interleaved([1, 5, 2, 6, 3, 7, 4, 8], 2));
sourcefn iter_frames(&self) -> Self::IterFrames<'_>
fn iter_frames(&self) -> Self::IterFrames<'_>
Construct an iterator over all the frames in the audio buffer.
Examples
use audio::{Frame, UniformBuf};
fn test<B>(buf: B)
where
B: UniformBuf<Sample = u32>,
{
let mut it = buf.iter_frames();
let frame = it.next().unwrap();
assert_eq!(frame.get(1), Some(5));
assert_eq!(frame.iter().collect::<Vec<_>>(), [1, 5]);
assert!(it.next().is_some());
let frame = it.next().unwrap();
assert_eq!(frame.get(1), Some(7));
assert_eq!(frame.iter().collect::<Vec<_>>(), [3, 7]);
assert!(it.next().is_some());
assert!(it.next().is_none());
}
test(audio::sequential![[1, 2, 3, 4], [5, 6, 7, 8]]);
test(audio::wrap::interleaved([1, 5, 2, 6, 3, 7, 4, 8], 2));
test(audio::interleaved![[1, 2, 3, 4], [5, 6, 7, 8]]);
test(audio::wrap::sequential([1, 2, 3, 4, 5, 6, 7, 8], 2));
Object Safety§
This trait is not object safe.