Struct fon::Audio

pub struct Audio<Chan: Channel, const CH: usize> { /* private fields */ }

Audio buffer (fixed-size array of audio Frames at sample rate specified in hertz).

Implementations

impl<Chan: Channel, const CH: usize> Audio<Chan, CH>

pub fn with_silence(hz: u32, len: usize) -> Self

Construct an Audio buffer with all all samples set to zero.

pub fn with_frames<B>(hz: u32, frames: B) -> Self where
    B: Into<Box<[Frame<Chan, CH>]>>, 

Construct an Audio buffer with owned sample data. You can get ownership of the sample data back from the Audio buffer as either a Vec<S> or a Box<[S]> by calling into().

pub fn with_audio<Ch, const N: usize>(hz: u32, audio: &Audio<Ch, N>) -> Self where
    Ch: Channel,
    Ch32: From<Ch>,
    Chan: From<Ch>, 

Construct an Audio buffer from another Audio buffer of a different format.

pub fn get(&self, index: usize) -> Option<Frame<Chan, CH>>

Get an audio frame.

pub fn get_mut(&mut self, index: usize) -> Option<&mut Frame<Chan, CH>>

Get a mutable reference to an audio frame.

pub fn as_slice(&self) -> &[Frame<Chan, CH>]

Get a slice of all audio frames.

pub fn as_mut_slice(&mut self) -> &mut [Frame<Chan, CH>]

Get a slice of all audio frames.

pub fn iter(&self) -> Iter<'_, Frame<Chan, CH>>

Returns an iterator over the audio frames.

pub fn iter_mut(&mut self) -> IterMut<'_, Frame<Chan, CH>>

Returns an iterator that allows modifying each audio frame.

pub fn sample_rate(&self) -> NonZeroU32

Get the sample rate of this audio buffer.

pub fn len(&self) -> usize

Get the length of the Audio buffer.

pub fn is_empty(&self) -> bool

Check if Audio buffer is empty.

pub fn silence(&mut self)

Silence the audio buffer.

pub fn sink(&mut self) -> AudioSink<'_, Chan, CH>

Sink audio into this audio buffer from a Stream.

impl<const CH: usize> Audio<Ch16, CH>

pub fn with_i16_buffer<B>(hz: u32, buffer: B) -> Self where
    B: Into<Box<[i16]>>, 

Construct an Audio buffer from an i16 buffer.

pub fn as_i16_slice(&mut self) -> &mut [i16]

Get view of samples as an i16 slice.

impl<const CH: usize> Audio<Ch24, CH>

pub fn with_u8_buffer<B>(hz: u32, buffer: B) -> Self where
    B: Into<Box<[u8]>>, 

Construct an Audio buffer from an u8 buffer.

pub fn as_u8_slice(&mut self) -> &mut [u8]

Get view of samples as an u8 slice.

impl<const CH: usize> Audio<Ch32, CH>

pub fn with_f32_buffer<B>(hz: u32, buffer: B) -> Self where
    B: Into<Box<[f32]>>, 

Construct an Audio buffer from an f32 buffer.

pub fn as_f32_slice(&mut self) -> &mut [f32]

Get view of samples as an f32 slice.

impl<const CH: usize> Audio<Ch64, CH>

pub fn with_f64_buffer<B>(hz: u32, buffer: B) -> Self where
    B: Into<Box<[f64]>>, 

Construct an Audio buffer from an f64 buffer.

pub fn as_f64_slice(&mut self) -> &mut [f64]

Get view of samples as an f64 slice.

Trait Implementations

impl<Chan: Debug + Channel, const CH: usize> Debug for Audio<Chan, CH>

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

Formats the value using the given formatter.

impl<const CH: usize> From<Audio<Ch16, CH>> for Box<[i16]>

fn from(audio: Audio<Ch16, CH>) -> Self

Get internal sample data as boxed slice of i16.

impl<const CH: usize> From<Audio<Ch24, CH>> for Box<[u8]>

fn from(audio: Audio<Ch24, CH>) -> Self

Get internal sample data as boxed slice of u8.

impl<const CH: usize> From<Audio<Ch32, CH>> for Box<[f32]>

fn from(audio: Audio<Ch32, CH>) -> Self

Get internal sample data as boxed slice of f32.

impl<const CH: usize> From<Audio<Ch64, CH>> for Box<[f64]>

fn from(audio: Audio<Ch64, CH>) -> Self

Get internal sample data as boxed slice of f64.

impl<Chan, const CH: usize> From<Audio<Chan, CH>> for Vec<Frame<Chan, CH>> where
    Chan: Channel, 

fn from(audio: Audio<Chan, CH>) -> Self

Get internal sample data as Vec of audio frames.

impl<Chan: Channel, const CH: usize> From<Audio<Chan, CH>> for Box<[Frame<Chan, CH>]>

fn from(audio: Audio<Chan, CH>) -> Self

Get internal sample data as Vec of audio frames.