Struct Runtime

pub struct Runtime { /* private fields */ }

The audio graph processing runtime.

Implementations

impl Runtime

pub fn new(graph: Graph) -> Self

Creates a new runtime from the given graph.

pub fn sample_rate(&self) -> Float

Returns the current sample rate.

pub fn block_size(&self) -> usize

Returns the current block size.

pub fn allocate_for_block_size( &mut self, sample_rate: Float, max_block_size: usize, )

Resets the runtime for the given sample rate and block size.

This will reallocate buffers if necessary.

pub fn set_block_size(&mut self, block_size: usize) -> RuntimeResult<()>

Resets the runtime for the given sample rate and block size.

This is guaranteed to not allocate, assuming all processors are playing nicely. If it would need to allocate, it will return an error.

pub fn graph(&self) -> &Graph

Returns a reference to the audio graph.

pub fn graph_mut(&mut self) -> &mut Graph

Returns a mutable reference to the audio graph.

pub fn process(&mut self) -> RuntimeResult<()>

Runs the audio graph for one block of samples.

pub fn get_input_mut(&mut self, input_index: usize) -> Option<&mut SignalBuffer>

Returns a reference to the runtime’s input buffer for the given input index.

pub fn get_output(&self, output_index: usize) -> Option<&SignalBuffer>

Returns a reference to the runtime’s output buffer for the given output index.

pub fn param_named(&self, name: &str) -> Option<&Param>

Returns a reference to the Param with the given name.

pub fn run_offline( &mut self, duration: Duration, sample_rate: Float, block_size: usize, ) -> RuntimeResult<Box<[Box<[Float]>]>>

Runs the audio graph offline for the given duration and sample rate, returning the output buffers.

pub fn simulate( &mut self, duration: Duration, sample_rate: Float, block_size: usize, ) -> RuntimeResult<Box<[Box<[Float]>]>>

Runs the audio graph offline for the given duration and sample rate, returning the output buffers.

This method will sleep for the duration of each block to simulate real-time processing.

pub fn run_offline_to_file( &mut self, file_path: impl AsRef<Path>, duration: Duration, sample_rate: Float, block_size: usize, ) -> RuntimeResult<()>

Runs the audio graph offline for the given duration and sample rate, writing the output to a file.

pub fn run_for( &mut self, duration: Duration, backend: AudioBackend, device: AudioDevice, midi_port: Option<MidiPort>, ) -> RuntimeResult<()>

Runs the audio graph in real-time for the given duration.

pub fn run( &mut self, backend: AudioBackend, device: AudioDevice, midi_port: Option<MidiPort>, ) -> RuntimeResult<RuntimeHandle>

Starts running the audio graph in real-time. Returns a RuntimeHandle that can be used to stop the runtime.

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Runtime

Returns a duplicate of the value.

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

Performs copy-assignment from source.