Struct fon::Audio

pub struct Audio<F: Frame> { /* fields omitted */ }

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

Audio implements the Stream trait.

Implementations

impl<F: Frame> Audio<F>

pub fn get(&self, index: usize) -> Option<F>

Get an audio frame.

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

Get a mutable reference to an audio frame.

pub fn as_slice(&mut self) -> &mut [F]

Get a contiguous slice of all audio frames. This may have to re-arrange memory if drain() was used, and could be slow. If drain() was not called, this method should run in constant time.

pub fn iter(&self) -> Iter<'_, F>

Returns an iterator over the audio frames.

pub fn iter_mut(&mut self) -> IterMut<'_, F>

Returns an iterator that allows modifying each audio frame.

pub fn with_frame<R: Into<f64>>(s_rate: R, len: usize, frame: F) -> Self

Construct an Audio buffer with all audio frames set to one value.

pub fn with_silence<R: Into<f64>>(s_rate: R, len: usize) -> Self

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

pub fn with_stream<S, R, M>(s_rate: R, src: M) -> Self where
    F::Chan: From<S::Chan>,
    R: Into<f64>,
    M: Stream<S>,
    S: Frame, 

Construct an Audio buffer from the contents of a Stream.

The audio format can be converted with this function.

Panics

When an infinite stream is passed in.

pub fn with_frames<B: Into<Box<[F]>>, R: Into<f64>>(
    s_rate: R,
    frames: B
) -> Self

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_i8_buffer<B, R>(s_rate: R, buffer: B) -> Self where
    B: Into<Box<[i8]>>,
    F: Frame<Chan = Ch8>,
    R: Into<f64>, 

Construct an Audio buffer from an i8 buffer.

pub fn with_i16_buffer<B, R>(s_rate: R, buffer: B) -> Self where
    B: Into<Box<[i16]>>,
    F: Frame<Chan = Ch16>,
    R: Into<f64>, 

Construct an Audio buffer from an i16 buffer.

pub fn with_f32_buffer<B, R>(s_rate: R, buffer: B) -> Self where
    B: Into<Box<[f32]>>,
    F: Frame<Chan = Ch32>,
    R: Into<f64>, 

Construct an Audio buffer from an f32 buffer.

pub fn with_f64_buffer<B, R>(s_rate: R, buffer: B) -> Self where
    B: Into<Box<[f64]>>,
    F: Frame<Chan = Ch64>,
    R: Into<f64>, 

Construct an Audio buffer from an f64 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 sample_rate(&self) -> f64

Get the sample rate of the Audio buffer.

pub fn sink<'a, R: 'a + RangeBounds<usize> + SliceIndex<[F], Output = [F]>>(
    &'a mut self,
    reg: R
) -> impl Sink<F> + '_

Create an audio sink to overwrite a region of this Audio buffer.

Panics

If range is out of bounds

pub fn drain(&mut self) -> impl Stream<F> + '_

Create a draining audio stream from this Audio buffer. When the stream is dropped, only sinked audio samples will be removed.

pub fn extend<G: Frame, M: Stream<G>>(&mut self, stream: M) where
    F::Chan: From<G::Chan>, 

Extend the audio buffer with all of the audio from a stream.

Notes

Do not call repeatedly on a stream with a differnt sample rate. It will create extra "partial" samples.

Panics

When an infinite stream is passed in.

impl<F: Frame<Chan = Ch8>> Audio<F>

pub fn as_i8_slice(&mut self) -> &mut [i8]

Get view of samples as an i8 slice. May require reordering memory.

impl<F: Frame<Chan = Ch16>> Audio<F>

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

Get view of samples as an i16 slice.

impl<S: Frame<Chan = Ch32>> Audio<S>

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

Get view of samples as an f32 slice.

impl<F: Frame<Chan = Ch64>> Audio<F>

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

Get view of samples as an f64 slice.

Trait Implementations

impl<F: Debug + Frame> Debug for Audio<F>

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

Formats the value using the given formatter.

impl<'a, F: Frame> IntoIterator for &'a Audio<F>

type IntoIter = Cloned<Iter<'a, F>>

Which kind of iterator are we turning this into?

type Item = F

The type of the elements being iterated over.

pub fn into_iter(self) -> Cloned<Iter<'a, F>>

Creates an iterator from a value.

impl<F: Frame> Stream<F> for &Audio<F>

pub fn sample_rate(&self) -> Option<f64>

Get the (source) sample rate of the stream.

pub fn len(&self) -> Option<usize>

Returns the length of the stream exactly. None represents an infinite iterator.

pub fn is_empty(&self) -> bool

Check if the stream is empty (will not produce any frames).

pub fn set_sample_rate<R: Into<f64>>(&mut self, sr: R)

Set the source sample rate of the stream. Will usually panic (default behavior), unless the stream is configurable.

pub fn take(self, samples: usize) -> TakeStream<F, Self>

Take at most samples samples as a stream.

pub fn blend<G: Frame, M: Stream<G>, O: Blend>(
    self,
    other: M,
    op: O
) -> BlendStream<F, G, Self, M, O>

Blend this stream with another.