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.

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

Set to true if this node type uses events, false otherwise.

Setting to false will help the system save some memory by not allocating an event buffer for this node.

By default this is set to false.

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.

Trait Implementations

impl Debug for AudioNodeInfo

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

Formats the value using the given formatter.

impl Into<AudioNodeInfoInner> for AudioNodeInfo

fn into(self) -> AudioNodeInfoInner

Converts this type into the (usually inferred) input type.