Struct web_audio_api::node::OscillatorNode

pub struct OscillatorNode { /* fields omitted */ }

Audio source generating a periodic waveform

Implementations

impl OscillatorNode

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

Returns an OscillatorNode

Arguments:

• context - The AudioContext
• options - The Oscillatoroptions

pub const fn frequency(&self) -> &AudioParam

Returns the frequency audio parameter The oscillator frequency is calculated as follow: frequency * 2^(detune/1200)

pub const fn detune(&self) -> &AudioParam

Returns the detune audio parameter. detune unity is cents. The oscillator frequency is calculated as follow: frequency * 2^(detune/1200)

pub fn type_(&self) -> OscillatorType

Returns the oscillator type

pub fn set_type(&self, type_: OscillatorType)

set the oscillator type

Arguments

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

Panics

Will panic if:

• type_ is OscillatorType::Custom

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

set the oscillator type to custom and generate a perdioc waveform following the PeriodicWave characteristics

Trait Implementations

impl AudioNode for OscillatorNode

fn number_of_inputs(&self) -> u32

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

fn number_of_outputs(&self) -> u32

OscillatorNode is a mono source node.

fn registration(&self) -> &AudioContextRegistration

fn channel_config_raw(&self) -> &ChannelConfig

fn id(&self) -> &AudioNodeId

fn channel_config_cloned(&self) -> ChannelConfig

fn context(&self) -> &BaseAudioContext

The BaseAudioContext 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_at<'a>(
    &self,
    dest: &'a dyn AudioNode,
    output: u32,
    input: u32
) -> Result<&'a dyn AudioNode, IndexSizeError>

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

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

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

fn disconnect_all(&self)

Disconnects all outgoing connections from the 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)

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)

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)

impl AudioScheduledSourceNode for OscillatorNode

fn scheduler(&self) -> &Scheduler

fn start_at(&self, start: f64)

Schedule playback start at this timestamp

fn stop_at(&self, stop: f64)

Stop playback at this timestamp

fn start(&self)

Play immediately

fn stop(&self)

Stop immediately