OscillatorNode.constructor

The OscillatorNode() constructor of the Web Audio API creates a new OscillatorNode object which is an AudioNode that represents a periodic waveform, like a sine wave, optionally setting the node's properties' values to match values in a specified object.

If the default values of the properties are acceptable, you can optionally use the AudioContext.createOscillator() factory method instead.

Syntax

var oscillatorNode = new OscillatorNode(context, options)

Parameters

Inherits parameters from the AudioNodeOptions dictionary.

context

A reference to an AudioContext.

options Optional

An object whose properties specify the initial values for the oscillator node's properties. Any properties omitted from the object will take on the default value as documented.

type

The shape of the wave produced by the node. Valid values are 'sine', 'square', 'sawtooth', 'triangle' and 'custom'. The default is 'sine'.

detune

A detuning value (in cents) which will offset the frequency by the given amount. Its default is 0.

frequency

The frequency (in hertz) of the periodic waveform. Its default is 440.

periodicWave

An arbitrary period waveform described by a PeriodicWave object.

Return value

A new OscillatorNode object instance.

Specifications

Browser compatibilityUpdate compatibility data on GitHub