Liking cljdoc? Tell your friends :D

web.OscillatorNode

The OscillatorNode interface represents a periodic waveform, as a sine wave. It is an audio.AudioScheduledSourceNode audio-processing that causes a specified frequency of a given wave to be created—in a constant tone.

The OscillatorNode interface represents a periodic waveform,
as a sine wave. It is an `audio.AudioScheduledSourceNode` audio-processing
that causes a specified frequency of a given wave to be created—in
a constant tone.
raw docstring

constructorcljs

Constructor.

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

Inherits parameters from the audio.AudioNodeOptions dictionary.

\tcontext \tA reference to an audio.AudioContext. \toptions Optional \tAn 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.

\t\ttype \t\tThe shape of the wave produced by the node. Valid values are 'sine', 'square', 'sawtooth', 'triangle' and 'custom'. The default is 'sine'. \t\tdetune \t\tA detuning value (in cents) which will offset the frequency by the given amount. Its default is 0. \t\tfrequency \t\tThe frequency (in hertz) of the periodic waveform. Its default is 440. \t\tperiodicWave \t\tAn arbitrary period waveform described by a web.PeriodicWave object.

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/OscillatorNode

Constructor.

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

Inherits parameters from the `audio.AudioNodeOptions` dictionary.


\tcontext
\tA reference to an `audio.AudioContext`.
\toptions Optional
\tAn 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.

\t\ttype
\t\tThe shape of the wave produced by the node. Valid values are 'sine', 'square', 'sawtooth', 'triangle' and 'custom'. The default is 'sine'.
\t\tdetune
\t\tA detuning value (in cents) which will offset the frequency by the given amount. Its default is 0.
\t\tfrequency
\t\tThe frequency (in hertz) of the periodic waveform. Its default is 440.
\t\tperiodicWave
\t\tAn arbitrary period waveform described by a `web.PeriodicWave` object.

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/OscillatorNode`
sourceraw docstring

detunecljs

(detune this)

Property.

An a-rate audio.AudioParam.

`var oscillator = audioCtx.createOscillator(); oscillator.detune.setValueAtTime(100, audioCtx.currentTime); // value in cents

Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/detune

Property.

An a-rate `audio.AudioParam`.

`var oscillator = audioCtx.createOscillator();
oscillator.detune.setValueAtTime(100, audioCtx.currentTime); // value in cents


Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/detune`
sourceraw docstring

frequencycljs

(frequency this)

Property.

An a-rate audio.AudioParam.

`var oscillator = audioCtx.createOscillator(); oscillator.frequency.setValueAtTime(440, audioCtx.currentTime); // value in hertz

Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/frequency

Property.

An a-rate `audio.AudioParam`.

`var oscillator = audioCtx.createOscillator();
oscillator.frequency.setValueAtTime(440, audioCtx.currentTime); // value in hertz


Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/frequency`
sourceraw docstring

onendedcljs

(onended this)

Property.

The onended property of the web.OscillatorNode interface is to set the event handler for the ended event, which fires when tone has stopped playing.

var oscillator = audioCtx.createOscillator(); oscillator.onended = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/onended

Property.

The onended property of the `web.OscillatorNode` interface is
to set the event handler for the ended event, which fires when
tone has stopped playing.

`var oscillator = audioCtx.createOscillator();
oscillator.onended = function() { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/onended`
sourceraw docstring

set-detune!cljs

(set-detune! this val)

Property.

An a-rate audio.AudioParam.

`var oscillator = audioCtx.createOscillator(); oscillator.detune.setValueAtTime(100, audioCtx.currentTime); // value in cents

Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/detune

Property.

An a-rate `audio.AudioParam`.

`var oscillator = audioCtx.createOscillator();
oscillator.detune.setValueAtTime(100, audioCtx.currentTime); // value in cents


Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/detune`
sourceraw docstring

set-frequency!cljs

(set-frequency! this val)

Property.

An a-rate audio.AudioParam.

`var oscillator = audioCtx.createOscillator(); oscillator.frequency.setValueAtTime(440, audioCtx.currentTime); // value in hertz

Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/frequency

Property.

An a-rate `audio.AudioParam`.

`var oscillator = audioCtx.createOscillator();
oscillator.frequency.setValueAtTime(440, audioCtx.currentTime); // value in hertz


Note: though the AudioParam returned is read-only, the value it represents is not.`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/frequency`
sourceraw docstring

set-onended!cljs

(set-onended! this val)

Property.

The onended property of the web.OscillatorNode interface is to set the event handler for the ended event, which fires when tone has stopped playing.

var oscillator = audioCtx.createOscillator(); oscillator.onended = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/onended

Property.

The onended property of the `web.OscillatorNode` interface is
to set the event handler for the ended event, which fires when
tone has stopped playing.

`var oscillator = audioCtx.createOscillator();
oscillator.onended = function() { ... };`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/onended`
sourceraw docstring

set-periodic-wavecljs

(set-periodic-wave this wave)

Method.

The setPeriodicWave() method of the web.OscillatorNode interface used to point to a web.PeriodicWave defining a periodic waveform can be used to shape the oscillator's output, when web.type custom.

OscillatorNode.setPeriodicWave(wave);

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/setPeriodicWave

Method.

The setPeriodicWave() method of the `web.OscillatorNode` interface
used to point to a `web.PeriodicWave` defining a periodic waveform
can be used to shape the oscillator's output, when `web.type`
custom.

`OscillatorNode.setPeriodicWave(wave);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/setPeriodicWave`
sourceraw docstring

set-type!cljs

(set-type! this val)

Property.

A dom.DOMString specifying the shape of oscillator wave. The available values are:

OscillatorNode.type = type;

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/type

Property.

A `dom.DOMString` specifying the shape of oscillator wave. The
available values are:

`OscillatorNode.type = type;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/type`
sourceraw docstring

startcljs

(start this when)

Method.

The following example shows basic usage of an audio.AudioContext create an oscillator node. For an applied example, check out Violent Theremin demo (see app.js for relevant code).

oscillator.start(when); // start playing oscillator at the point in time specified by when

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/start

Method.

The following example shows basic usage of an `audio.AudioContext`
create an oscillator node. For an applied example, check out
Violent Theremin demo (see app.js for relevant code).

`oscillator.start(when); // start playing oscillator at the point in time specified by when`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/start`
sourceraw docstring

stopcljs

(stop this when)

Method.

The following example shows basic usage of an audio.AudioContext create an oscillator node. For an applied example, check out Violent Theremin demo (see app.js for relevant code).

oscillator.stop(when); // stop playing oscillator at when

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/stop

Method.

The following example shows basic usage of an `audio.AudioContext`
create an oscillator node. For an applied example, check out
Violent Theremin demo (see app.js for relevant code).

`oscillator.stop(when); // stop playing oscillator at when`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/stop`
sourceraw docstring

typecljs

(type this)

Property.

A dom.DOMString specifying the shape of oscillator wave. The available values are:

OscillatorNode.type = type;

See also: https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/type

Property.

A `dom.DOMString` specifying the shape of oscillator wave. The
available values are:

`OscillatorNode.type = type;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/OscillatorNode/type`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close