Struct web_audio_api::PeriodicWaveOptions

pub struct PeriodicWaveOptions {
    pub real: Option<Vec<f32>>,
    pub imag: Option<Vec<f32>>,
    pub disable_normalization: bool,
}

Options for constructing a PeriodicWave

Fields

real: Option<Vec<f32>>

The real parameter represents an array of cosine terms of Fourrier series.

The first element (index 0) represents the DC-offset. This offset has to be given but will not be taken into account to build the custom periodic waveform.

The following elements (index 1 and more) represent the fundamental and harmonics of the periodic waveform.

imag: Option<Vec<f32>>

The imag parameter represents an array of sine terms of Fourrier series.

The first element (index 0) will not be taken into account to build the custom periodic waveform.

The following elements (index 1 and more) represent the fundamental and harmonics of the periodic waveform.

disable_normalization: bool

By default PeriodicWave is build with normalization enabled (disable_normalization = false). In this case, a peak normalization is applied to the given custom periodic waveform.

If disable_normalization is enabled (disable_normalization = true), the normalization is defined by the periodic waveform characteristics (img, and real fields).

Trait Implementations

impl Clone for PeriodicWaveOptions

fn clone(&self) -> PeriodicWaveOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeriodicWaveOptions

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

Formats the value using the given formatter.

impl Default for PeriodicWaveOptions

fn default() -> PeriodicWaveOptions

Returns the “default value” for a type.