Struct OscillatorNode

pub struct OscillatorNode { /* private fields */ }

OscillatorNode represents an audio source generating a periodic waveform. It can generate a few common waveforms (i.e. sine, square, sawtooth, triangle), or can be set to an arbitrary periodic waveform using a PeriodicWave object.

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

Usage

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

let context = AudioContext::default();

let mut osc = context.create_oscillator();
osc.frequency().set_value(200.);
osc.connect(&context.destination());
osc.start();

Examples

• cargo run --release --example oscillators
• cargo run --release --example many_oscillators_with_env
• cargo run --release --example amplitude_modulation

Implementations

impl OscillatorNode

pub fn new<C: BaseAudioContext>(context: &C, options: OscillatorOptions) -> Self

Returns an OscillatorNode

Arguments:

• context - The AudioContext
• options - The OscillatorOptions

pub fn frequency(&self) -> &AudioParam

A-rate AudioParam that defines the fundamental frequency of the oscillator, expressed in Hz

The final frequency is calculated as follow: frequency * 2^(detune/1200)

pub fn detune(&self) -> &AudioParam

A-rate AudioParam that defines a transposition according to the frequency, expressed in cents.

see https://en.wikipedia.org/wiki/Cent_(music)

The final frequency is calculated as follow: frequency * 2^(detune/1200)

pub fn type_(&self) -> OscillatorType

Returns the oscillator type

pub fn set_type(&mut self, type_: OscillatorType)

Set the oscillator type

Arguments

• type_ - oscillator type (sine, square, triangle, sawtooth)

Panics

if type_ is OscillatorType::Custom

pub fn set_periodic_wave(&mut self, periodic_wave: PeriodicWave)

Sets a PeriodicWave which describes a waveform to be used by the oscillator.

Calling this sets the oscillator type to custom, once set to custom the oscillator cannot be reverted back to a standard waveform.

Trait Implementations

impl AudioNode for OscillatorNode

fn number_of_inputs(&self) -> usize

OscillatorNode is a source node. A source node is by definition with no input

fn number_of_outputs(&self) -> usize

OscillatorNode is a mono source node.

fn registration(&self) -> &AudioContextRegistration

Handle of the associated BaseAudioContext.

fn channel_config(&self) -> &ChannelConfig

Config for up/down-mixing of input channels for this node.

fn context(&self) -> &ConcreteBaseAudioContext

The BaseAudioContext concrete type which owns this AudioNode.

fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode

Connect the output of this AudioNode to the input of another node.

fn connect_from_output_to_input<'a>( &self, dest: &'a dyn AudioNode, output: usize, input: usize, ) -> &'a dyn AudioNode

Connect a specific output of this AudioNode to a specific input of another node.

fn disconnect(&self)

Disconnects all outgoing connections from the AudioNode.

fn disconnect_dest(&self, dest: &dyn AudioNode)

Disconnects all outputs of the AudioNode that go to a specific destination AudioNode.

fn disconnect_output(&self, output: usize)

Disconnects all outgoing connections at the given output port from the AudioNode.

fn disconnect_dest_from_output(&self, dest: &dyn AudioNode, output: usize)

Disconnects a specific output of the AudioNode to a specific destination AudioNode

fn disconnect_dest_from_output_to_input( &self, dest: &dyn AudioNode, output: usize, input: usize, )

Disconnects a specific output of the AudioNode to a specific input of some destination AudioNode

fn channel_count_mode(&self) -> ChannelCountMode

Represents an enumerated value describing the way channels must be matched between the node’s inputs and outputs.

fn set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

fn channel_interpretation(&self) -> ChannelInterpretation

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

fn set_channel_interpretation(&self, v: ChannelInterpretation)

Update the channel_interpretation attribute

fn channel_count(&self) -> usize

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

fn set_channel_count(&self, v: usize)

Update the channel_count attribute

fn set_onprocessorerror( &self, callback: Box<dyn FnOnce(ErrorEvent) + Send + 'static>, )

Register callback to run when an unhandled exception occurs in the audio processor.

fn clear_onprocessorerror(&self)

Unset the callback to run when an unhandled exception occurs in the audio processor.

impl AudioScheduledSourceNode for OscillatorNode

fn start(&mut self)

Play immediately

fn start_at(&mut self, when: f64)

Schedule playback start at given timestamp

fn stop(&mut self)

Stop immediately

fn stop_at(&mut self, when: f64)

Schedule playback stop at given timestamp

fn set_onended<F: FnOnce(Event) + Send + 'static>(&self, callback: F)

Register callback to run when the source node has stopped playing

fn clear_onended(&self)

Unset the callback to run when the source node has stopped playing

impl Debug for OscillatorNode

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

Formats the value using the given formatter.