Struct ProcessorConfig 

pub struct ProcessorConfig {
    pub sample_rate: u32,
    pub num_channels: u16,
    pub num_frames: usize,
    pub allow_variable_frames: bool,
}

Audio processing configuration passed to Processor::initialize.

Use ProcessorConfig::optimal as a starting point, then adjust fields to match your stream layout.

Fields

sample_rate: u32

Sample rate in Hz (8000 - 192000).

num_channels: u16

Number of audio channels in the stream (1 for mono, 2 for stereo, etc).

num_frames: usize

Samples per channel provided to each processing call. Note that using a non-optimal number of frames increases latency.

allow_variable_frames: bool

Allows frame counts below num_frames at the cost of added latency.

Implementations

impl ProcessorConfig

pub fn optimal(model: &Model<'_>) -> Self

Returns a ProcessorConfig pre-filled with the model’s optimal sample rate and frame size.

num_channels will be set to 1 and allow_variable_frames to false. Adjust the number of channels and enable variable frames by using the builder pattern.

let config = ProcessorConfig::optimal(&model)
    .with_num_channels(2)
    .with_allow_variable_frames(true);

If you need to configure a non-optimal sample rate or number of frames, construct the ProcessorConfig struct directly. For example:

let config = ProcessorConfig {
    num_channels: 2,
    sample_rate: 44100,
    num_frames: model.optimal_num_frames(44100),
    allow_variable_frames: true,
};

pub fn with_num_channels(self, num_channels: u16) -> Self

Sets the number of audio channels for processing.

Arguments

• num_channels - Number of audio channels (1 for mono, 2 for stereo, etc.)

pub fn with_allow_variable_frames(self, allow_variable_frames: bool) -> Self

Enables or disables variable frame size support.

When enabled, allows processing frame counts below num_frames at the cost of added latency.

Arguments

• allow_variable_frames - true to enable variable frame sizes, false for fixed size

Trait Implementations

impl Clone for ProcessorConfig

fn clone(&self) -> ProcessorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessorConfig

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

Formats the value using the given formatter.

impl Hash for ProcessorConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProcessorConfig

fn eq(&self, other: &ProcessorConfig) -> 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 Eq for ProcessorConfig

impl StructuralPartialEq for ProcessorConfig