Struct GraphBuilder

pub struct GraphBuilder { /* private fields */ }

A builder for constructing audio graphs.

Implementations

impl GraphBuilder

pub fn new() -> Self

Creates a new GraphBuilder with an empty graph.

pub fn add_audio_input(&self) -> Node

Adds an audio input node to the graph.

pub fn add_audio_output(&self) -> Node

Adds an audio output node to the graph.

pub fn add_midi_input(&self, name: impl Into<String>) -> Node

Adds a MIDI input node to the graph.

pub fn add(&self, processor: impl Processor) -> Node

Adds a processor node to the graph.

pub fn add_param(&self, value: Param) -> Node

Adds a parameter node to the graph.

pub fn from_graph(graph: Graph) -> Self

Creates a new GraphBuilder with the given graph as a starting point.

pub fn build(&self) -> Graph

Builds the graph, returning a new Graph instance that can be used in a Runtime.

pub fn build_runtime(&self) -> Runtime

Builds the graph and constructs a new Runtime instance from the graph.

pub fn node_count(&self) -> usize

Returns the number of nodes in the graph.

pub fn edge_count(&self) -> usize

Returns the number of edges in the graph.

pub fn with_graph<F, R>(&self, f: F) -> R

where F: FnOnce(&Graph) -> R,

Runs the given closure with a reference to the graph.

pub fn with_graph_mut<F, R>(&self, f: F) -> R

where F: FnOnce(&mut Graph) -> R,

Runs the given closure with a mutable reference to the graph.

pub fn connect( &self, from: impl IntoNode, from_output: impl IntoOutputIdx, to: impl IntoNode, to_input: impl IntoInputIdx, )

Connects the given output of one node to the given input of another node.

pub fn write_dot(&self, writer: &mut impl Write) -> Result<()>

Writes a DOT representation of the graph to the given writer.

impl GraphBuilder

pub fn constant(&self, value: impl Signal + Clone) -> Node

Adds a node that outputs a constant value every sample.

impl GraphBuilder

pub fn sample_rate(&self) -> Node

Adds a new SampleRate processor that continuously outputs the current sample rate.

Trait Implementations

impl Clone for GraphBuilder

fn clone(&self) -> GraphBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for GraphBuilder

fn default() -> GraphBuilder

Returns the “default value” for a type.