Struct audio_processor_utility::gain::GainProcessor

source · [−]

pub struct GainProcessor<SampleType> { /* private fields */ }

Expand description

An AudioProcessor which applies gain to an input signal

Implementations

source

impl<SampleType> GainProcessor<SampleType>

source

pub fn new(gain: impl Into<f32>) -> Self

Construct a GainProcessor with gain

source

pub fn new_with_handle(handle: Shared<GainProcessorHandle>) -> Self

Construct a GainProcessor with a certain GainProcessorHandle

source

pub fn set_gain(&self, gain: impl Into<f32>)

Change the gain

source

pub fn gain(&self) -> f32

Get the gain

Trait Implementations

source

impl<SampleType> Default for GainProcessor<SampleType>

source

fn default() -> Self

Construct a GainProcessor with 1.0 gain

source

impl<SampleType> SimpleAudioProcessor for GainProcessor<SampleType>where
SampleType: Float + Send + Sync + Mul<Output = SampleType>,

type SampleType = SampleType

source

fn s_process(&mut self, sample: SampleType) -> SampleType

Process a single sample. If the input is mult-channel, will run for each channel by default. If the processor is multi-channel, implement s_process_frame instead. Read more

source

fn s_prepare(&mut self, _settings: AudioProcessorSettings)

Prepare for playback based on current audio settings

source

fn s_process_frame(&mut self, frame: &mut [Self::SampleType])

Process a multi-channel frame. Read more

Auto Trait Implementations

impl<SampleType> RefUnwindSafe for GainProcessor<SampleType>where
SampleType: RefUnwindSafe,

impl<SampleType> Send for GainProcessor<SampleType>where
SampleType: Send,

impl<SampleType> Sync for GainProcessor<SampleType>where
SampleType: Sync,

impl<SampleType> Unpin for GainProcessor<SampleType>where
SampleType: Unpin,

impl<SampleType> UnwindSafe for GainProcessor<SampleType>where
SampleType: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct audio_processor_utility::gain::GainProcessor

Implementations

impl<SampleType> GainProcessor<SampleType>

pub fn new(gain: impl Into<f32>) -> Self

pub fn new_with_handle(handle: Shared<GainProcessorHandle>) -> Self

pub fn set_gain(&self, gain: impl Into<f32>)

pub fn gain(&self) -> f32

Trait Implementations

impl<SampleType> Default for GainProcessor<SampleType>

fn default() -> Self

impl<SampleType> SimpleAudioProcessor for GainProcessor<SampleType>where
SampleType: Float + Send + Sync + Mul<Output = SampleType>,

type SampleType = SampleType

fn s_process(&mut self, sample: SampleType) -> SampleType

fn s_prepare(&mut self, _settings: AudioProcessorSettings)

fn s_process_frame(&mut self, frame: &mut [Self::SampleType])

Auto Trait Implementations

impl<SampleType> RefUnwindSafe for GainProcessor<SampleType>where
SampleType: RefUnwindSafe,

impl<SampleType> Send for GainProcessor<SampleType>where
SampleType: Send,

impl<SampleType> Sync for GainProcessor<SampleType>where
SampleType: Sync,

impl<SampleType> Unpin for GainProcessor<SampleType>where
SampleType: Unpin,

impl<SampleType> UnwindSafe for GainProcessor<SampleType>where
SampleType: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

Struct audio_processor_utility::gain::GainProcessor

Implementations

impl<SampleType> GainProcessor<SampleType>

pub fn new(gain: impl Into<f32>) -> Self

pub fn new_with_handle(handle: Shared<GainProcessorHandle>) -> Self

pub fn set_gain(&self, gain: impl Into<f32>)

pub fn gain(&self) -> f32

Trait Implementations

impl<SampleType> Default for GainProcessor<SampleType>

fn default() -> Self

impl<SampleType> SimpleAudioProcessor for GainProcessor<SampleType>where SampleType: Float + Send + Sync + Mul<Output = SampleType>,

type SampleType = SampleType

fn s_process(&mut self, sample: SampleType) -> SampleType

fn s_prepare(&mut self, _settings: AudioProcessorSettings)

fn s_process_frame(&mut self, frame: &mut [Self::SampleType])

Auto Trait Implementations

impl<SampleType> RefUnwindSafe for GainProcessor<SampleType>where SampleType: RefUnwindSafe,

impl<SampleType> Send for GainProcessor<SampleType>where SampleType: Send,

impl<SampleType> Sync for GainProcessor<SampleType>where SampleType: Sync,

impl<SampleType> Unpin for GainProcessor<SampleType>where SampleType: Unpin,

impl<SampleType> UnwindSafe for GainProcessor<SampleType>where SampleType: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<SampleType> SimpleAudioProcessor for GainProcessor<SampleType>where
SampleType: Float + Send + Sync + Mul<Output = SampleType>,

impl<SampleType> RefUnwindSafe for GainProcessor<SampleType>where
SampleType: RefUnwindSafe,

impl<SampleType> Send for GainProcessor<SampleType>where
SampleType: Send,

impl<SampleType> Sync for GainProcessor<SampleType>where
SampleType: Sync,

impl<SampleType> Unpin for GainProcessor<SampleType>where
SampleType: Unpin,

impl<SampleType> UnwindSafe for GainProcessor<SampleType>where
SampleType: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,