Struct audio_processor_traits::AudioProcessorSettings

pub struct AudioProcessorSettings {
    pub sample_rate: f32,
    pub input_channels: usize,
    pub output_channels: usize,
    pub block_size: usize,
}

Options provided to the audio-processor before calling process.

Fields

sample_rate: f32

The sample rate of the signal

input_channels: usize

The number of input channels to the signal

output_channels: usize

The number of output channels to the signal

block_size: usize

Buffer size of this processing loop

Implementations

impl AudioProcessorSettings

pub fn new(
    sample_rate: f32,
    input_channels: usize,
    output_channels: usize,
    block_size: usize
) -> Self

Create audio processor settings with the given options

pub fn sample_rate(&self) -> f32

The sample rate in samples/second as a floating point number

pub fn input_channels(&self) -> usize

The number of input channels

pub fn output_channels(&self) -> usize

The number of output channels

pub fn block_size(&self) -> usize

The number of samples which will be provided on each process call

impl AudioProcessorSettings

pub fn set_sample_rate(&mut self, sample_rate: f32)

Set the sample rate of this settings object

pub fn set_input_channels(&mut self, input_channels: usize)

Set the number of input channels of this settings object

pub fn set_output_channels(&mut self, output_channels: usize)

Set the number of output channels of this settings object

pub fn set_block_size(&mut self, block_size: usize)

Set the buffer size of this settings object

Trait Implementations

impl Clone for AudioProcessorSettings

fn clone(&self) -> AudioProcessorSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioProcessorSettings

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

Formats the value using the given formatter.

impl Default for AudioProcessorSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<AudioProcessorSettings> for AudioProcessorSettings

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for AudioProcessorSettings

impl StructuralPartialEq for AudioProcessorSettings