Struct web_audio_api::node::OscillatorNode

source ·

pub struct OscillatorNode { /* private fields */ }

Expand description

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 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

source

impl OscillatorNode

source

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

Returns an OscillatorNode

Arguments:

context - The AudioContext
options - The OscillatorOptions

source

pub fn frequency(&self) -> &AudioParam

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

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

source

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)

source

pub fn type_(&self) -> OscillatorType

Returns the oscillator type

source

pub fn set_type(&self, type_: OscillatorType)

Set the oscillator type

Arguments

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

Panics

if type_ is OscillatorType::Custom

source

pub fn set_periodic_wave(&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

source

impl AudioNode for OscillatorNode

source

fn number_of_inputs(&self) -> usize

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

source

fn number_of_outputs(&self) -> usize

OscillatorNode is a mono source node.

source

fn registration(&self) -> &AudioContextRegistration

source

fn channel_config(&self) -> &ChannelConfig

source

fn context(&self) -> &ConcreteBaseAudioContext

The BaseAudioContext concrete type which owns this AudioNode. Read more

source

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

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

source

fn connect_at<'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. Read more

source

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

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

source

fn disconnect(&self)

Disconnects all outgoing connections from the AudioNode.

source

fn channel_count_mode(&self) -> ChannelCountMode

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

source

fn set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

source

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. Read more

source