Struct AudioNodeInfo 

pub struct AudioNodeInfo { /* private fields */ }

Information about an AudioNode.

This struct enforces the use of the builder pattern for future-proofness, as it is likely that more fields will be added in the future.

Implementations

impl AudioNodeInfo

pub const fn new() -> Self

Construct a new AudioNodeInfo builder struct.

pub const fn debug_name(self, debug_name: &'static str) -> Self

A unique name for this type of node, used for debugging purposes.

pub const fn channel_config(self, channel_config: ChannelConfig) -> Self

The channel configuration of this node.

By default this has a channel configuration with zero input and output channels.

WARNING: Audio nodes MUST either completely fill all output buffers with data, or return ProcessStatus::ClearAllOutputs/ProcessStatus::Bypass. Failing to do this will result in audio glitches.

pub const fn is_pre_process(self) -> Self

Specify that this node is a “pre process” node. Pre-process nodes have zero inputs and outputs, and they are processed before all other nodes in the graph.

pub const fn call_update_method(self, call_update_method: bool) -> Self

Set to true if this node wishes to have the Firewheel context call AudioNode::update on every update cycle.

By default this is set to false.

pub fn custom_state<T: 'static>(self, custom_state: T) -> Self

Custom !Send state that can be stored in the Firewheel context and accessed by the user.

The user accesses this state via FirewheelCtx::node_state and FirewheelCtx::node_state_mut.

pub const fn latency_frames(self, latency_frames: u32) -> Self

Set the latency of this node in frames (samples in a single channel of audio).

By default this is set to 0.

Trait Implementations

impl Debug for AudioNodeInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AudioNodeInfo

fn default() -> Self

Returns the “default value” for a type.

impl From<AudioNodeInfo> for AudioNodeInfoInner

fn from(value: AudioNodeInfo) -> Self

Converts to this type from the input type.