Struct Runtime 

pub struct Runtime { /* private fields */ }

Instruction types and the runtime wrapper. Safe owner for a native runtime handle.

Implementations

impl Runtime

pub fn builder() -> RuntimeConstructBuilder

Starts building a runtime.

pub fn new() -> RuntimeConstructBuilder

Backward-compatible constructor entrypoint used by examples and tests.

pub fn apply_instructions(&self, batch: &InstructionBatch) -> Result<()>

Applies a serialized batch of instructions to the runtime.

pub fn reset(&self)

Resets the runtime state.

pub fn set_current_time_samples(&self, sample_time: i64)

Sets the current runtime time in samples.

pub fn set_current_time_ms(&self, sample_time_ms: f64)

Sets the current runtime time in milliseconds.

pub fn resources(&self) -> Ref<'_, ResourceManager>

Returns the current resource registry.

pub fn add_resource( &self, name: impl AsRef<str>, resource: Resource, ) -> Result<()>

Adds a resource to the registry if the id is unused.

pub fn set_resource( &self, name: impl AsRef<str>, resource: Resource, ) -> Result<Option<Resource>>

Inserts or replaces a resource in the registry.

pub fn replace_resource( &self, name: impl AsRef<str>, resource: Resource, ) -> Result<Resource>

Replaces an existing resource and returns the previous value.

pub fn remove_resource(&self, name: impl AsRef<str>) -> Result<Resource>

Removes a resource from the registry.

pub fn rename_resource( &self, from: impl AsRef<str>, to: impl AsRef<str>, ) -> Result<()>

Renames a resource without changing its value.

pub fn resource(&self, name: impl AsRef<str>) -> Option<Resource>

Returns a cloned resource by name.

pub fn add_shared_resource_f32(&self, name: &str, data: &[f32]) -> Result<()>

Adds a shared f32 resource by name and mirrors it into the Rust registry.

pub fn add_audio_resource(&self, name: &str, buffer: AudioBuffer) -> Result<()>

Adds a decoded mono audio buffer as a shared resource.

pub fn prune_shared_resources(&self)

Prunes native shared resources and releases retired Rust buffers.

pub fn process( &self, num_samples: usize, inputs: &[&[f64]], outputs: &mut [&mut [f64]], ) -> Result<()>

Processes one audio block.

Every input and output channel must have at least num_samples samples.

pub fn gc(&self) -> Vec<NodeId>

Runs garbage collection and returns the collected node identifiers.

pub fn construct(sample_rate: f64, buffer_size: usize) -> Result<Self>

Creates a runtime for the given sample rate and buffer size.

Trait Implementations

impl Drop for Runtime

fn drop(&mut self)

Releases the native runtime handle.

impl Send for Runtime