Struct fon::Audio

pub struct Audio<S: Sample> { /* fields omitted */ }

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

Implementations

impl<S: Sample> Audio<S>

pub fn sample(&self, index: usize) -> &S

Get a sample.

Panics

If index is out of bounds

pub fn sample_mut(&mut self, index: usize) -> &mut S

Get a mutable sample.

Panics

If index is out of bounds

pub fn samples(&self) -> &[S]

Get a slice of all samples.

pub fn samples_mut(&mut self) -> &mut [S]

Get a mutable slice of all samples.

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

Returns an iterator over the samples.

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

Returns an iterator that allows modifying each sample.

pub fn with_sample(s_rate: u32, len: usize, sample: S) -> Self

Construct an Audio buffer with all samples set to one value.

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

Construct an Audio buffer with all all samples set to the default value.

pub fn with_audio<SrcS: Sample>(s_rate: u32, src: &Audio<SrcS>) -> Self where
    S::Chan: From<SrcS::Chan>, 

Construct an Audio buffer with another Audio buffer.

The audio format can be converted with this function.

pub fn with_samples<B: Into<Box<[S]>>>(s_rate: u32, samples: B) -> Self

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

pub fn with_i8_buffer<B>(s_rate: u32, buffer: B) -> Self where
    B: Into<Box<[i8]>>,
    S: Sample<Chan = Ch8>, 

Construct an Audio buffer from an i8 buffer.

pub fn with_i16_buffer<B>(s_rate: u32, buffer: B) -> Self where
    B: Into<Box<[i16]>>,
    S: Sample<Chan = Ch16>, 

Construct an Audio buffer from an i16 buffer.

pub fn with_f32_buffer<B>(s_rate: u32, buffer: B) -> Self where
    B: Into<Box<[f32]>>,
    S: Sample<Chan = Ch32>, 

Construct an Audio buffer from an f32 buffer.

pub fn with_f64_buffer<B>(s_rate: u32, buffer: B) -> Self where
    B: Into<Box<[f64]>>,
    S: Sample<Chan = Ch64>, 

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) -> u32

Get the sample rate of the Audio buffer.

pub fn blend_sample<O: Blend, R: RangeBounds<usize> + SliceIndex<[S], Output = [S]>>(
    &mut self,
    reg: R,
    sample: S,
    op: O
)

Blend Audio buffer with a single sample.

pub fn blend_audio<O: Blend, R: RangeBounds<usize> + SliceIndex<[S], Output = [S]>>(
    &mut self,
    reg: R,
    other: &Self,
    op: O
)

Blend Audio buffer with another Audio buffer.

pub fn copy_silence<R: RangeBounds<usize> + SliceIndex<[S], Output = [S]>>(
    &mut self,
    reg: R
)

Copy silence into a region of the Audio.

Panics

If range is out of bounds on the Audio buffer.

pub fn copy_sample<R: RangeBounds<usize> + SliceIndex<[S], Output = [S]>>(
    &mut self,
    reg: R,
    sample: S
)

Copy sample into a region of the Audio.

Panics

If range is out of bounds on the Audio buffer.

pub fn stream<'a, R: RangeBounds<usize> + SliceIndex<[S], Output = [S]> + 'a>(
    &'a self,
    reg: R
) -> impl Stream<S> + 'a

Create an audio stream over this Audio buffer.

Panics

If range is out of bounds

pub fn drain<'a, R: RangeBounds<usize> + SliceIndex<[S], Output = [S]> + Clone + 'a>(
    &'a mut self,
    reg: R
) -> impl Stream<S> + 'a

Create a draining audio stream over this Audio buffer.

Panics

If range is out of bounds

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

Create an audio sink to overwrite this Audio buffer.

Panics

If range is out of bounds

pub fn extend<M: Stream<S>>(&mut self, stream: &mut M)

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

Don't call this with an infinite stream! This is the only way to collect a stream without knowing the size ahead of time.

Trait Implementations

impl<S: Debug + Sample> Debug for Audio<S>

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

Formats the value using the given formatter.

impl<S: Sample> From<Audio<S>> for Box<[S]>

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as boxed slice.

impl<S: Sample> From<Audio<S>> for Vec<S>

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as Vec of samples.

impl<S> From<Audio<S>> for Box<[i8]> where
    S: Sample<Chan = Ch8>, 

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as boxed slice of i8.

impl<S> From<Audio<S>> for Box<[i16]> where
    S: Sample<Chan = Ch16>, 

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as boxed slice of u16.

impl<S> From<Audio<S>> for Box<[f32]> where
    S: Sample<Chan = Ch32>, 

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as boxed slice of u16.

impl<S> From<Audio<S>> for Box<[f64]> where
    S: Sample<Chan = Ch64>, 

pub fn from(audio: Audio<S>) -> Self

Get internal pixel data as boxed slice of u16.