Skip to main content

SampleRate

Struct SampleRate 

Source
pub struct SampleRate(pub f64);
Expand description

Sample rate in Hz.

Use for most plugins with time-dependent DSP: delays, filters, envelopes, parameter smoothing, etc. This is the most common choice.

§Example

impl Descriptor for DelayPlugin {
    type Setup = SampleRate;
    fn prepare(self, sample_rate: SampleRate) -> DelayProcessor {
        let buffer_size = (MAX_DELAY_SECONDS * sample_rate.0) as usize;
        DelayProcessor {
            sample_rate: sample_rate.0,
            buffer: vec![0.0; buffer_size],
        }
    }
}

Tuple Fields§

§0: f64

Implementations§

Source§

impl SampleRate

Source

pub fn hz(&self) -> f64

Get the sample rate in Hz.

Trait Implementations§

Source§

impl Clone for SampleRate

Source§

fn clone(&self) -> SampleRate

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SampleRate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SampleRate

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PluginSetup for SampleRate

Source§

fn extract(host: &HostSetup) -> Self

Extract this setup from the host-provided information.
Source§

impl Copy for SampleRate

Source§

impl StructuralPartialEq for SampleRate

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.