Struct screech::Screech

pub struct Screech<MessageData = ()> {
    pub sample_rate: usize,
    /* private fields */
}

Main helper struct to render and manage relations between crate::traits::Source types.

Fields

sample_rate: usize

sample rate field used for sampling

Implementations

impl<MessageData: 'static> Screech<MessageData>

pub fn new(buffer_size: usize, sample_rate: usize) -> Self

Create new Screech instance with a default tracker

pub fn with_tracker( tracker: Box<dyn Tracker<MessageData>>, sample_rate: usize ) -> Self

Create a new Screech instance with a supplied tracker

use screech::{Screech, BasicTracker};

let tracker = BasicTracker::<256>::new(8);
let screech = Screech::with_tracker(Box::new(tracker), 48_000);

pub fn invalidate_cache(&mut self)

invalidate connections cache

pub fn create_source_id(&mut self) -> usize

create new unique identifier

pub fn create_main_out(&mut self, signal_id: &'static str)

create new main output based on &'static str identifier

pub fn get_main_out(&self, signal_id: &'static str) -> Option<&Signal>

return output Signal based on &'static str identifier

pub fn init_input( &mut self, source_id: &usize, signal_id: &'static str ) -> Input

create and initialize a new input

pub fn init_output( &mut self, source_id: &usize, signal_id: &'static str ) -> Output

create and initialize a new output

pub fn connect_signal(&mut self, output: &Output, input: &Input)

connect an Output to an Input

pub fn disconnect_signal(&mut self, output: &Output, input: &Input)

disconnect an Output to an Input

pub fn connect_signal_to_main_out( &mut self, output: &Output, signal_id: &'static str )

connect an Output to a main output buffer

pub fn disconnect_signal_from_main_out( &mut self, output: &Output, signal_id: &'static str )

disconnect an Output from a main output buffer

pub fn sample( &mut self, unmapped_sources: &mut [&mut dyn Source<MessageData>] ) -> Result<(), ScreechError>

Sample multiple sources based on their dependencies into Signals stored in a traits::Tracker

Trait Implementations

impl<T> Send for Screech<T>