web.audio.OscillatorNode — clojure-interop/cljs-web-api 1.0.10

The OscillatorNode interface represents a periodic waveform, as a sine wave. It is an web.audio.AudioScheduledSourceNode module that causes a specified frequency of a given wave to be effect, a constant tone.

constructor cljs

(constructor & args)

Constructor.

The OscillatorNode() constructor of the Web Audio API creates a new web.audio.OscillatorNode object which is an web.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 web.audio.AudioNodeOptions dictionary.

\tcontext \tA reference to an web.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.audio.PeriodicWave object.

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

detune cljs

(detune this)

Property.

An a-rate web.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

frequency cljs

(frequency this)

Property.

An a-rate web.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

onended cljs

(onended this)

Property.

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

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

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

set-detune! cljs

(set-detune! this val)

Property.

An a-rate web.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

set-frequency! cljs

(set-frequency! this val)

Property.

An a-rate web.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

set-onended! cljs

(set-onended! this val)

Property.

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

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

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

set-periodic-wave cljs

(set-periodic-wave this wave)

Method.

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

OscillatorNode.setPeriodicWave(wave);

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

set-type! cljs

(set-type! this val)

Property.

A web.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

start cljs

(start this when)

Method.

The following example shows basic usage of an web.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

stop cljs

(stop this when)

Method.

The following example shows basic usage of an web.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

type cljs

(type this)

Property.

A web.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