Struct web_audio_api::PeriodicWave

pub struct PeriodicWave { /* private fields */ }

PeriodicWave represents an arbitrary periodic waveform to be used with an OscillatorNode.

• MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/PeriodicWave
• specification: https://webaudio.github.io/web-audio-api/#PeriodicWave
• see also: BaseAudioContext::create_periodic_wave
• see also: OscillatorNode

Usage

use web_audio_api::context::{BaseAudioContext, AudioContext};
use web_audio_api::{PeriodicWave, PeriodicWaveOptions};
use web_audio_api::node::{AudioNode, AudioScheduledSourceNode};

let context = AudioContext::default();

// generate a simple waveform with 2 harmonics
let options = PeriodicWaveOptions {
  real: Some(vec![0., 0., 0.]),
  imag: Some(vec![0., 0.5, 0.5]),
  disable_normalization: false,
};

let periodic_wave = PeriodicWave::new(&context, options);

let osc = context.create_oscillator();
osc.set_periodic_wave(periodic_wave);
osc.connect(&context.destination());
osc.start();

Examples

• cargo run --release --example oscillators

Implementations

impl PeriodicWave

pub fn new<C: BaseAudioContext>(
    _context: &C,
    options: PeriodicWaveOptions
) -> Self

Returns a PeriodicWave

Arguments

• real - The real parameter represents an array of cosine terms of Fourrier series.
• imag - The imag parameter represents an array of sine terms of Fourrier series.
• constraints - The constraints parameter specifies the normalization mode of the PeriodicWave

Panics

Will panic if:

• real is defined and its length is less than 2
• imag is defined and its length is less than 2
• real and imag are defined and theirs lengths are not equal
• PeriodicWave is more than 8192 components

Trait Implementations

impl Clone for PeriodicWave

fn clone(&self) -> PeriodicWave

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeriodicWave

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

Formats the value using the given formatter.