Struct screech::stream::Stream

pub struct Stream {
    pub points: Vec<Point>,
}

Struct representing a stream of audio data

Fields

points: Vec<Point>

Vec containing all audio points

Implementations

impl Stream

pub fn empty(size: usize) -> Self

Create zero initialized (silent) stream

pub fn len(&self) -> usize

Returns the length of the stream

pub fn get_point(&self, position: usize) -> Result<Point, StreamErr>

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

pub fn mix(&mut self, streams: &[&Stream]) -> &mut Self

Mix 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

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

Amplify a stream by decibels

note clamps values at -1.0 and 1.0

pub fn get_slice(&self, from: usize, length: usize) -> Result<Stream, StreamErr>

Returns a slice of the points into a new Stream

pub fn get_looped_slice(&self, from: usize, length: usize) -> Stream

Returns a slice of the stream that loops around when going out of bounds

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 FromPoints<f32> for Stream

fn from_points(points: &[f32]) -> Stream

Create new stream based on f32 points

impl FromPoints<i16> for Stream

fn from_points(points: &[i16]) -> Stream

Create new stream based on i16 points, converts i16 to point value (f32 between -1.0 and 1.0)

impl FromPoints<i32> for Stream

fn from_points(points: &[i32]) -> Stream

Create new stream based on i32 points, converts i32 to point value (f32 between -1.0 and 1.0)

impl FromPoints<u8> for Stream

fn from_points(points: &[u8]) -> Stream

Create new stream based on u8 points, converts u8 to point value (f32 between -1.0 and 1.0)

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