Struct StftParamsBuilder 

pub struct StftParamsBuilder { /* private fields */ }

Builder for StftParams.

Implementations

impl StftParamsBuilder

pub const fn n_fft(self, n_fft: NonZeroUsize) -> Self

Set the FFT window size.

Arguments

• n_fft - Size of the FFT window

Returns

The builder with the updated FFT window size.

pub const fn hop_size(self, hop_size: NonZeroUsize) -> Self

Set the hop size (samples between successive frames).

Arguments

• hop_size - Number of samples between successive frames

Returns

The builder with the updated hop size.

pub fn window(self, window: WindowType) -> Self

Set the window function.

Arguments

• window - Window function to apply to each frame

Returns

The builder with the updated window function.

pub const fn centre(self, centre: bool) -> Self

Set whether to center frames (pad input signal).

pub fn build(self) -> SpectrogramResult<StftParams>

Build the StftParams.

Errors

Returns an error if:

• n_fft or hop_size are not set or are zero
• hop_size > n_fft

Trait Implementations

impl Clone for StftParamsBuilder

fn clone(&self) -> StftParamsBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StftParamsBuilder

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

Formats the value using the given formatter.

impl Default for StftParamsBuilder

fn default() -> Self

Returns the “default value” for a type.