Struct screech::Stream

pub struct Stream {
    pub samples: Vec<f32>,
    pub channels: usize,
}

Struct representing a stream of audio data

Fields

samples: Vec<f32>

Vec containing all audio points, multiple channels are interleaved

channels: usize

amount of channels

Implementations

impl Stream

pub fn empty(size: usize, channels: usize) -> Self

Create zero initialized (silent) stream

pub fn from_samples(samples: Vec<f32>, channels: usize) -> Self

Create new stream based on provided samples

pub fn len(&self) -> usize

Returns the length of the stream

note this does not take into account the amount of channels

pub fn get_sample(&self, position: usize) -> Result<f32, StreamErr>

Get sample for provided position argument, errors when the index does not exist in the stream

pub fn mix(&mut self, streams: &Vec<&Stream>) -> &mut Self

Mix together multiple streams into the given stream

note the size of the stream is unchanged, if the other streams are shorter it inserts silence (0.0) if the other streams are longer the remaining points are ignored

note this is a naive mix, it does not take into account the channel size, it assumes you are mixing together channels of the same size

pub fn amplify(&mut self, db: f32) -> &mut Self

Amplify a stream by decibels

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl PartialEq<Stream> for Stream

fn eq(&self, other: &Stream) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Stream) -> bool

This method tests for !=.

impl StructuralPartialEq for Stream