Struct FirewheelConfig 

pub struct FirewheelConfig {

    pub num_graph_inputs: ChannelCount,
    pub num_graph_outputs: ChannelCount,
    pub hard_clip_outputs: bool,
    pub initial_node_capacity: u32,
    pub initial_edge_capacity: u32,
    pub declick_seconds: f32,
    pub initial_event_group_capacity: u32,
    pub channel_capacity: u32,
    pub event_queue_capacity: usize,
    pub immediate_event_capacity: usize,
    pub scheduled_event_capacity: usize,
    pub buffer_out_of_space_mode: BufferOutOfSpaceMode,
    pub logger_config: RealtimeLoggerConfig,
    pub debug_force_clear_buffers: bool,
    pub proc_store_capacity: usize,
}

The configuration of a Firewheel context.

Fields

num_graph_inputs: ChannelCount

The number of input channels in the audio graph.

num_graph_outputs: ChannelCount

The number of output channels in the audio graph.

hard_clip_outputs: bool

If true, then all outputs will be hard clipped at 0db to help protect the system’s speakers.

Note that most operating systems already hard clip the output, so this is usually not needed (TODO: Do research to see if this assumption is true.)

By default this is set to false.

initial_node_capacity: u32

An initial capacity to allocate for the nodes in the audio graph.

By default this is set to 64.

initial_edge_capacity: u32

An initial capacity to allocate for the edges in the audio graph.

By default this is set to 256.

declick_seconds: f32

The amount of time in seconds to fade in/out when pausing/resuming to avoid clicks and pops.

By default this is set to 10.0 / 1_000.0.

initial_event_group_capacity: u32

The initial capacity for a group of events.

By default this is set to 128.

channel_capacity: u32

The capacity of the engine’s internal message channel.

By default this is set to 64.

event_queue_capacity: usize

The maximum number of events that can be sent in a single call to AudioNodeProcessor::process.

By default this is set to 128.

immediate_event_capacity: usize

The maximum number of immediate events (events that do NOT have a scheduled time component) that can be stored at once in the audio thread.

By default this is set to 512.

scheduled_event_capacity: usize

The maximum number of scheduled events (events that have a scheduled time component) that can be stored at once in the audio thread.

This can be set to 0 to save some memory if you do not plan on using scheduled events.

By default this is set to 512.

buffer_out_of_space_mode: BufferOutOfSpaceMode

How to handle event buffers on the audio thread running out of space.

By default this is set to BufferOutOfSpaceMode::AllocateOnAudioThread.

logger_config: RealtimeLoggerConfig

The configuration of the realtime safe logger.

debug_force_clear_buffers: bool

Force all buffers in the audio graph to be cleared when processing.

This is only meant to be used when diagnosing a misbehaving audio node. Enabling this significantly increases processing overhead.

If enabling this fixes audio glitching issues, then notify the node author of the misbehavior.

By default this is set to false.

proc_store_capacity: usize

The initial number of slots to allocate for the ProcStore.

By default this is set to 8.

Trait Implementations

impl Clone for FirewheelConfig

fn clone(&self) -> FirewheelConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirewheelConfig

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

Formats the value using the given formatter.

impl Default for FirewheelConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FirewheelConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for FirewheelConfig

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for FirewheelConfig

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for FirewheelConfig

fn eq(&self, other: &FirewheelConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for FirewheelConfig

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for FirewheelConfig

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for FirewheelConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for FirewheelConfig

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for FirewheelConfig

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for FirewheelConfig

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for FirewheelConfig

impl StructuralPartialEq for FirewheelConfig