Struct bae_rs::sounds::complex_sound::ComplexSound

pub struct ComplexSound { /* fields omitted */ }

Type implementing the ability to run multiple Generators and Modifiers within a single object, granting the ability to creat complex systems like those found in digital synthesizers.

Methods

impl ComplexSound

pub fn new(input_gain: MathT, output_gain: MathT) -> Self

Creates a new ComplexSound object with the given input and output gain values.

pub fn get_input_gain(&self) -> GraphNode

Returns the ['GraphNode'] containing the input gain Modifier.

pub fn get_output_gain(&self) -> GraphNode

Returns the ['GraphNode'] containing the output gain Modifier.

pub fn add_block(&mut self, block: BasicBlockRc) -> GraphNode

Adds a new node to the Graph, using the given Block for the node value. Returns the GraphNode cointaing the Block for later use with [add_connection] and [remove_connection].

pub fn add_connection(&mut self, from: GraphNode, to: GraphNode)

Adds a new connection (edge) between the two given GraphNodes.

pub fn remove_connection(&mut self, from: GraphNode, to: GraphNode)

Removes a connection between the two given GraphNodes.

pub fn get_nodes(&self) -> ProcessOrder

Returns a copy of the list of all nodes of the graph in the order in which they will be processed.

Trait Implementations

impl Clone for ComplexSound

fn clone(&self) -> ComplexSound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Sound for ComplexSound

fn toggle_pause(&mut self)

Toggles the pause state of the sound. If the sound is paused, the internal structures aren't process during a call to [process], instead only [Default::default()] is returned.

fn is_paused(&self) -> bool

Returns the pause state of the sound.

fn toggle_mute(&mut self)

Toggels the mute state of the sound. If the sound is muted, the internal structures are still processed during a call to [process], but [Default::default()] is returned.

fn is_muted(&self) -> bool

Returns the mute state of the sound.

fn register(&mut self, id: usize)

Sets itself as registered with the given ID.

fn unregister(&mut self)

Sets itself as unregistered and clears the saved ID.

fn process(&mut self, input: SampleT) -> SampleT

Processes the sound and its internal structures, returning the resulting audio sample.

fn get_id(&self) -> Option<usize>

Returns the ID given to the [Sound] during registration with a [Channel]. If the [Sound] is unregistered, it will return None.